diff -r 2fe91fe443dd -r 328f3ec4b77a src/eric7/Utilities/ClassBrowsers/pyclbr.py
--- a/src/eric7/Utilities/ClassBrowsers/pyclbr.py Thu Dec 21 15:46:22 2023 +0100
+++ b/src/eric7/Utilities/ClassBrowsers/pyclbr.py Thu Dec 21 19:50:01 2023 +0100
@@ -183,10 +183,15 @@
Constructor
@param module name of the module containing this class
+ @type str
@param name name of this class
+ @type str
@param superClasses list of class names this class is inherited from
+ @type list of str
@param file filename containing this class
+ @type str
@param lineno linenumber of the class definition
+ @type int
"""
ClbrBaseClasses.Class.__init__(self, module, name, superClasses, file, lineno)
VisibilityMixin.__init__(self)
@@ -212,13 +217,21 @@
Constructor
@param module name of the module containing this function
+ @type str
@param name name of this function
+ @type str
@param file filename containing this class
+ @type str
@param lineno linenumber of the class definition
+ @type int
@param signature parameterlist of the method
+ @type str
@param separator string separating the parameters
+ @type str
@param modifierType type of the function
+ @type int
@param annotation return annotation
+ @type str
"""
ClbrBaseClasses.Function.__init__(
self,
@@ -244,9 +257,13 @@
Constructor
@param module name of the module containing this class
+ @type str
@param name name of this class
+ @type str
@param file filename containing this attribute
+ @type str
@param lineno linenumber of the class definition
+ @type int
"""
ClbrBaseClasses.Attribute.__init__(self, module, name, file, lineno)
VisibilityMixin.__init__(self)
@@ -274,8 +291,10 @@
"""
Constructor
- @param module name of the module containing the import (string)
- @param file file name containing the import (string)
+ @param module name of the module containing the import
+ @type str
+ @param file file name containing the import
+ @type str
"""
self.module = module
self.name = "import"
@@ -286,9 +305,12 @@
"""
Public method to add a list of imported names.
- @param moduleName name of the imported module (string)
- @param names list of names (list of strings)
+ @param moduleName name of the imported module
+ @type str
+ @param names list of names
+ @type list of str
@param lineno line number of the import
+ @type int
"""
if moduleName not in self.imports:
module = ImportedModule(self.module, self.file, moduleName)
@@ -301,8 +323,10 @@
"""
Public method to get an imported module item.
- @param moduleName name of the imported module (string)
- @return imported module item (ImportedModule) or None
+ @param moduleName name of the imported module
+ @type str
+ @return imported module item
+ @rtype ImportedModule
"""
if moduleName in self.imports:
return self.imports[moduleName]
@@ -315,6 +339,7 @@
@return dictionary of imported module names with name as key and list
of line numbers of imports as value
+ @rtype dict
"""
return self.imports
@@ -328,9 +353,12 @@
"""
Constructor
- @param module name of the module containing the import (string)
- @param file file name containing the import (string)
- @param importedModule name of the imported module (string)
+ @param module name of the module containing the import
+ @type str
+ @param file file name containing the import
+ @type str
+ @param importedModule name of the imported module
+ @type str
"""
self.module = module
self.name = "import"
@@ -346,7 +374,9 @@
Public method to add a list of imported names.
@param lineno line number of the import
- @param importedNames list of imported names (list of strings)
+ @type int
+ @param importedNames list of imported names
+ @type list of str
"""
if lineno not in self.linenos:
self.linenos.append(lineno)
@@ -782,7 +812,9 @@
"""
Module function to return the indentation depth.
- @param ws the whitespace to be checked (string)
- @return length of the whitespace string (integer)
+ @param ws the whitespace to be checked
+ @type str
+ @return length of the whitespace string
+ @rtype int
"""
return len(ws.expandtabs(TABWIDTH))
