summaryrefslogtreecommitdiff
path: root/Doc/perl/python.perl
diff options
context:
space:
mode:
authorFred Drake <fdrake@acm.org>2001-05-11 01:00:30 +0000
committerFred Drake <fdrake@acm.org>2001-05-11 01:00:30 +0000
commit06a01e84b90129d3edb8e9620972733a88bae4fb (patch)
tree31a1076b21a380dd25698119e484b91b7e89ac61 /Doc/perl/python.perl
parent986badae1ea6f1545ceae53147f5c2ab7750915b (diff)
downloadcpython-git-06a01e84b90129d3edb8e9620972733a88bae4fb.tar.gz
Define a new environment, classdesc*, which can be used to document a
class without providing any information about the constructor. This should be used for classes which only exist to act as containers rather than as factories for instances.
Diffstat (limited to 'Doc/perl/python.perl')
-rw-r--r--Doc/perl/python.perl11
1 files changed, 11 insertions, 0 deletions
diff --git a/Doc/perl/python.perl b/Doc/perl/python.perl
index 7b58d6a0de..39c99317e0 100644
--- a/Doc/perl/python.perl
+++ b/Doc/perl/python.perl
@@ -906,6 +906,17 @@ sub do_env_classdesc{
return handle_classlike_descriptor(@_[0], "class");
}
+sub do_env_classdescstar{
+ local($_) = @_;
+ $THIS_CLASS = next_argument();
+ $idx = make_str_index_entry(
+ "<tt class='class'>$THIS_CLASS</tt> (class in $THIS_MODULE)" );
+ $idx =~ s/ \(.*\)//;
+ return ("<dl><dt><b>class $idx</b>\n<dd>"
+ . $_
+ . '</dl>');
+}
+
sub do_env_excclassdesc{
return handle_classlike_descriptor(@_[0], "exception");
}