Kaydet (Commit) 9f2376de authored tarafından Fred Drake's avatar Fred Drake

Document the new classdesc* environment, and the previously undocumented

excclassdesc environment.
üst 06a01e84
...@@ -519,9 +519,19 @@ This \UNIX\ is also followed by a space. ...@@ -519,9 +519,19 @@ This \UNIX\ is also followed by a space.
Like \env{datadesc}, but without creating any index entries. Like \env{datadesc}, but without creating any index entries.
\end{envdesc} \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}} \begin{envdesc}{excdesc}{\p{name}}
Describe an exception. This may be either a string exception or 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} \end{envdesc}
\begin{envdesc}{funcdesc}{\p{name}\p{parameters}} \begin{envdesc}{funcdesc}{\p{name}\p{parameters}}
...@@ -547,6 +557,13 @@ This \UNIX\ is also followed by a space. ...@@ -547,6 +557,13 @@ This \UNIX\ is also followed by a space.
the parentheses used in the call syntax. the parentheses used in the call syntax.
\end{envdesc} \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}} \begin{envdesc}{memberdesc}{\op{type name}\p{name}}
Describe an object data attribute. The description should Describe an object data attribute. The description should
include information about the type of the data to be expected include information about the type of the data to be expected
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment