Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revision Previous revision
Next revision
Previous revision
en:entwickler:sourcecode-dokumentation [2015/11/30 10:07]
ximex [Documenting Parameters]
en:entwickler:sourcecode-dokumentation [2016/12/03 14:53]
ximex
Line 1: Line 1:
 ====== 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  ====
Line 9: Line 9:
  
 ==== Format Comments for Doxygen ==== ==== Format Comments for Doxygen ====
-Comments must be specially marked so that they are recognized and processed by Doxygen as relevant. This is useful, but really only in class, method and function descriptions. This requires the comment normally is to be supplemented front of the class, method or function with special characters. <code php> // Description for subsequent function, as it was previously available in the source code. +Comments must be specially marked so that they are recognized and processed by Doxygen as relevant. This is useful, but really only in class, method and function descriptions. This requires the comment normally is to be supplemented front of the class, method or function with special characters. 
-function foo($param)</​code>​ From this line of code should be the following syntax: <code php> /// Description for subsequent function, as it is optimized for Doxygen +<code php> 
-function foo($param)</​code>​ Once there, however, more than one line, following Doxygen comment optimized code should be used: <code php> / ** Description for subsequent function, as it is optimized for Doxygen +// Description for subsequent function, as it was previously available in the source code. 
-* And more than one line +function foo($param) 
-* / +</​code>​ 
-function foo($param)</​code>​In a one-line comment a 3. Slash is appended, multiline comment at the beginning a 2nd asterisk.Now the comment will be considered in Doxygen.+From this line of code should be the following syntax: 
 +<code php> 
 +/// Description for subsequent function, as it is optimized for Doxygen 
 +function foo($param) 
 +</​code>​ 
 +Once there, however, more than one line, following Doxygen comment optimized code should be used: 
 +<code php> 
 +/*
 + * Description for subsequent function, as it is optimized for Doxygen 
 + * And more than one line 
 + */ 
 +function foo($param) 
 +</​code>​ 
 +In a one-line comment a 3. Slash is appended, multiline comment at the beginning a 2nd asterisk.Now the comment will be considered in Doxygen.
  
 ==== Documenting Parameters ==== ==== Documenting Parameters ====
Line 43: Line 56:
  
 ==== 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>
 / ** / **
Line 85: Line 98:
 } }
 </​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 ;)
  • en/entwickler/sourcecode-dokumentation.txt
  • Last modified: 2016/12/03 14:53
  • by ximex