summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorFred Drake <fdrake@acm.org>2002-04-09 20:17:42 (GMT)
committerFred Drake <fdrake@acm.org>2002-04-09 20:17:42 (GMT)
commit79bf99c5051451b8af900cb26b6080c56690d4a2 (patch)
tree49b70cac0321cbc6159a6d8ca6240df5eddf289b
parent19f827e76532dbd79272c4ae3a91a4b4857f6d4a (diff)
downloadcpython-79bf99c5051451b8af900cb26b6080c56690d4a2.zip
cpython-79bf99c5051451b8af900cb26b6080c56690d4a2.tar.gz
cpython-79bf99c5051451b8af900cb26b6080c56690d4a2.tar.bz2
Document the \csimplemacro macro and the csimplemacrodesc environment.
-rw-r--r--Doc/doc/doc.tex20
1 files changed, 20 insertions, 0 deletions
diff --git a/Doc/doc/doc.tex b/Doc/doc/doc.tex
index 15f8971..a635eb1 100644
--- a/Doc/doc/doc.tex
+++ b/Doc/doc/doc.tex
@@ -549,6 +549,16 @@ This \UNIX\ is also followed by a space.
be used in the description.
\end{envdesc}
+ \begin{envdesc}{csimplemacrodesc}{\p{name}}
+ Documentation for a ``simple'' macro. Simple macros are macros
+ which are used for code expansion, but which do not take
+ arguments so cannot be described as functions. This is not to
+ be used for simple constant definitions. Examples of it's use
+ in the Python documentation include
+ \csimplemacro{PyObject_HEAD} and
+ \csimplemacro{Py_BEGIN_ALLOW_THREADS}.
+ \end{envdesc}
+
\begin{envdesc}{ctypedesc}{\op{tag}\p{name}}
Environment used to described a C type. The \var{name}
parameter should be the \keyword{typedef} name. If the type is
@@ -735,6 +745,16 @@ This \UNIX\ is also followed by a space.
changed.
\end{macrodesc}
+ \begin{macrodesc}{csimplemacro}{\p{name}}
+ The name of a ``simple'' macro. Simple macros are macros
+ which are used for code expansion, but which do not take
+ arguments so cannot be described as functions. This is not to
+ be used for simple constant definitions. Examples of it's use
+ in the Python documentation include
+ \csimplemacro{PyObject_HEAD} and
+ \csimplemacro{Py_BEGIN_ALLOW_THREADS}.
+ \end{macrodesc}
+
\begin{macrodesc}{ctype}{\p{name}}
The name of a C \keyword{typedef} or structure. For structures
defined without a \keyword{typedef}, use \code{\e ctype\{struct