DocumentationTools/ModuleDocumentor.py

changeset 2953
703452a2876f
parent 2401
4f428de32b69
child 2956
615dbd8a696a
--- a/DocumentationTools/ModuleDocumentor.py	Sat Sep 28 17:40:42 2013 +0200
+++ b/DocumentationTools/ModuleDocumentor.py	Sat Sep 28 19:06:25 2013 +0200
@@ -50,6 +50,7 @@
     """
     Exception class raised, if an invalid documentation tag was found.
     """
+    pass
 
 
 class ModuleDocument(object):
@@ -689,8 +690,8 @@
         Private method to check, if the object to be documented contains a
         deprecated flag.
         
-        @param desc The documentation string. (string)
-        @return Flag indicating the deprecation status. (boolean)
+        @param descr documentation string (string)
+        @return flag indicating the deprecation status (boolean)
         """
         dlist = descr.splitlines()
         for desc in dlist:
@@ -819,6 +820,7 @@
         
         @param desc One line of the description (string)
         @return processed line with inline tags expanded (string)
+        @exception TagError raised to indicate an invalid tag
         """
         start = desc.find('{@')
         while start != -1:

eric ide

mercurial