[Epydoc-commits] SF.net SVN: epydoc: [1801] trunk/epydoc/src/epydoc/cli.py

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

Revision: 1801
          http://epydoc.svn.sourceforge.net/epydoc/?rev=1801&view=rev
Author:   edloper
Date:     2008-02-26 16:20:24 -0800 (Tue, 26 Feb 2008)

Log Message:
-----------
- Fixed silly typo

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

Modified: trunk/epydoc/src/epydoc/cli.py
===================================================================
--- trunk/epydoc/src/epydoc/cli.py	2008-02-27 00:02:34 UTC (rev 1800)
+++ trunk/epydoc/src/epydoc/cli.py	2008-02-27 00:20:24 UTC (rev 1801)
@@ -776,6 +776,12 @@
 ######################################################################
 
 def main(options):
+    """
+    Perform all actions indicated by the given set of options.
+    
+    @return: the L{epydoc.apidoc.DocIndex} object created while
+        running epydoc (or None).
+    """
     # Set the debug flag, if '--debug' was specified.
     if options.debug:
         epydoc.DEBUG = True
@@ -982,6 +988,9 @@
 
     # Deregister our logger(s).
     for logger in loggers: log.remove_logger(logger)
+
+    # Return the docindex, in case someone wants to use it programatically.
+    return docindex
             
 def write_html(docindex, options):
     from epydoc.docwriter.html import HTMLWriter
@@ -1191,6 +1200,12 @@
     DocChecker(docindex).check()
                 
 def cli():
+    """
+    Perform all actions indicated by the options in sys.argv.
+    
+    @return: the L{epydoc.apidoc.DocIndex} object created while
+        running epydoc (or None).
+    """
     # Parse command-line arguments.
     options = parse_arguments()
 
@@ -1199,7 +1214,7 @@
             if options.profile:
                 _profile()
             else:
-                main(options)
+                return main(options)
         finally:
             log.close()
     except SystemExit:


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