[Epydoc-commits] SF.net SVN: epydoc: [1579] trunk/epydoc/src/epydoc/docwriter/html.py

[<dva...@us...>]

Revision: 1579
          http://svn.sourceforge.net/epydoc/?rev=1579&view=rev
Author:   dvarrazzo
Date:     2007-03-09 18:32:35 -0800 (Fri, 09 Mar 2007)

Log Message:
-----------
- Property accessor names contextualized.

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

Modified: trunk/epydoc/src/epydoc/docwriter/html.py
===================================================================
--- trunk/epydoc/src/epydoc/docwriter/html.py	2007-03-10 00:10:33 UTC (rev 1578)
+++ trunk/epydoc/src/epydoc/docwriter/html.py	2007-03-10 02:32:35 UTC (rev 1579)
@@ -2178,10 +2178,12 @@
         # Properties
         elif isinstance(var_doc.value, PropertyDoc):
             prop_doc = var_doc.value
-            accessors = [(name, self.property_accessor_to_html(val_doc),
-                          self.summary(val_doc)) for (name, val_doc) in
-                         [('Get', prop_doc.fget), ('Set', prop_doc.fset),
-                          ('Delete', prop_doc.fdel)]
+            accessors = [ (name,
+                           self.property_accessor_to_html(val_doc, prop_doc),
+                           self.summary(val_doc))
+                         for (name, val_doc) in
+                            [('Get', prop_doc.fget), ('Set', prop_doc.fset),
+                             ('Delete', prop_doc.fdel)]
                             if val_doc not in (None, UNKNOWN)
                             and val_doc.pyval is not None ]
 
@@ -2203,15 +2205,15 @@
 
         return '<li>%s - %s</li>' % (lhs, rhs)
 
-    def property_accessor_to_html(self, val_doc):
+    def property_accessor_to_html(self, val_doc, context=None):
         if val_doc not in (None, UNKNOWN):
             if isinstance(val_doc, RoutineDoc):
                 return self.function_signature(val_doc, is_summary=True,
-                                               link_name=True)
+                                               link_name=True, context=context)
             elif isinstance(val_doc, GenericValueDoc):
                 return self.pprint_value(val_doc)
             else:
-                return self.href(val_doc)
+                return self.href(val_doc, context=context)
         else:
             return '??'
         
@@ -2524,7 +2526,7 @@
     #////////////////////////////////////////////////////////////
 
     def function_signature(self, api_doc, is_summary=False, 
-                           link_name=False, anchor=False):
+                           link_name=False, anchor=False, context=None):
         """Render a function signature in HTML.
 
         @param api_doc: The object whose name is to be rendered. If a
@@ -2536,6 +2538,9 @@
         @type link_name: C{bool}
         @param anchor: If True, the name is the object anchor.
         @type anchor: C{bool}
+        @param context: If set, represent the function name from this context.
+            Only useful when C{api_doc} is a L{RoutineDoc}.
+        @type context: L{DottedName}
 
         @return: The HTML code for the object.
         @rtype: C{str}
@@ -2556,7 +2561,8 @@
                                      link_name=link_name, anchor=anchor)
         else:
             func_doc = api_doc
-            name = self.href(api_doc, css_class=css_class+'-name')
+            name = self.href(api_doc, css_class=css_class+'-name',
+                             context=context)
 
         if func_doc.posargs == UNKNOWN:
             args = ['...']


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