Mercurial Repositories > eric / file comparison
comparison: eric6/DocumentationTools/ModuleDocumentor.py
eric6/DocumentationTools/ModuleDocumentor.py
- changeset 8230
- 8b5c6896655b
- parent 8207
- d359172d11be
- child 8243
- cc717c2ae956
equal
deleted
inserted
replaced
| 8229:6fa22aa4fc4a | 8230:8b5c6896655b |
|---|---|
| 329 self.__getShortDescription(sectionDict[name].description), | 329 self.__getShortDescription(sectionDict[name].description), |
| 330 'Deprecated': | 330 'Deprecated': |
| 331 self.__checkDeprecated(sectionDict[name].description) and | 331 self.__checkDeprecated(sectionDict[name].description) and |
| 332 self.listEntryDeprecatedTemplate or "", | 332 self.listEntryDeprecatedTemplate or "", |
| 333 })) | 333 })) |
| 334 if kwSuffix: | 334 n = ("{0} ({1})".format(name, kwSuffix) if kwSuffix |
| 335 n = "{0} ({1})".format(name, kwSuffix) | 335 else "{0}".format(name)) |
| 336 else: | |
| 337 n = "{0}".format(name) | |
| 338 self.keywords.append((n, "#{0}".format(name))) | 336 self.keywords.append((n, "#{0}".format(name))) |
| 339 return ''.join(lst) | 337 return ''.join(lst) |
| 340 | 338 |
| 341 def __genGlobalsListSection(self, class_=None): | 339 def __genGlobalsListSection(self, class_=None): |
| 342 """ | 340 """ |
| 345 | 343 |
| 346 @param class_ reference to a class object (Class) | 344 @param class_ reference to a class object (Class) |
| 347 @return The globals list section. (string) | 345 @return The globals list section. (string) |
| 348 """ | 346 """ |
| 349 attrNames = [] | 347 attrNames = [] |
| 350 if class_ is not None: | 348 scope = class_ if class_ is not None else self.module |
| 351 scope = class_ | |
| 352 else: | |
| 353 scope = self.module | |
| 354 attrNames = sorted(attr for attr in scope.globals.keys() | 349 attrNames = sorted(attr for attr in scope.globals.keys() |
| 355 if not scope.globals[attr].isSignal) | 350 if not scope.globals[attr].isSignal) |
| 356 if attrNames: | 351 if attrNames: |
| 357 s = ''.join( | 352 s = ''.join( |
| 358 [self.listEntrySimpleTemplate.format(**{'Name': name}) | 353 [self.listEntrySimpleTemplate.format(**{'Name': name}) |
| 416 classNames = sorted(list(self.module.classes.keys())) | 411 classNames = sorted(list(self.module.classes.keys())) |
| 417 classes = [] | 412 classes = [] |
| 418 for className in classNames: | 413 for className in classNames: |
| 419 _class = self.module.classes[className] | 414 _class = self.module.classes[className] |
| 420 supers = _class.super | 415 supers = _class.super |
| 421 if len(supers) > 0: | 416 supers = ', '.join(supers) if len(supers) > 0 else "None" |
| 422 supers = ', '.join(supers) | |
| 423 else: | |
| 424 supers = 'None' | |
| 425 | 417 |
| 426 globalsList = self.__genGlobalsListSection(_class) | 418 globalsList = self.__genGlobalsListSection(_class) |
| 427 classMethList, classMethBodies = self.__genMethodSection( | 419 classMethList, classMethBodies = self.__genMethodSection( |
| 428 _class, className, Function.Class) | 420 _class, className, Function.Class) |
| 429 methList, methBodies = self.__genMethodSection( | 421 methList, methBodies = self.__genMethodSection( |
| 631 classNames = sorted(list(obj.classes.keys())) | 623 classNames = sorted(list(obj.classes.keys())) |
| 632 classes = [] | 624 classes = [] |
| 633 for className in classNames: | 625 for className in classNames: |
| 634 _class = obj.classes[className] | 626 _class = obj.classes[className] |
| 635 supers = _class.super | 627 supers = _class.super |
| 636 if len(supers) > 0: | 628 supers = ', '.join(supers) if len(supers) > 0 else "None" |
| 637 supers = ', '.join(supers) | |
| 638 else: | |
| 639 supers = 'None' | |
| 640 | 629 |
| 641 methList, methBodies = self.__genMethodSection( | 630 methList, methBodies = self.__genMethodSection( |
| 642 _class, className, Function.General) | 631 _class, className, Function.General) |
| 643 | 632 |
| 644 try: | 633 try: |
| 1165 else: | 1154 else: |
| 1166 lastItem.append(ditem) | 1155 lastItem.append(ditem) |
| 1167 elif not inTagSection: | 1156 elif not inTagSection: |
| 1168 lastItem.append(ditem) | 1157 lastItem.append(ditem) |
| 1169 | 1158 |
| 1170 if paragraphs: | 1159 description = self.__genParagraphs(paragraphs) if paragraphs else "" |
| 1171 description = self.__genParagraphs(paragraphs) | |
| 1172 else: | |
| 1173 description = "" | |
| 1174 | 1160 |
| 1175 if paramList: | 1161 if paramList: |
| 1176 parameterSect = self.parametersListTemplate.format( | 1162 parameterSect = self.parametersListTemplate.format( |
| 1177 **{'Parameters': self.__genParamDescriptionListSection( | 1163 **{'Parameters': self.__genParamDescriptionListSection( |
| 1178 paramList)}) | 1164 paramList)}) |
