Send all menu item actions to a dedicated target. This is to ensure

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

diff --git a/docs/tech/tn0003.txt b/docs/tech/tn0003.txt
index e193c50fe1b17dcf764ca7d3d3b1ced4d43210f8..bec2e461abb30e8ed4f07621cabedee0145d9ef3 100644 (file)
--- a/docs/tech/tn0003.txt
+++ b/docs/tech/tn0003.txt
@@ -9,12 +9,14 @@ wxWindows uses Tex2RTF to process Latex-like input files (.tex)
 and output in HTML, WinHelp RTF and Word RTF. Tex2RTF is provided
 in the wxWindows distribution and in the CVS archive, under
 utils/tex2rtf. Please start by perusing the Tex2RTF manual.
+See http://www.wxwindows.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,
-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
@@ -58,7 +60,7 @@ v2.2.0 of wxWindows 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
-wxWindows manual. To futher speed-up HTML help books loading
+wxWindows 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
@@ -86,12 +88,12 @@ DO:
   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 
-  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
@@ -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},
- \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.
 
@@ -236,7 +238,7 @@ of possible values.}
 
 \wxheading{Return value}
 
-TRUE if the call succeeded, FALSE otherwise.
+\true if the call succeeded, \false otherwise.
 
 \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.
 
+
+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