mirrors/cpython
1
0
Fork 0
mirror of https://github.com/python/cpython.git synced 2025-09-27 18:59:43 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 11

Document the cmemberdesc environment.

Browse source
This commit is contained in:
Fred Drake 2002-04-15 20:10:23 +00:00
parent be22ae6def
commit 1251b0eb24
1 changed files with 11 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

11
Doc/doc/doc.tex
View file

@ -549,6 +549,17 @@ This \UNIX\ is also followed by a space.
be used in the description. be used in the description.
\end{envdesc} \end{envdesc}
\begin{envdesc}{cmemberdesc}{\p{container}\p{type}\p{name}}
Description for a structure member. \var{container} should be
the \keyword{typedef} name, if there is one, otherwise if should
be \samp{struct \var{tag}}. The type of the member should given
as \var{type}, and the name should be given as \var{name}. The
text of the description should include the range of values
allowed, how the value should be interpreted, and whether the
value can be changed. References to structure members in text
should use the \macro{member} macro.
\end{envdesc}
\begin{envdesc}{csimplemacrodesc}{\p{name}} \begin{envdesc}{csimplemacrodesc}{\p{name}}
Documentation for a ``simple'' macro. Simple macros are macros Documentation for a ``simple'' macro. Simple macros are macros
which are used for code expansion, but which do not take which are used for code expansion, but which do not take