Amebis/wxWidgets
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

no changes, just fix a few typos and wrap long lines

Browse Source 
git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@52504 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
This commit is contained in:
Vadim Zeitlin
2008-03-14 17:11:45 +00:00
parent 8ef9a526ce
commit 741085abe3
1 changed files with 15 additions and 13 deletions
Download Patch File Download Diff File Expand all files Collapse all files

28
docs/tech/tn0003.txt
View File

@@ -40,7 +40,7 @@ For HTML:
1) cd wxWidgets/docs/doxygen 1) cd wxWidgets/docs/doxygen
2) run ./regen.sh [Unix] or regen.bat [Windows] 2) run ./regen.sh [Unix] or regen.bat [Windows]
[TODO: istructions for generation of other formats] [TODO: instructions for generation of other formats]
Important Dos and Don'ts Important Dos and Don'ts
@@ -62,7 +62,7 @@ DO:
- when you write true, false and NULL with their C++ semantic meaning, - when you write true, false and NULL with their C++ semantic meaning,
then use the @true, @false and @NULL commands. then use the @true, @false and @NULL commands.
- separe different paragraphs with an empty comment line. - separate different paragraphs with an empty comment line.
This is important otherwise Doxygen puts everything in the same This is important otherwise Doxygen puts everything in the same
paragraph making the result less readable. paragraph making the result less readable.
@@ -89,9 +89,9 @@ DO:
write: write:
@itemdef{wxEVT_MACRO(id\, func), This is the description of the macro} @itemdef{wxEVT_MACRO(id\, func), This is the description of the macro}
Also note that you need to escape only the commas of the first argument's text; Also note that you need to escape only the commas of the first argument's
second argument can have up to 10 commas unescaped (see the Doxyfile for the text; second argument can have up to 10 commas unescaped (see the Doxyfile
trick used to implement this). for the trick used to implement this).
- for linking use one of: - for linking use one of:
=> the @ref command to refer to topic overviews; => the @ref command to refer to topic overviews;
@@ -100,7 +100,8 @@ DO:
=> the classname:: operator to refer to functions of classes different => the classname:: operator to refer to functions of classes different
from the one you're documenting; from the one you're documenting;
=> the :: prefix to refer to global variables (e.g. ::wxEmptyString). => the :: prefix to refer to global variables (e.g. ::wxEmptyString).
Class names are auto-linked by Doxygen without the need of any explicit command. Class names are auto-linked by Doxygen without the need of any explicit
command.
DON'T: DON'T:
@@ -246,14 +247,15 @@ there is a corresponding link anchor.
The following conventions are used in wxWidgets doxygen comments: The following conventions are used in wxWidgets doxygen comments:
1) all "main" pages of the manual (those which are placed in docs/doxygen/mainpages) 1) all "main" pages of the manual (those which are placed in
have link anchors which begin with "page_" docs/doxygen/mainpages) have link anchors which begin with "page_"
2) all topic overviews (those which are placed in docs/doxygen/overviews) have link 2) all topic overviews (those which are placed in docs/doxygen/overviews) have
anchors which begin with "overview_" link anchors which begin with "overview_"
3) all @section, @subsection, @subsubsection tags should have as link anchor name 3) all @section, @subsection, @subsubsection tags should have as link anchor
the name of the parent section plus a specific word separed with an underscore; e.g.: name the name of the parent section plus a specific word separated with an
underscore; e.g.:
/*! /*!
@@ -273,5 +275,5 @@ The following conventions are used in wxWidgets doxygen comments:
=== EOF === === EOF ===
Author: FM (under the lines of the previous technote about tex2rtf) Author: FM (along the lines of the previous technote about tex2rtf)
Version: $Id$ Version: $Id$