From: Fred Drake <fdrake@acm.org>
Date: Mon, 15 Apr 2002 20:10:23 +0000 (+0000)
Subject: Document the cmemberdesc environment.
X-Git-Tag: v2.3c1~5942
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=1251b0eb242d313d778538ce55888c11bfa8b678;p=thirdparty%2FPython%2Fcpython.git

Document the cmemberdesc environment.
---

diff --git a/Doc/doc/doc.tex b/Doc/doc/doc.tex
index a635eb18afc4..5bea685370b4 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