[Python-checkins] python/dist/src/Doc/doc doc.tex,1.61,1.62

[fdrake@sourceforge.net]

Update of /cvsroot/python/python/dist/src/Doc/doc
In directory usw-pr-cvs1:/tmp/cvs-serv2279/doc

Modified Files:
	doc.tex 
Log Message:
Document the cmemberdesc environment.

Index: doc.tex
===================================================================
RCS file: /cvsroot/python/python/dist/src/Doc/doc/doc.tex,v
retrieving revision 1.61
retrieving revision 1.62
diff -C2 -d -r1.61 -r1.62
*** doc.tex	9 Apr 2002 20:17:42 -0000	1.61
--- doc.tex	15 Apr 2002 20:10:23 -0000	1.62
***************
*** 550,553 ****
--- 550,564 ----
      \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