summaryrefslogtreecommitdiffstats
path: root/Doc
diff options
context:
space:
mode:
authorFred Drake <fdrake@acm.org>2002-04-15 20:10:23 (GMT)
committerFred Drake <fdrake@acm.org>2002-04-15 20:10:23 (GMT)
commit1251b0eb242d313d778538ce55888c11bfa8b678 (patch)
tree61c47ba08619091ff803d0c66d68871b6262076b /Doc
parentbe22ae6def4ff3bfb826a96c1e5b1360b5a7c1e0 (diff)
downloadcpython-1251b0eb242d313d778538ce55888c11bfa8b678.zip
cpython-1251b0eb242d313d778538ce55888c11bfa8b678.tar.gz
cpython-1251b0eb242d313d778538ce55888c11bfa8b678.tar.bz2
Document the cmemberdesc environment.
Diffstat (limited to 'Doc')
-rw-r--r--Doc/doc/doc.tex11
1 files changed, 11 insertions, 0 deletions
diff --git a/Doc/doc/doc.tex b/Doc/doc/doc.tex
index a635eb1..5bea685 100644
--- a/Doc/doc/doc.tex
+++ b/Doc/doc/doc.tex
@@ -549,6 +549,17 @@ This \UNIX\ is also followed by a space.
be used in the description.
\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}}
Documentation for a ``simple'' macro. Simple macros are macros
which are used for code expansion, but which do not take