This shows you the differences between two versions of the page.
| Both sides previous revision Previous revision | |
| en:entwickler:sourcecode-dokumentation [2015/11/30 10:08] – [Format Comments for Doxygen] ximex | en:entwickler:sourcecode-dokumentation [2016/12/03 14:53] (current) – ximex |
|---|
| ====== Sourcecode-Documentation ====== | ====== Sourcecode-Documentation ====== |
| ==== Doxygen ==== | ==== Doxygen ==== |
| The documentation of our classes and functions should be done with[[http://www.doxygen.org | Doxygen]]. This program creates a[[http://www.admidio.org/dokusource|structured HTML documentation]] within the comment section of the source code using keywords. The documenation can also be downloaded offline access also [[https://sourceforge.net/projects/admidio/files/Dokusource/|downloaded]] for offline work. The advantage of the documentation with Doxygen is a good clear documentation in the source code itself, plus a well-formatted HTML representation without requiring a large amount of additional work. This page will now describe the most important keywords and formatting of Doxygen, which we need for Admidio. On the Doxygen page itself you will also find a guide to [[http://www.stack.nl/~dimitri/doxygen/docblocks.html|Adjust documentation]] and a [[http://www.stack.nl/~dimitri/doxygen/commands.html | Overview of all keywords]]. | The documentation of our classes and functions should be done with[[http://www.doxygen.org|Doxygen]]. This program creates a [[https://www.admidio.org/dokusource|structured HTML documentation]] within the comment section of the source code using keywords. The documentation can also be downloaded offline access also [[https://sourceforge.net/projects/admidio/files/Dokusource/|downloaded]] for offline work. The advantage of the documentation with Doxygen is a good clear documentation in the source code itself, plus a well-formatted HTML representation without requiring a large amount of additional work. This page will now describe the most important keywords and formatting of Doxygen, which we need for Admidio. On the Doxygen page itself you will also find a guide to [[http://www.stack.nl/~dimitri/doxygen/docblocks.html|Adjust documentation]] and a [[http://www.stack.nl/~dimitri/doxygen/commands.html | Overview of all keywords]]. |
| |
| ==== Generate HTML view ==== | ==== Generate HTML view ==== |
| |
| ==== Documenting Example Code ==== | ==== Documenting Example Code ==== |
| With Doxygen also sample code can be specifically shown, so that it is highlighted in the document and shows the syntax of the programming in color. This should first be defined with a kind of headline **@par** and then with **@ code** and **@encode ** the actual sample code embeded. | With Doxygen also sample code can be specifically shown, so that it is highlighted in the document and shows the syntax of the programming in color. This should first be defined with a kind of headline **@par** and then with **@ code** and **@encode ** the actual sample code embedded. |
| <code php> | <code php> |
| / ** | / ** |
| } | } |
| </code> | </code> |
| Doxygen creates then [[http://admidio.org/dokusource/d1/da0/function_8php.html#ac37c2a5fcd7dc5b31885f0de8a589891|this nice formatted HTML page]]. Now there are detailed documentation even in the code, and additionally as a HTML view with search. More can not be expected as a developer ;) | Doxygen creates then [[https://www.admidio.org/dokusource/|this nice formatted HTML page]]. Now there are detailed documentation even in the code, and additionally as a HTML view with search. More can not be expected as a developer ;) |
