Changes between Version 11 and Version 12 of HeaderDoc

Timestamp:

Nov 26, 2009, 1:26:30 PM (15 years ago)

Author:

becoulet

Comment:

--

HeaderDoc

@@ -1 +1 @@
 
-This document explains how to write correct documentation in header source files for the [http://www.mutek.fr/www/mutekh_api/ MutekH API reference manual].
+This document explains how to write correct documentation in header source files for the [http://www.mutekh.org/www/mutekh_api/ MutekH API reference manual].
 
 The manual is generate from both plain documentation file located in the {{{doc/}}} directory and some chosen header source files. These files are processed using the [http://www.nongnu.org/mkdoc/ MkDoc] tool. This tool '''comes with a manual''', but it's still worth detailing some MutekH specific issues here.
@@ -123 +123 @@
  * {{{@param}}} and {{{@return}}}: These tags can be used to document parameters and return values. Please '''don't use it for all functions''' if the information are obvious. The {{{@return}}} tag starts a sentence like "''The return value is''". The {{{@param}}} tag adds a "''Parameters list:''" if at the beginning of a paragraph. Do not forget to insert an empty line when beginning a normal text paragraph after these tags.
  * {{{@showcontent}}}: This tag can be used to make the content of a preprocessor macro and numerical values of enums visible in the documentation.
- * {{{@ref}}} and {{{@see}}}: These tags may be used when refering to an other symbol. The {{{@ref}}} tag just insert a link to the specified symbol where it appears. {{{@see}}} tags automatically generate a nice sentence add the symbol documentation end pointing to all related symbols. Do not forget to '''prepend a sharp (#) sign to macro names''' as they are in a different name space to avoid collisions. Headers and modules can be refered too with @ and + sign prefix.
+ * {{{@ref}}} and {{{@see}}}: These tags may be used when refering to an other symbol. The {{{@ref}}} tag just insert a link to the specified symbol where it appears. {{{@see}}} tags automatically generate a nice sentence at symbol documentation end pointing to all related symbols. Do not forget to '''prepend a sharp (#) sign to macro names''' as they are in a different name space to avoid collisions. Headers and modules can be refered too with @ and + sign prefix.
  * {{{@url}}} can be used to add an internet link. You may use this to link against this wiki.