CHDK Wiki
No edit summary
Tag: Visual edit
 
(2 intermediate revisions by one other user not shown)
Line 1: Line 1:
 
{{notice|Information posted on this page is circa 2009 and has not been updated.}}
[[Category:Development|Documentate the CHDK Sources]]
 
{|align=right
 
|__TOC__
 
|}
 
 
 
== Where can I get it? ==
 
== Where can I get it? ==
  +
{{notice|Information posted on this page is circa 2009 and has not been updated.]'''.
 
   
 
It will be generated every night at 0300 UTC from the SVN sources.
 
It will be generated every night at 0300 UTC from the SVN sources.
Line 13: Line 9:
 
[http://www.stack.nl/~dimitri/doxygen/docblocks.html Here] is the offical Doxygen-Guide, which also host a list of all of the available [http://www.stack.nl/~dimitri/doxygen/commands.html Doxygen tags].
 
[http://www.stack.nl/~dimitri/doxygen/docblocks.html Here] is the offical Doxygen-Guide, which also host a list of all of the available [http://www.stack.nl/~dimitri/doxygen/commands.html Doxygen tags].
   
A very handy piece of documentation can be found at the bottom of [http://www.codecogs.com/pages/standards/documentation.htm this site]. This should be enough for the pratical use of Doxygen.
+
A very handy piece of documentation can be found at the bottom of [http://www.codecogs.com/pages/standards/documentation.php this site]. This should be enough for the pratical use of Doxygen.
   
 
== What Software do you use to generate this stuff? ==
 
== What Software do you use to generate this stuff? ==
   
 
It's a horrible selfwritten script which calls up [http://www.doxygen.org doxygen]. It will not be published because it's all hardcoded stuff (it's a tiny piece of shellscript).
 
It's a horrible selfwritten script which calls up [http://www.doxygen.org doxygen]. It will not be published because it's all hardcoded stuff (it's a tiny piece of shellscript).
 
[[Category:Development|Documentate the CHDK Sources]]

Latest revision as of 18:04, 31 May 2014

Notice

Information posted on this page is circa 2009 and has not been updated.

Where can I get it?

It will be generated every night at 0300 UTC from the SVN sources.

How do I add documentation to my piece of code?

Here is the offical Doxygen-Guide, which also host a list of all of the available Doxygen tags.

A very handy piece of documentation can be found at the bottom of this site. This should be enough for the pratical use of Doxygen.

What Software do you use to generate this stuff?

It's a horrible selfwritten script which calls up doxygen. It will not be published because it's all hardcoded stuff (it's a tiny piece of shellscript).