added \arg macro
git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@22165 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
This commit is contained in:
@@ -82,6 +82,9 @@
|
|||||||
% C++ Parameter: a type and a name (no intervening space)
|
% C++ Parameter: a type and a name (no intervening space)
|
||||||
\newcommand{\param}[2]{{\it #1}{\bf #2}}
|
\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)
|
% CLIPS Parameter: a type and a name (one intervening space)
|
||||||
\newcommand{\cparam}[2]{{\bf #1} {\it #2}}
|
\newcommand{\cparam}[2]{{\bf #1} {\it #2}}
|
||||||
|
|
||||||
|
@@ -88,7 +88,7 @@ DO:
|
|||||||
format and running through the Windows help compiler to check
|
format and running through the Windows help compiler to check
|
||||||
for missing labels, etc.
|
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} ...
|
unless the '_' is inside a comment or a \begin{verbatim} ...
|
||||||
\end{verbatim} block
|
\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.
|
the screen is used.
|
||||||
|
|
||||||
\func{virtual bool}{Create}{\param{void*}{ data}, \param{int}{ type},
|
\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}
|
||||||
|
|
||||||
{\tt true} if the call succeeded, {\tt 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
|
||||||
|
Reference in New Issue
Block a user