From 9f2376de7a4b9c26193ced8b6767410b6b54390b Mon Sep 17 00:00:00 2001
From: Fred Drake <fdrake@acm.org>
Date: Fri, 11 May 2001 01:01:12 +0000
Subject: Document the new classdesc* environment, and the previously
 undocumented excclassdesc environment.

---
 Doc/doc/doc.tex | 19 ++++++++++++++++++-
 1 file changed, 18 insertions(+), 1 deletion(-)

diff --git a/Doc/doc/doc.tex b/Doc/doc/doc.tex
index a86c450..2275797 100644
--- a/Doc/doc/doc.tex
+++ b/Doc/doc/doc.tex
@@ -519,9 +519,19 @@ This \UNIX\ is also followed by a space.
       Like \env{datadesc}, but without creating any index entries.
     \end{envdesc}
 
+    \begin{envdesc}{excclassdesc}{\p{name}\p{constructor parameters}}
+      Descibe an exception defined by a class.  \var{constructor
+      parameters} should not include the \var{self} parameter or
+      the parentheses used in the call syntax.  To describe an
+      exception class without describing the parameters to its
+      constructor, use the \env{excdesc} environment.
+    \end{envdesc}
+
     \begin{envdesc}{excdesc}{\p{name}}
       Describe an exception.  This may be either a string exception or
-      a class exception.
+      a class exception.  In the case of class exceptions, the
+      constructor parameters are not described; use \env{excclassdesc}
+      to describe an exception class and its constructor.
     \end{envdesc}
 
     \begin{envdesc}{funcdesc}{\p{name}\p{parameters}}
@@ -547,6 +557,13 @@ This \UNIX\ is also followed by a space.
       the parentheses used in the call syntax.
     \end{envdesc}
 
+    \begin{envdesc}{classdesc*}{\p{name}}
+      Describe a class without describing the constructor.  This can
+      be used to describe classes that are merely containers for
+      attributes or which should never be instantiated or subclassed
+      by user code.
+    \end{envdesc}
+
     \begin{envdesc}{memberdesc}{\op{type name}\p{name}}
       Describe an object data attribute.  The description should
       include information about the type of the data to be expected
-- 
cgit v0.12

