mirror of https://github.com/python/cpython
Document the \csimplemacro macro and the csimplemacrodesc environment.
This commit is contained in:
parent
19f827e765
commit
79bf99c505
|
@ -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
|
||||
|
|
Loading…
Reference in New Issue