summaryrefslogtreecommitdiff
path: root/include/asterisk/doxyref.h
AgeCommit message (Collapse)Author
2017-12-22Remove as much trailing whitespace as possible.Sean Bright
Change-Id: I873c1c6d00f447269bd841494459efccdd2c19c0
2017-11-21Merge "README: Send people to secure websites where available."Joshua Colp
2017-11-17README: Send people to secure websites where available.Corey Farrell
We should be sending people to secure web URL's where available. Update README's and docs. Change-Id: Id5b1e049b0b18b49a784f1254605aefa244ce19a
2017-11-17doxygen: Remove obsolete contents.Corey Farrell
Remove doxygen contents that have nothing to do with the current state of Asterisk. Change-Id: Ic072cc8641f9533a202990ccf275ce87e3efd95c
2013-12-11app_voicemail: Voicemail callback registration/unregistration function ↵Richard Mudgett
improvements. * The voicemail registration/unregistration functions now take a struct of callbacks instead of a lengthy parameter list of callbacks. * The voicemail registration/unregistration functions now prevent a competing module from interfering with an already registered callback supplying module. git-svn-id: https://origsvn.digium.com/svn/asterisk/trunk@403643 65c4cc65-6c06-0410-ace0-fbb531ad65f3
2012-10-18Doxygen Updates - Title updateAndrew Latham
Update and extend the configuration_file group and enable linking. Commit other cleanups from multi-version Doxygen testing. Update title that was left behind many years ago. (issue ASTERISK-20259) git-svn-id: https://origsvn.digium.com/svn/asterisk/trunk@375182 65c4cc65-6c06-0410-ace0-fbb531ad65f3
2012-10-01Doxygen CleanupAndrew Latham
Start adding configuration file linking and pages. Add module loading doxygen block. Breaking up commits to keep it easy to track (issue ASTERISK-20259) git-svn-id: https://origsvn.digium.com/svn/asterisk/trunk@374167 65c4cc65-6c06-0410-ace0-fbb531ad65f3
2012-09-22Doxygen Updates Janitor WorkAndrew Latham
* Whitespace, doc-blocks, spelling, case, missing and incorrect tags. * Add cleanup to Makefile for the Doxygen configuration update * Start updating Doxygen configuration for cleaner output * Enable inclusion of configuration files into documentation * remove mantisworkflow... * update documentation README * Add markup to Tilghman's email and talk with him about updating his email, he knows... * no code changes on this commit other than the mentioned Makefile change (issue ASTERISK-20259) git-svn-id: https://origsvn.digium.com/svn/asterisk/trunk@373384 65c4cc65-6c06-0410-ace0-fbb531ad65f3
2012-09-21Doxygen Updates - janitor workAndrew Latham
Doxygen updates including mistakes, misspellings, missing parameters, updates for Doxygen style. Some missing txt file links are removed but their content or essense will be included in some later updates. A majority of the txt files were removed in the 1.6 era but never noted. The HR and EXTREF are simple changes that make the documentation more compatable with more versions of Doxygen. Further updates coming. (issue ASTERISK-20259) git-svn-id: https://origsvn.digium.com/svn/asterisk/trunk@373330 65c4cc65-6c06-0410-ace0-fbb531ad65f3
2010-07-22Add the full current set of CDR driversTilghman Lesher
git-svn-id: https://origsvn.digium.com/svn/asterisk/trunk@278579 65c4cc65-6c06-0410-ace0-fbb531ad65f3
2010-06-08Fix some doxygen warnings.Leif Madsen
(closes issue #17336) Reported by: snuffy Patches: doxygen-fixes1.diff uploaded by snuffy (license 35) Tested by: russell git-svn-id: https://origsvn.digium.com/svn/asterisk/trunk@268969 65c4cc65-6c06-0410-ace0-fbb531ad65f3
2010-04-22Asterisk data retrieval API.Eliel C. Sardanons
This module implements an abstraction for retrieving and exporting asterisk data. Developed by: Brett Bryant <brettbryant@gmail.com> Eliel C. Sardanons (LU1ALY) <eliels@gmail.com> For the Google Summer of code 2009 Project. Documentation can be found in doxygen format and inside the header include/asterisk/data.h Review: https://reviewboard.asterisk.org/r/275/ git-svn-id: https://origsvn.digium.com/svn/asterisk/trunk@258517 65c4cc65-6c06-0410-ace0-fbb531ad65f3
2009-12-21Change all refererences to 1.6.3 to be 1.8, since that will be the next ↵Kevin P. Fleming
feature release git-svn-id: https://origsvn.digium.com/svn/asterisk/trunk@235904 65c4cc65-6c06-0410-ace0-fbb531ad65f3
2009-10-30Add an "Asterisk Architecture Overview" section to the doxygen documentation.Russell Bryant
This is a side project I've been poking at this week. The intent is to discuss Asterisk architecture in a top down fashion to help new developers understand how Asterisk is put together. There is a ton of stuff to write about, so this will just continue to evolve over time. git-svn-id: https://origsvn.digium.com/svn/asterisk/trunk@226606 65c4cc65-6c06-0410-ace0-fbb531ad65f3
2009-10-22Add Asterisk Git HowTo documentation.Leif Madsen
Added documentation on how to create a local git repository from SVN. This documentation was added via doxygen. (closes issue #15814) Reported by: tzafrir Patches: git-asterisk-howto uploaded by tzafrir (license 46) git-svn-id: https://origsvn.digium.com/svn/asterisk/trunk@225483 65c4cc65-6c06-0410-ace0-fbb531ad65f3
2009-09-23Add Mantis work flow documention.Leif Madsen
This commit adds the doxygen changes that I've made to describe the Mantis work flow documentation for the open source issue tracker. This should make it easier to determine the flow of issues through the issue tracker, and what those statuses mean. (closes issue #15902) Reported by: lmadsen Patches: mantisworkflow.h uploaded by lmadsen (license 10) Review: https://reviewboard.asterisk.org/r/367/ git-svn-id: https://origsvn.digium.com/svn/asterisk/trunk@219895 65c4cc65-6c06-0410-ace0-fbb531ad65f3
2009-06-26Note a new API call, and one that changed in doxygen.Russell Bryant
git-svn-id: https://origsvn.digium.com/svn/asterisk/trunk@203640 65c4cc65-6c06-0410-ace0-fbb531ad65f3
2009-05-28Update references to bugs.digium.com and reviewboard.digium.com to the new URLs.Sean Bright
git-svn-id: https://origsvn.digium.com/svn/asterisk/trunk@197824 65c4cc65-6c06-0410-ace0-fbb531ad65f3
2009-04-08Add documentation for reviewboard usage and guidelines.Russell Bryant
git-svn-id: https://origsvn.digium.com/svn/asterisk/trunk@187179 65c4cc65-6c06-0410-ace0-fbb531ad65f3
2009-04-08Start splitting up miscellaneous doxygen documentation into separate files.Russell Bryant
doxyref.h was created to hold miscellaneous documentation that was not specific to a part of the code. This file has grown quite a bit so I decided to start splitting parts of it out into new files. Now, you can drop a new file into include/asterisk/doxygen/ and it will be processed by doxygen. git-svn-id: https://origsvn.digium.com/svn/asterisk/trunk@186953 65c4cc65-6c06-0410-ace0-fbb531ad65f3
2009-03-27Update commit message guidelines in re: to punctuation.Leif Madsen
The doxygen documentation has now been updated to state explicitly that I want punctuation atthe end of the first sentence in a commit message. :). git-svn-id: https://origsvn.digium.com/svn/asterisk/trunk@184798 65c4cc65-6c06-0410-ace0-fbb531ad65f3
2009-03-09Add Doxygen documentation for API changes from 1.6.0 to 1.6.1Jeff Peeler
Copied from my review board description: This is a continuation of the API changes documentation started for describing changes between releases. Most of the API changes were pretty simple needing only to be brought to attention via the new "Asterisk API Changes" list. However, if you see anything that needs further explanation feel free to supplement what is there. The current method of documenting is to add (in the header file): \version <ver number> <description of changes> and then to add the function to the change list in doxyref.h on the AstAPIChanges page. I also made sure all the functions that were newly added were tagged with \since 1.6.1. I think this is a good habit to start both for the historical aspect as well as for the future ability to easily add a "New Asterisk API" page. Review: http://reviewboard.digium.com/r/190/ git-svn-id: https://origsvn.digium.com/svn/asterisk/trunk@180719 65c4cc65-6c06-0410-ace0-fbb531ad65f3
2008-12-20Make a note about formatting the review URL in commit messagesRussell Bryant
git-svn-id: https://origsvn.digium.com/svn/asterisk/trunk@166219 65c4cc65-6c06-0410-ace0-fbb531ad65f3
2008-12-19Disable some automatic links generated by doxygen.Russell Bryant
git-svn-id: https://origsvn.digium.com/svn/asterisk/trunk@165886 65c4cc65-6c06-0410-ace0-fbb531ad65f3
2008-12-19Introduce commit message formatting guidelines.Russell Bryant
This documents the recommended outline to use for commit message. It also covers information on special tags that can be used in commit messages, as well as the template functionality that is available on bugs.digium.com. Review: http://reviewboard.digium.com/r/96/ git-svn-id: https://origsvn.digium.com/svn/asterisk/trunk@165883 65c4cc65-6c06-0410-ace0-fbb531ad65f3
2008-12-09Add some additional Asterisk project developer documentation. Russell Bryant
After the nightly update of the documentation on asterisk.org, I'll post an update to asterisk-dev with a pointer to the changes. This covers some release branch and commit policy information. None of this should be a surprise, since it's just documenting what we have already been doing. git-svn-id: https://origsvn.digium.com/svn/asterisk/trunk@162418 65c4cc65-6c06-0410-ace0-fbb531ad65f3
2008-08-07Merged revisions 136541 via svnmerge from Kevin P. Fleming
https://origsvn.digium.com/svn/asterisk/trunk ........ ........ git-svn-id: https://origsvn.digium.com/svn/asterisk/trunk@136542 65c4cc65-6c06-0410-ace0-fbb531ad65f3
2008-07-25Modify the main page of the doxygen documentation to link to a new page ↵Russell Bryant
dedicated to Asterisk licensing information. The licensing page includes the Asterisk license, as well as a (not yet complete) list of 3rd party libraries that may be used, as well as what license we receive them under. Help filling out this list in the format that I have started in doxyref.h would be much appreciated. :) git-svn-id: https://origsvn.digium.com/svn/asterisk/trunk@133575 65c4cc65-6c06-0410-ace0-fbb531ad65f3
2008-06-20Change references to doc/channelvariables.txt toMark Michelson
doc/tex/channelvariables.tex. This issue came up on the asterisk-dev mailing list. git-svn-id: https://origsvn.digium.com/svn/asterisk/trunk@124278 65c4cc65-6c06-0410-ace0-fbb531ad65f3
2008-06-12Goodbye Zaptel, hello DAHDI. Removes Zaptel driver support with DAHDI. ↵Jeff Peeler
Configuration file and dialplan backwards compatability has been put in place where appropiate. Release announcement to follow. git-svn-id: https://origsvn.digium.com/svn/asterisk/trunk@122234 65c4cc65-6c06-0410-ace0-fbb531ad65f3
2007-12-11Doxygen updates, formatting. Olle Johansson
misdn stuff needs a lot of doxygenification (Hello, Qwell :-) ) git-svn-id: https://origsvn.digium.com/svn/asterisk/trunk@92423 65c4cc65-6c06-0410-ace0-fbb531ad65f3
2007-12-11A lot of doxygen updatesOlle Johansson
git-svn-id: https://origsvn.digium.com/svn/asterisk/trunk@92285 65c4cc65-6c06-0410-ace0-fbb531ad65f3
2007-11-26Start using Doxygen groupings to group variables and defines.Olle Johansson
git-svn-id: https://origsvn.digium.com/svn/asterisk/trunk@89607 65c4cc65-6c06-0410-ace0-fbb531ad65f3
2007-09-13Various code and documentation cleanups for res_config_sqliteRussell Bryant
(closes issue #10711, rbraun_proformatique) git-svn-id: https://origsvn.digium.com/svn/asterisk/trunk@82321 65c4cc65-6c06-0410-ace0-fbb531ad65f3
2007-07-23(closes issue #10271)Russell Bryant
Reported by: snuffy Patches: doxygen-updates.diff uploaded by snuffy (license 35) Another big batch of doxygen documentation updates git-svn-id: https://origsvn.digium.com/svn/asterisk/trunk@76559 65c4cc65-6c06-0410-ace0-fbb531ad65f3
2007-07-16Merge a bunch of doxygen updates to header files. This includes changes toRussell Bryant
use the \retval tag for documenting return values, fixing various warnings when generating the documentation, and various other things. (closes issue #10203, snuffy) git-svn-id: https://origsvn.digium.com/svn/asterisk/trunk@75164 65c4cc65-6c06-0410-ace0-fbb531ad65f3
2007-06-07Fix a bunch of doxygen errors and document more thingsRussell Bryant
(issue #9842, snuffy) git-svn-id: https://origsvn.digium.com/svn/asterisk/trunk@68339 65c4cc65-6c06-0410-ace0-fbb531ad65f3
2007-02-24Doxygen additions, correctionsOlle Johansson
git-svn-id: https://origsvn.digium.com/svn/asterisk/trunk@56665 65c4cc65-6c06-0410-ace0-fbb531ad65f3
2007-02-24Doxygen updates and correctionsOlle Johansson
git-svn-id: https://origsvn.digium.com/svn/asterisk/trunk@56648 65c4cc65-6c06-0410-ace0-fbb531ad65f3
2007-02-24Doxygen updates for AJI - The Asterisk Jabber APIOlle Johansson
git-svn-id: https://origsvn.digium.com/svn/asterisk/trunk@56623 65c4cc65-6c06-0410-ace0-fbb531ad65f3
2006-11-30Adding some generic docs on extension and device states - watchers and providersOlle Johansson
git-svn-id: https://origsvn.digium.com/svn/asterisk/trunk@48139 65c4cc65-6c06-0410-ace0-fbb531ad65f3
2006-11-27Doxygen updatesOlle Johansson
git-svn-id: https://origsvn.digium.com/svn/asterisk/trunk@48033 65c4cc65-6c06-0410-ace0-fbb531ad65f3
2006-11-24Doxygen updateOlle Johansson
- Document cause codes - Document a bit more on channel variables - global, predefined and local - Fix some doxygen in channel.h. Adding one comment for two definitions does not work. They won't be copied to each. git-svn-id: https://origsvn.digium.com/svn/asterisk/trunk@47986 65c4cc65-6c06-0410-ace0-fbb531ad65f3
2006-10-30Issue 8246 Doxygen updates (kshumard) Olle Johansson
THANK YOU! git-svn-id: https://origsvn.digium.com/svn/asterisk/trunk@46434 65c4cc65-6c06-0410-ace0-fbb531ad65f3
2006-06-08Doxygen updatesOlle Johansson
git-svn-id: https://origsvn.digium.com/svn/asterisk/trunk@33066 65c4cc65-6c06-0410-ace0-fbb531ad65f3
2006-06-08Add video.txt to doxygenOlle Johansson
git-svn-id: https://origsvn.digium.com/svn/asterisk/trunk@32991 65c4cc65-6c06-0410-ace0-fbb531ad65f3
2006-06-08Doxygen updateOlle Johansson
git-svn-id: https://origsvn.digium.com/svn/asterisk/trunk@32990 65c4cc65-6c06-0410-ace0-fbb531ad65f3
2006-04-11Add new documentation files to index file 00README.1st and to doxygenOlle Johansson
git-svn-id: https://origsvn.digium.com/svn/asterisk/trunk@19097 65c4cc65-6c06-0410-ace0-fbb531ad65f3
2006-04-03Add misdn.txt to doxygen docsOlle Johansson
git-svn-id: https://origsvn.digium.com/svn/asterisk/trunk@17106 65c4cc65-6c06-0410-ace0-fbb531ad65f3
2006-04-03- Doxygen additionsOlle Johansson
- Formatting fixes (read guidelines :-) ) - Removing compilation warnings git-svn-id: https://origsvn.digium.com/svn/asterisk/trunk@17105 65c4cc65-6c06-0410-ace0-fbb531ad65f3