Warning fixes for Cygwin

[wxWidgets.git] / docs / tech / tn0003.txt

diff --git a/docs/tech/tn0003.txt b/docs/tech/tn0003.txt
index e193c50fe1b17dcf764ca7d3d3b1ced4d43210f8..da54afac8df09a9b42989eed9c4281125ff15807 100644 (file)
--- a/docs/tech/tn0003.txt
+++ b/docs/tech/tn0003.txt
@@ -1,24 +1,26 @@
-                     Adding wxWindows class documentation
+                     Adding wxWidgets class documentation

                      ====================================
 
 This note is aimed at people wishing to add documentation for a
                      ====================================
 
 This note is aimed at people wishing to add documentation for a

-class to either the main wxWindows manual, or to their own
+class to either the main wxWidgets manual, or to their own

 manual.
 
 manual.
 

-wxWindows uses Tex2RTF to process Latex-like input files (.tex)
+wxWidgets uses Tex2RTF to process Latex-like input files (.tex)

 and output in HTML, WinHelp RTF and Word RTF. Tex2RTF is provided
 and output in HTML, WinHelp RTF and Word RTF. Tex2RTF is provided

-in the wxWindows distribution and in the CVS archive, under
+in the wxWidgets distribution and in the CVS archive, under

 utils/tex2rtf. Please start by perusing the Tex2RTF manual.
 utils/tex2rtf. Please start by perusing the Tex2RTF manual.

+See http://www.wxwidgets.org/tex2rtf/index.htm for a browseable
+manual and binaries for specific platforms.

 
 If adding to the existing manual in docs/latex/wx, you need to
 create a new .tex file, e.g. myclass.tex, and add it to the
 list of classes in classes.tex (in strict alphabetical order).
 You may also want to write a separate topic file, e.g. tmyclass.tex,
 
 If adding to the existing manual in docs/latex/wx, you need to
 create a new .tex file, e.g. myclass.tex, and add it to the
 list of classes in classes.tex (in strict alphabetical order).
 You may also want to write a separate topic file, e.g. tmyclass.tex,

-and add the entry to topics.tex.  Also, if applicable, and an entry
+and add the entry to topics.tex.  If applicable, also add an entry

 to category.tex.
 
 If compiling a separate manual, copy an existing set of files from the
 to category.tex.
 
 If compiling a separate manual, copy an existing set of files from the

-wxWindows manual or a contribution. Contribution documentation
+wxWidgets manual or a contribution. Contribution documentation

 normally goes in the contrib/docs hierarchy, with the source
 going in a latex/mycontrib subdirectory.
 
 normally goes in the contrib/docs hierarchy, with the source
 going in a latex/mycontrib subdirectory.
 


@@ -53,12 +55,12 @@ parameter, and then choose FILE|GO from the menu.  For example:
    tex2rtf manual.tex manual.rtf -rtf -twice -interactive
 
 NOTE: You must be using the latest tex2rtf which was released with
    tex2rtf manual.tex manual.rtf -rtf -twice -interactive
 
 NOTE: You must be using the latest tex2rtf which was released with

-v2.2.0 of wxWindows to use the -interactive switch
+v2.2.0 of wxWidgets to use the -interactive switch

 
 If you wish to generate documentation for wxHTML Help Viewer
 (or Windows HTML Help), set htmlWorkshopFiles to true in your
 tex2rtf.ini file. See also the wxHTML Notes section in the
 
 If you wish to generate documentation for wxHTML Help Viewer
 (or Windows HTML Help), set htmlWorkshopFiles to true in your
 tex2rtf.ini file. See also the wxHTML Notes section in the

-wxWindows manual. To futher speed-up HTML help books loading
+wxWidgets manual. To further speed-up HTML help books loading

 in your application, you may use hhp2cached (utils/hhp2cached).
 
 src/msw/makefile.vc contains targets for generating various
 in your application, you may use hhp2cached (utils/hhp2cached).
 
 src/msw/makefile.vc contains targets for generating various


@@ -86,12 +88,12 @@ DO:
   format and running through the Windows help compiler to check
   for missing labels, etc.
 
   format and running through the Windows help compiler to check
   for missing labels, etc.
 

-- quote all '_' characters with a '\' character (e.g. "MY\_PROGRAM" 
+- quote all '_' and '&' characters with a '\' character (e.g. "MY\_PROGRAM"

   unless the '_' is inside a comment or a \begin{verbatim} ...
   \end{verbatim} block
 
 - check that your changes/additions to any TEX documentation 
   unless the '_' is inside a comment or a \begin{verbatim} ...
   \end{verbatim} block
 
 - check that your changes/additions to any TEX documentation 

-  compiles before checking it in!  Use the '-checkcurleybrace' 
+  compiles before checking it in!  Use the '-checkcurlybraces' 

   and '-checksyntax' commandline parameters (or the OPTIONS menu 
   if running in GUI mode) to check for some of the more common 
   mistakes.  See TROUBLESHOOTING below for more details
   and '-checksyntax' commandline parameters (or the OPTIONS menu 
   if running in GUI mode) to check for some of the more common 
   mistakes.  See TROUBLESHOOTING below for more details


@@ -152,7 +154,7 @@ here is one important tip:
    caused the problem.
 
        When making changes/additions to the documentation, always use 
    caused the problem.
 
        When making changes/additions to the documentation, always use 

-       the '-checkcurleybraces' and '-checksyntax' commandline parameters
+       the '-checkcurlybraces' and '-checksyntax' commandline parameters

        (or turn these options on in the GUI version via the OPTIONS menu 
        choice), BEFORE checking in your changes.  These two debugging 
        options will catch many of the more common mistakes that are made
        (or turn these options on in the GUI version via the OPTIONS menu 
        choice), BEFORE checking in your changes.  These two debugging 
        options will catch many of the more common mistakes that are made


@@ -217,7 +219,7 @@ Creates a fresh bitmap. If the final argument is omitted, the display depth of
 the screen is used.
 
 \func{virtual bool}{Create}{\param{void*}{ data}, \param{int}{ type},
 the screen is used.
 
 \func{virtual bool}{Create}{\param{void*}{ data}, \param{int}{ type},

- \param{int}{ width}, \param{int}{ height}, \param{int}{ depth = -1}}
+ \param{int}{ width}, \param{int}{ height}, \param{int}{ depth = $-1$}}

 
 Creates a bitmap from the given data, which can be of arbitrary type.
 
 
 Creates a bitmap from the given data, which can be of arbitrary type.
 


@@ -236,7 +238,7 @@ of possible values.}
 
 \wxheading{Return value}
 
 
 \wxheading{Return value}
 

-TRUE if the call succeeded, FALSE otherwise.
+\true if the call succeeded, \false otherwise.

 
 \wxheading{Remarks}
 
 
 \wxheading{Remarks}
 


@@ -253,3 +255,22 @@ Note the use of \docparam to document parameters; and the fact
 that several overloaded forms of the same member function are
 documented within the same \membersection.
 
 that several overloaded forms of the same member function are
 documented within the same \membersection.
 

+
+Special forms:
+
+- for a const member function use \constfunc{} instead of \const
+
+- for a function without parameters use \func{...}{Function}{\void}
+
+- but do NOT use \void for functions without return value, just "void"
+
+- for a virtual/static member function use \func{virtual/static ...}
+
+- omit the return type for constructors: \func{}{MyClass}{...}
+
+- use \destruct macro for the destructors \func{}{\destruct{MyClass}}{\void}
+
+- use \true and \false instead of true/TRUE/{\tt true}/...
+
+- use \arg{paramname} to refer to the argument inside of the function
+  description