DocumentationTools/APIGenerator.py

branch
Py2 comp.
changeset 3057
10516539f238
parent 2538
b2642e7a4c18
parent 2989
7efa8b8b6903
child 3060
5883ce99ee12
--- a/DocumentationTools/APIGenerator.py	Tue Oct 15 22:03:54 2013 +0200
+++ b/DocumentationTools/APIGenerator.py	Fri Oct 18 23:00:41 2013 +0200
@@ -5,7 +5,6 @@
 
 """
 Module implementing the builtin API generator.
-
 """
 
 
@@ -28,8 +27,8 @@
         """
         Public method to generate the API information.
         
-        @param newStyle flag indicating the api generation for QScintilla 1.7 and
-            newer (boolean) (ignored)
+        @param newStyle flag indicating the api generation for QScintilla 1.7
+            and newer (boolean) (ignored)
         @param basePackage name of the base package (string)
         @param includePrivate flag indicating to include
             private methods/functions (boolean)
@@ -52,7 +51,8 @@
         """
         Public method to generate the base classes information.
         
-        @param includePrivate flag indicating to include private classes (boolean)
+        @param includePrivate flag indicating to include private classes
+            (boolean)
         @return base classes information (dictionary of list of strings)
         """
         bases = {}
@@ -92,7 +92,8 @@
                     id = Editor.AttributeProtectedID
                 else:
                     id = Editor.AttributePrivateID
-                self.api.append("{0}{1}?{2:d}".format(moduleNameStr, globalName, id))
+                self.api.append("{0}{1}?{2:d}".format(
+                    moduleNameStr, globalName, id))
         
     def __addClassesAPI(self):
         """
@@ -108,7 +109,7 @@
         """
         Private method to generate the api section for class methods.
         
-        @param classname Name of the class containing the method. (string)
+        @param className name of the class containing the method (string)
         """
         from QScintilla.Editor import Editor
         
@@ -143,7 +144,8 @@
         """
         Private method to generate class api section for class variables.
         
-        @param classname Name of the class containing the class variables. (string)
+        @param className name of the class containing the class variables
+            (string)
         """
         from QScintilla.Editor import Editor
         
@@ -157,7 +159,8 @@
                     id = Editor.AttributeProtectedID
                 else:
                     id = Editor.AttributePrivateID
-                self.api.append('{0}{1}?{2:d}'.format(classNameStr, variable, id))
+                self.api.append('{0}{1}?{2:d}'.format(
+                    classNameStr, variable, id))
         
     def __addFunctionsAPI(self):
         """

eric ide

mercurial