Mercurial Repositories > eric / file diff

--- a/src/eric7/DocumentationTools/APIGenerator.py	Tue Dec 19 11:04:03 2023 +0100
+++ b/src/eric7/DocumentationTools/APIGenerator.py	Tue Dec 19 19:57:08 2023 +0100
@@ -17,7 +17,8 @@
         """
         Constructor
 
-        @param module The information of the parsed Python file.
+        @param module information of the parsed Python file
+        @type Module
         """
         self.module = module
 
@@ -25,10 +26,13 @@
         """
         Public method to generate the API information.
 
-        @param basePackage name of the base package (string)
+        @param basePackage name of the base package
+        @type str
         @param includePrivate flag indicating to include
-            private methods/functions (boolean)
-        @return API information (list of strings)
+            private methods/functions
+        @type bool
+        @return API information
+        @rtype list of str
         """
         self.includePrivate = includePrivate
         modulePath = self.module.name.split(".")
@@ -48,8 +52,9 @@
         Public method to generate the base classes information.
 
         @param includePrivate flag indicating to include private classes
-            (boolean)
-        @return base classes information (dictionary of list of strings)
+        @type bool
+        @return base classes information
+        @rtype dictionary of list of str
         """
         bases = {}
         self.includePrivate = includePrivate
@@ -69,7 +74,9 @@
         Private method to check, if an object is considered private.
 
         @param obj reference to the object to be checked
-        @return flag indicating, that object is considered private (boolean)
+        @type ModuleParser.Attribute, ModuleParser.Class or ModuleParser.Function
+        @return flag indicating, that object is considered private
+        @rtype bool
         """
         private = obj.isPrivate() and not self.includePrivate
         return private
@@ -108,7 +115,8 @@
         """
         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
+        @type str
         """
         from eric7.QScintilla.Editor import Editor
 
@@ -154,7 +162,7 @@
         Private method to generate class api section for class variables.
 
         @param className name of the class containing the class variables
-            (string)
+        @type str
         """
         from eric7.QScintilla.Editor import Editor