From 79bf99c5051451b8af900cb26b6080c56690d4a2 Mon Sep 17 00:00:00 2001
From: Fred Drake <fdrake@acm.org>
Date: Tue, 9 Apr 2002 20:17:42 +0000
Subject: Document the \csimplemacro macro and the csimplemacrodesc
 environment.

---
 Doc/doc/doc.tex | 20 ++++++++++++++++++++
 1 file changed, 20 insertions(+)

diff --git a/Doc/doc/doc.tex b/Doc/doc/doc.tex
index 15f8971..a635eb1 100644
--- a/Doc/doc/doc.tex
+++ b/Doc/doc/doc.tex
@@ -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
-- 
cgit v0.12