From: Vadim Zeitlin <vadim@wxwidgets.org>
Date: Sun, 20 Jul 2003 20:02:56 +0000 (+0000)
Subject: added \arg macro
X-Git-Url: https://git.saurik.com/wxWidgets.git/commitdiff_plain/f93647859c02f4bfd5c262e98a58399b660de9aa

added \arg macro


git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@22165 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
---

diff --git a/docs/latex/wx/texhelp.sty b/docs/latex/wx/texhelp.sty
index 1dd5cd5f21..e275e3f94c 100644
--- a/docs/latex/wx/texhelp.sty
+++ b/docs/latex/wx/texhelp.sty
@@ -82,6 +82,9 @@
 % C++ Parameter: a type and a name (no intervening space)
 \newcommand{\param}[2]{{\it #1}{\bf #2}}
 
+% C++ argument in the documentation text
+\newcommand{\arg}[1]{{\it #1}}
+
 % CLIPS Parameter: a type and a name (one intervening space)
 \newcommand{\cparam}[2]{{\bf #1} {\it #2}}
 
diff --git a/docs/tech/tn0003.txt b/docs/tech/tn0003.txt
index 775929b8b8..bec2e461ab 100644
--- a/docs/tech/tn0003.txt
+++ b/docs/tech/tn0003.txt
@@ -88,7 +88,7 @@ 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
 
@@ -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},
- \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.
 
@@ -238,7 +238,7 @@ of possible values.}
 
 \wxheading{Return value}
 
-{\tt true} if the call succeeded, {\tt false} otherwise.
+\true if the call succeeded, \false otherwise.
 
 \wxheading{Remarks}
 
@@ -270,3 +270,7 @@ Special forms:
 
 - 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