eric7/DocumentationTools/APIGenerator.py

branch
eric7
changeset 8761
f05818ae6431
parent 8312
800c432b34c8
child 8881
54e42bc2437a
equal deleted inserted replaced
8760:8f3ee84ae342 8761:f05818ae6431
52 (boolean) 52 (boolean)
53 @return base classes information (dictionary of list of strings) 53 @return base classes information (dictionary of list of strings)
54 """ 54 """
55 bases = {} 55 bases = {}
56 self.includePrivate = includePrivate 56 self.includePrivate = includePrivate
57 classNames = sorted(list(self.module.classes.keys())) 57 classNames = sorted(self.module.classes.keys())
58 for className in classNames: 58 for className in classNames:
59 if ( 59 if (
60 not self.__isPrivate(self.module.classes[className]) and 60 not self.__isPrivate(self.module.classes[className]) and
61 className not in bases 61 className not in bases
62 ): 62 ):
96 96
97 def __addClassesAPI(self): 97 def __addClassesAPI(self):
98 """ 98 """
99 Private method to generate the api section for classes. 99 Private method to generate the api section for classes.
100 """ 100 """
101 classNames = sorted(list(self.module.classes.keys())) 101 classNames = sorted(self.module.classes.keys())
102 for className in classNames: 102 for className in classNames:
103 if not self.__isPrivate(self.module.classes[className]): 103 if not self.__isPrivate(self.module.classes[className]):
104 self.__addClassVariablesAPI(className) 104 self.__addClassVariablesAPI(className)
105 self.__addMethodsAPI(className) 105 self.__addMethodsAPI(className)
106 106
111 @param className name of the class containing the method (string) 111 @param className name of the class containing the method (string)
112 """ 112 """
113 from QScintilla.Editor import Editor 113 from QScintilla.Editor import Editor
114 114
115 _class = self.module.classes[className] 115 _class = self.module.classes[className]
116 methods = sorted(list(_class.methods.keys())) 116 methods = sorted(_class.methods.keys())
117 if '__init__' in methods: 117 if '__init__' in methods:
118 methods.remove('__init__') 118 methods.remove('__init__')
119 if _class.isPublic(): 119 if _class.isPublic():
120 iconId = Editor.ClassID 120 iconId = Editor.ClassID
121 elif _class.isProtected(): 121 elif _class.isProtected():
167 """ 167 """
168 Private method to generate the api section for functions. 168 Private method to generate the api section for functions.
169 """ 169 """
170 from QScintilla.Editor import Editor 170 from QScintilla.Editor import Editor
171 171
172 funcNames = sorted(list(self.module.functions.keys())) 172 funcNames = sorted(self.module.functions.keys())
173 for funcName in funcNames: 173 for funcName in funcNames:
174 if not self.__isPrivate(self.module.functions[funcName]): 174 if not self.__isPrivate(self.module.functions[funcName]):
175 if self.module.functions[funcName].isPublic(): 175 if self.module.functions[funcName].isPublic():
176 iconId = Editor.MethodID 176 iconId = Editor.MethodID
177 elif self.module.functions[funcName].isProtected(): 177 elif self.module.functions[funcName].isProtected():

eric ide

mercurial