Mercurial Repositories > eric / file comparison
comparison: DocumentationTools/ModuleDocumentor.py
DocumentationTools/ModuleDocumentor.py
- branch
- Py2 comp.
- changeset 3058
- 0a02c433f52d
- parent 3057
- 10516539f238
- parent 3021
- 801289962f4e
- child 3060
- 5883ce99ee12
equal
deleted
inserted
replaced
| 3057:10516539f238 | 3058:0a02c433f52d |
|---|---|
| 17 import re | 17 import re |
| 18 | 18 |
| 19 from Utilities import html_uencode | 19 from Utilities import html_uencode |
| 20 from Utilities.ModuleParser import RB_SOURCE, Function | 20 from Utilities.ModuleParser import RB_SOURCE, Function |
| 21 | 21 |
| 22 _signal = re.compile(r""" | 22 _signal = re.compile( |
| 23 r""" | |
| 23 ^@signal [ \t]+ | 24 ^@signal [ \t]+ |
| 24 (?P<SignalName1> | 25 (?P<SignalName1> |
| 25 [a-zA-Z_] \w* [ \t]* \( [^)]* \) | 26 [a-zA-Z_] \w* [ \t]* \( [^)]* \) |
| 26 ) | 27 ) |
| 27 [ \t]* (?P<SignalDescription1> .*) | 28 [ \t]* (?P<SignalDescription1> .*) |
| 31 [a-zA-Z_] \w* | 32 [a-zA-Z_] \w* |
| 32 ) | 33 ) |
| 33 [ \t]+ (?P<SignalDescription2> .*) | 34 [ \t]+ (?P<SignalDescription2> .*) |
| 34 """, re.VERBOSE | re.DOTALL | re.MULTILINE).search | 35 """, re.VERBOSE | re.DOTALL | re.MULTILINE).search |
| 35 | 36 |
| 36 _event = re.compile(r""" | 37 _event = re.compile( |
| 38 r""" | |
| 37 ^@event [ \t]+ | 39 ^@event [ \t]+ |
| 38 (?P<EventName1> | 40 (?P<EventName1> |
| 39 [a-zA-Z_] \w* [ \t]* \( [^)]* \) | 41 [a-zA-Z_] \w* [ \t]* \( [^)]* \) |
| 40 ) | 42 ) |
| 41 [ \t]* (?P<EventDescription1> .*) | 43 [ \t]* (?P<EventDescription1> .*) |
| 545 className, method)) | 547 className, method)) |
| 546 sys.stderr.write("{0}\n".format(e)) | 548 sys.stderr.write("{0}\n".format(e)) |
| 547 methBody = "" | 549 methBody = "" |
| 548 methBodies.append(methBody) | 550 methBodies.append(methBody) |
| 549 | 551 |
| 550 methList = self.__genMethodsListSection(methods, obj.methods, | 552 methList = self.__genMethodsListSection( |
| 551 className, obj.name, includeInit=filter == Function.General) | 553 methods, obj.methods, className, obj.name, |
| 554 includeInit=filter == Function.General) | |
| 552 | 555 |
| 553 if not methList: | 556 if not methList: |
| 554 methList = self.listEntryNoneTemplate | 557 methList = self.listEntryNoneTemplate |
| 555 return self.listTemplate.format(**{ \ | 558 return self.listTemplate.format(**{ \ |
| 556 'Entries': methList, | 559 'Entries': methList, |
| 1048 else: | 1051 else: |
| 1049 description = "" | 1052 description = "" |
| 1050 | 1053 |
| 1051 if paramList: | 1054 if paramList: |
| 1052 parameterSect = self.parametersListTemplate.format(**{ \ | 1055 parameterSect = self.parametersListTemplate.format(**{ \ |
| 1053 'Parameters': self.__genParamDescriptionListSection(paramList, | 1056 'Parameters': self.__genParamDescriptionListSection( |
| 1054 self.parametersListEntryTemplate) | 1057 paramList, self.parametersListEntryTemplate) |
| 1055 }) | 1058 }) |
| 1056 else: | 1059 else: |
| 1057 parameterSect = "" | 1060 parameterSect = "" |
| 1058 | 1061 |
| 1059 if returns: | 1062 if returns: |
| 1062 else: | 1065 else: |
| 1063 returnSect = "" | 1066 returnSect = "" |
| 1064 | 1067 |
| 1065 if exceptionDict: | 1068 if exceptionDict: |
| 1066 exceptionSect = self.exceptionsListTemplate.format(**{ \ | 1069 exceptionSect = self.exceptionsListTemplate.format(**{ \ |
| 1067 'Exceptions': self.__genDescriptionListSection(exceptionDict, | 1070 'Exceptions': self.__genDescriptionListSection( |
| 1068 self.exceptionsListEntryTemplate) | 1071 exceptionDict, self.exceptionsListEntryTemplate) |
| 1069 }) | 1072 }) |
| 1070 else: | 1073 else: |
| 1071 exceptionSect = "" | 1074 exceptionSect = "" |
| 1072 | 1075 |
| 1073 if signalDict: | 1076 if signalDict: |
| 1074 signalSect = self.signalsListTemplate.format(**{ \ | 1077 signalSect = self.signalsListTemplate.format(**{ \ |
| 1075 'Signals': self.__genDescriptionListSection(signalDict, | 1078 'Signals': self.__genDescriptionListSection( |
| 1076 self.signalsListEntryTemplate) | 1079 signalDict, self.signalsListEntryTemplate) |
| 1077 }) | 1080 }) |
| 1078 else: | 1081 else: |
| 1079 signalSect = "" | 1082 signalSect = "" |
| 1080 | 1083 |
| 1081 if eventDict: | 1084 if eventDict: |
| 1082 eventSect = self.eventsListTemplate.format(**{ \ | 1085 eventSect = self.eventsListTemplate.format(**{ \ |
| 1083 'Events': self.__genDescriptionListSection(eventDict, | 1086 'Events': self.__genDescriptionListSection( |
| 1084 self.eventsListEntryTemplate) | 1087 eventDict, self.eventsListEntryTemplate) |
| 1085 }) | 1088 }) |
| 1086 else: | 1089 else: |
| 1087 eventSect = "" | 1090 eventSect = "" |
| 1088 | 1091 |
| 1089 if deprecated: | 1092 if deprecated: |
