[Epydoc-commits] SF.net SVN: epydoc: [1618] trunk/epydoc/src/epydoc

[<ed...@us...>]

Revision: 1618
          http://epydoc.svn.sourceforge.net/epydoc/?rev=1618&view=rev
Author:   edloper
Date:     2007-09-23 08:07:34 -0700 (Sun, 23 Sep 2007)

Log Message:
-----------
- Added --redundant-details option: "Include values in the details lists
even if all info about them is already provided by the summary table."

Modified Paths:
--------------
    trunk/epydoc/src/epydoc/cli.py
    trunk/epydoc/src/epydoc/docwriter/html.py

Modified: trunk/epydoc/src/epydoc/cli.py
===================================================================
--- trunk/epydoc/src/epydoc/cli.py	2007-09-23 14:33:08 UTC (rev 1617)
+++ trunk/epydoc/src/epydoc/cli.py	2007-09-23 15:07:34 UTC (rev 1618)
@@ -136,7 +136,8 @@
     list_classes_separately=False, graph_font=None, graph_font_size=None,
     include_source_code=True, pstat_files=[], simple_term=False, fail_on=None,
     exclude=[], exclude_parse=[], exclude_introspect=[],
-    external_api=[],external_api_file=[],external_api_root=[])
+    external_api=[],external_api_file=[],external_api_root=[],
+    redundant_details=False)
 
 def parse_arguments():
     # Construct the option parser.
@@ -285,6 +286,11 @@
         action='store_true', dest='include_log',
         help=("Include a page with the process log (epydoc-log.html)"))
 
+    generation_group.add_option(
+        '--redundant-details',
+        action='store_true', dest='redundant_details',
+        help=("Include values in the details lists even if all info "
+              "about them is already provided by the summary table."))
 
     output_group = OptionGroup(optparser, 'Output Options')
     optparser.add_option_group(output_group)
@@ -547,6 +553,8 @@
             options.include_source_code = _str_to_bool(val, optname)
         elif optname in ('include-log', 'include_log'):
             options.include_log = _str_to_bool(val, optname)
+        elif optname in ('redundant-details', 'redundant_details'):
+            options.redundant_details = _str_to_bool(val, optname)
 
         # Output options
         elif optname == 'name':

Modified: trunk/epydoc/src/epydoc/docwriter/html.py
===================================================================
--- trunk/epydoc/src/epydoc/docwriter/html.py	2007-09-23 14:33:08 UTC (rev 1617)
+++ trunk/epydoc/src/epydoc/docwriter/html.py	2007-09-23 15:07:34 UTC (rev 1618)
@@ -359,6 +359,10 @@
         """Map the callgraph L{uid<DotGraph.uid>} to their HTML
         representation."""
 
+        self._redundant_details = kwargs.get('redundant_details', False)
+        """If true, then include objects in the details list even if all
+        info about them is already provided by the summary table."""
+
         # For use with select_variables():
         if self._show_private:
             self._public_filter = None
@@ -2049,7 +2053,7 @@
         else: tr_class = ' class="private"'
 
         # Decide an anchor or a link is to be generated.
-        link_name = var_doc.is_detailed()
+        link_name = self._redundant_details or var_doc.is_detailed()
         anchor = not link_name
 
         # Construct the HTML code for the type (cell 1) & description
@@ -2131,16 +2135,20 @@
 
     def write_details_list(self, out, heading, doc, value_type):
         # Get a list of the VarDocs we should describe.
+        if self._redundant_details:
+            detailed = None
+        else:
+            detailed = True
         if isinstance(doc, ClassDoc):
             var_docs = doc.select_variables(value_type=value_type,
                                             imported=False, inherited=False,
                                             public=self._public_filter,
-                                            detailed=True)
+                                            detailed=detailed)
         else:
             var_docs = doc.select_variables(value_type=value_type,
                                             imported=False,
                                             public=self._public_filter,
-                                            detailed=True)
+                                            detailed=detailed)
         if not var_docs: return
 
         # Write a header


This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.