fixed the anchor names for @section used in interface headers; documented the general rules used for its naming

git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@56445 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
This commit is contained in:
Francesco Montorsi
2008-10-19 15:30:20 +00:00
parent 6a93e7940b
commit 3a74a290a9
8 changed files with 43 additions and 14 deletions

View File

@@ -10,7 +10,7 @@ documentation in the form of C++ comments and output in HTML, and XML
(Doxygen itself can also output Latex, manpages, RTF, PDF etc).
See http://www.doxygen.org for more info about Doxygen.
If you want to add documentation of a new class/function to the
If you want to add documentation of a new class/function to the
existing manual in docs/doxygen, you need to create a new .h file,
e.g. myclass.h, under the interface folder, which contains the public
interface of the new class/function in C++ syntax.
@@ -136,7 +136,6 @@ Start off with:
/**
@class wxMyClass
@wxheader{myclass.h}
...here goes the description...
@@ -173,9 +172,39 @@ Start off with:
manual pages using the @ref command
*/
Note that everything *except* the @class, @wxheader, @library and @category
Note that everything *except* the @class, @library and @category
commands are optionals.
Also note that if you use @section and @subsection in the class description
(at the beginning), you should use as the section's anchor name "xxxx_yyyy"
where "xxxx" is the the class name without the initial "wx" in lowercase
and "yyyy" is a lowercase word which uniquely identifies that section.
E.g.:
/**
@class wxMyClass
This class does not exist really and is only used as an example
of best documentation practices.
@section myclass_special Special functions of this class
This section describes the functions whose usage is reserved for
wxWidgets internal mechanisms... etc etc...
@section myclass_custom Customizing wxMyClass
What if you want to customize this powerful class?
First you should do this and that, etc etc...
@library{wxbase}
@category{misc}
@see wxMyOtherClass
*/
Documentation comment for a function
@@ -204,7 +233,7 @@ Start off with:
Note that the @return, @note, @remarks, @see commands are optional.
The @param command has an optional attribute specifying the direction of
The @param command has an optional attribute specifying the direction of
the attribute. Possible values are "in" and "out". E.g.
/**
@@ -250,7 +279,7 @@ and are completely placed inside a single comment block in the form of:
*/
Note that there is a convention in the anchor link names.
Doxygen in fact requires that for each @page, @section, @subsection, etc tag,
Doxygen in fact requires that for each @page, @section, @subsection, etc tag,
there is a corresponding link anchor.
The following conventions are used in wxWidgets doxygen comments: