[Epydoc-commits] SF.net SVN: epydoc: [1675] trunk/epydoc/src/epydoc/apidoc.py

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

Revision: 1675
          http://epydoc.svn.sourceforge.net/epydoc/?rev=1675&view=rev
Author:   edloper
Date:     2008-01-29 09:12:56 -0800 (Tue, 29 Jan 2008)

Log Message:
-----------
- Added 'overrides' filter, which is False by default.

Modified Paths:
--------------
    trunk/epydoc/src/epydoc/apidoc.py

Modified: trunk/epydoc/src/epydoc/apidoc.py
===================================================================
--- trunk/epydoc/src/epydoc/apidoc.py	2008-01-29 06:03:36 UTC (rev 1674)
+++ trunk/epydoc/src/epydoc/apidoc.py	2008-01-29 17:12:56 UTC (rev 1675)
@@ -544,6 +544,8 @@
           - C{subclasses}: Subclasses for classes.
           - C{variables}: All variables.
           - C{private}: Private variables.
+          - C{overrides}: Points from class variables to the variables
+            they override.  This filter is False by default.
         """
         return []
 
@@ -677,10 +679,16 @@
     of the variable's container.""")
 
     def apidoc_links(self, **filters):
+        # nb: overrides filter is *False* by default.
+        if (filters.get('overrides', False) and
+            (self.overrides not in (None, UNKNOWN))):
+            overrides = [self.overrides]
+        else:
+            overrides = []
         if self.value in (None, UNKNOWN):
-            return []
+            return []+overrides
         else:
-            return [self.value]
+            return [self.value]+overrides
 
     def is_detailed(self):
         pval = super(VariableDoc, self).is_detailed()


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