Commit 7bf5e082 authored by Fred Drake's avatar Fred Drake

Use {classdesc} consistently.

parent c9808b3a
...@@ -2,7 +2,6 @@ ...@@ -2,7 +2,6 @@
\label{module-formatter} \label{module-formatter}
\stmodindex{formatter} \stmodindex{formatter}
\setindexsubitem{(in module formatter)}
This module supports two interface definitions, each with mulitple This module supports two interface definitions, each with mulitple
implementations. The \emph{formatter} interface is used by the implementations. The \emph{formatter} interface is used by the
...@@ -188,8 +187,6 @@ Two implementations of formatter objects are provided by this module. ...@@ -188,8 +187,6 @@ Two implementations of formatter objects are provided by this module.
Most applications may use one of these classes without modification or Most applications may use one of these classes without modification or
subclassing. subclassing.
\setindexsubitem{(in module formatter)}
\begin{classdesc}{NullFormatter}{\optional{writer}} \begin{classdesc}{NullFormatter}{\optional{writer}}
A formatter which does nothing. If \var{writer} is omitted, a A formatter which does nothing. If \var{writer} is omitted, a
\class{NullWriter} instance is created. No methods of the writer are \class{NullWriter} instance is created. No methods of the writer are
...@@ -216,7 +213,7 @@ Note that while most applications can use the ...@@ -216,7 +213,7 @@ Note that while most applications can use the
\class{AbstractFormatter} class as a formatter, the writer must \class{AbstractFormatter} class as a formatter, the writer must
typically be provided by the application. typically be provided by the application.
\setindexsubitem{(writer object method)} \setindexsubitem{(writer method)}
\begin{funcdesc}{flush}{} \begin{funcdesc}{flush}{}
Flush any buffered output or device control events. Flush any buffered output or device control events.
...@@ -308,24 +305,22 @@ Three implementations of the writer object interface are provided as ...@@ -308,24 +305,22 @@ Three implementations of the writer object interface are provided as
examples by this module. Most applications will need to derive new examples by this module. Most applications will need to derive new
writer classes from the \class{NullWriter} class. writer classes from the \class{NullWriter} class.
\setindexsubitem{(in module formatter)} \begin{classdesc}{NullWriter}{}
\begin{funcdesc}{NullWriter}{}
A writer which only provides the interface definition; no actions are A writer which only provides the interface definition; no actions are
taken on any methods. This should be the base class for all writers taken on any methods. This should be the base class for all writers
which do not need to inherit any implementation methods. which do not need to inherit any implementation methods.
\end{funcdesc} \end{classdesc}
\begin{funcdesc}{AbstractWriter}{} \begin{classdesc}{AbstractWriter}{}
A writer which can be used in debugging formatters, but not much A writer which can be used in debugging formatters, but not much
else. Each method simply announces itself by printing its name and else. Each method simply announces itself by printing its name and
arguments on standard output. arguments on standard output.
\end{funcdesc} \end{classdesc}
\begin{funcdesc}{DumbWriter}{\optional{file\optional{\, maxcol\code{ = 72}}}} \begin{classdesc}{DumbWriter}{\optional{file\optional{\, maxcol\code{ = 72}}}}
Simple writer class which writes output on the file object passed in Simple writer class which writes output on the file object passed in
as \var{file} or, if \var{file} is omitted, on standard output. The as \var{file} or, if \var{file} is omitted, on standard output. The
output is simply word-wrapped to the number of columns specified by output is simply word-wrapped to the number of columns specified by
\var{maxcol}. This class is suitable for reflowing a sequence of \var{maxcol}. This class is suitable for reflowing a sequence of
paragraphs. paragraphs.
\end{funcdesc} \end{classdesc}
...@@ -2,7 +2,6 @@ ...@@ -2,7 +2,6 @@
\label{module-formatter} \label{module-formatter}
\stmodindex{formatter} \stmodindex{formatter}
\setindexsubitem{(in module formatter)}
This module supports two interface definitions, each with mulitple This module supports two interface definitions, each with mulitple
implementations. The \emph{formatter} interface is used by the implementations. The \emph{formatter} interface is used by the
...@@ -188,8 +187,6 @@ Two implementations of formatter objects are provided by this module. ...@@ -188,8 +187,6 @@ Two implementations of formatter objects are provided by this module.
Most applications may use one of these classes without modification or Most applications may use one of these classes without modification or
subclassing. subclassing.
\setindexsubitem{(in module formatter)}
\begin{classdesc}{NullFormatter}{\optional{writer}} \begin{classdesc}{NullFormatter}{\optional{writer}}
A formatter which does nothing. If \var{writer} is omitted, a A formatter which does nothing. If \var{writer} is omitted, a
\class{NullWriter} instance is created. No methods of the writer are \class{NullWriter} instance is created. No methods of the writer are
...@@ -216,7 +213,7 @@ Note that while most applications can use the ...@@ -216,7 +213,7 @@ Note that while most applications can use the
\class{AbstractFormatter} class as a formatter, the writer must \class{AbstractFormatter} class as a formatter, the writer must
typically be provided by the application. typically be provided by the application.
\setindexsubitem{(writer object method)} \setindexsubitem{(writer method)}
\begin{funcdesc}{flush}{} \begin{funcdesc}{flush}{}
Flush any buffered output or device control events. Flush any buffered output or device control events.
...@@ -308,24 +305,22 @@ Three implementations of the writer object interface are provided as ...@@ -308,24 +305,22 @@ Three implementations of the writer object interface are provided as
examples by this module. Most applications will need to derive new examples by this module. Most applications will need to derive new
writer classes from the \class{NullWriter} class. writer classes from the \class{NullWriter} class.
\setindexsubitem{(in module formatter)} \begin{classdesc}{NullWriter}{}
\begin{funcdesc}{NullWriter}{}
A writer which only provides the interface definition; no actions are A writer which only provides the interface definition; no actions are
taken on any methods. This should be the base class for all writers taken on any methods. This should be the base class for all writers
which do not need to inherit any implementation methods. which do not need to inherit any implementation methods.
\end{funcdesc} \end{classdesc}
\begin{funcdesc}{AbstractWriter}{} \begin{classdesc}{AbstractWriter}{}
A writer which can be used in debugging formatters, but not much A writer which can be used in debugging formatters, but not much
else. Each method simply announces itself by printing its name and else. Each method simply announces itself by printing its name and
arguments on standard output. arguments on standard output.
\end{funcdesc} \end{classdesc}
\begin{funcdesc}{DumbWriter}{\optional{file\optional{\, maxcol\code{ = 72}}}} \begin{classdesc}{DumbWriter}{\optional{file\optional{\, maxcol\code{ = 72}}}}
Simple writer class which writes output on the file object passed in Simple writer class which writes output on the file object passed in
as \var{file} or, if \var{file} is omitted, on standard output. The as \var{file} or, if \var{file} is omitted, on standard output. The
output is simply word-wrapped to the number of columns specified by output is simply word-wrapped to the number of columns specified by
\var{maxcol}. This class is suitable for reflowing a sequence of \var{maxcol}. This class is suitable for reflowing a sequence of
paragraphs. paragraphs.
\end{funcdesc} \end{classdesc}
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