Enable the huge files patch to build with mingw-cross.

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

diff --git a/docs/tech/tn0003.txt b/docs/tech/tn0003.txt
index a1fa46e997a755107dfe96bf208a13c7448c2507..151d28aa635f172b4a15859016af8a3aad10fccb 100644 (file)
--- a/docs/tech/tn0003.txt
+++ b/docs/tech/tn0003.txt
@@ -1,15 +1,15 @@
-                     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.wxwindows.org/tex2rtf/index.htm for a browseable
+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
 manual and binaries for specific platforms.
 
 If adding to the existing manual in docs/latex/wx, you need to


@@ -20,7 +20,7 @@ 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.
 


@@ -55,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 further 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


@@ -88,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 '-checkcurleybraces' 

   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


@@ -219,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.
 


@@ -238,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}
 


@@ -270,3 +270,7 @@ Special forms:
 
 - use \destruct macro for the destructors \func{}{\destruct{MyClass}}{\void}
 
 
 - 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