From 06a01e84b90129d3edb8e9620972733a88bae4fb Mon Sep 17 00:00:00 2001
From: Fred Drake <fdrake@acm.org>
Date: Fri, 11 May 2001 01:00:30 +0000
Subject: 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.

---
 Doc/perl/python.perl | 11 +++++++++++
 1 file changed, 11 insertions(+)

(limited to 'Doc/perl/python.perl')

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");
 }
-- 
cgit v1.2.1