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