]> git.saurik.com Git - wxWidgets.git/commitdiff
no changes, just fix a few typos and wrap long lines
authorVadim Zeitlin <vadim@wxwidgets.org>
Fri, 14 Mar 2008 17:11:45 +0000 (17:11 +0000)
committerVadim Zeitlin <vadim@wxwidgets.org>
Fri, 14 Mar 2008 17:11:45 +0000 (17:11 +0000)
git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@52504 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775

docs/tech/tn0003.txt

index 0f399147d4736f8a801a6f4790c0253f7c11952d..569a3467a2feba3dd177457ff9154ea7c01009dd 100644 (file)
@@ -40,7 +40,7 @@ For HTML:
   1) cd wxWidgets/docs/doxygen
   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
@@ -62,7 +62,7 @@ DO:
 - when you write true, false and NULL with their C++ semantic meaning,
   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
   paragraph making the result less readable.
 
@@ -89,9 +89,9 @@ DO:
        write:
             @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;
-  second argument can have up to 10 commas unescaped (see the Doxyfile for the
-  trick used to implement this).
+  Also note that you need to escape only the commas of the first argument's
+  text; second argument can have up to 10 commas unescaped (see the Doxyfile
+  for the trick used to implement this).
 
 - for linking use one of:
      => the @ref command to refer to topic overviews;
@@ -100,7 +100,8 @@ DO:
      => the classname:: operator to refer to functions of classes different
         from the one you're documenting;
      => 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:
 
@@ -246,14 +247,15 @@ there is a corresponding link anchor.
 
 The following conventions are used in wxWidgets doxygen comments:
 
-1) all "main" pages of the manual (those which are placed in docs/doxygen/mainpages) 
-   have link anchors which begin with "page_"
+1) all "main" pages of the manual (those which are placed in
+   docs/doxygen/mainpages) have link anchors which begin with "page_"
 
-2) all topic overviews (those which are placed in docs/doxygen/overviews) have link 
-   anchors which begin with "overview_"
+2) all topic overviews (those which are placed in docs/doxygen/overviews) have
+   link anchors which begin with "overview_"
 
-3) all @section, @subsection, @subsubsection tags should have as link anchor name
-   the name of the parent section plus a specific word separed with an underscore; e.g.:
+3) all @section, @subsection, @subsubsection tags should have as link anchor
+   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 ===
 
-Author: FM (under the lines of the previous technote about tex2rtf)
+Author: FM (along the lines of the previous technote about tex2rtf)
 Version: $Id$