diff -r bc5b1b00560a -r c5e3705073eb eric6/DocumentationTools/ModuleDocumentor.py
--- a/eric6/DocumentationTools/ModuleDocumentor.py Sat Sep 21 13:37:58 2019 +0200
+++ b/eric6/DocumentationTools/ModuleDocumentor.py Sat Sep 21 15:37:43 2019 +0200
@@ -82,120 +82,120 @@
self.rbFileTemplate = TemplatesListsStyleCSS.rbFileTemplate
self.classTemplate = TemplatesListsStyleCSS.classTemplate
self.methodTemplate = TemplatesListsStyleCSS.methodTemplate
- self.constructorTemplate = \
- TemplatesListsStyleCSS.constructorTemplate
+ self.constructorTemplate = (
+ TemplatesListsStyleCSS.constructorTemplate)
self.rbModuleTemplate = TemplatesListsStyleCSS.rbModuleTemplate
- self.rbModulesClassTemplate = \
- TemplatesListsStyleCSS.rbModulesClassTemplate
+ self.rbModulesClassTemplate = (
+ TemplatesListsStyleCSS.rbModulesClassTemplate)
self.functionTemplate = TemplatesListsStyleCSS.functionTemplate
self.listTemplate = TemplatesListsStyleCSS.listTemplate
self.listEntryTemplate = TemplatesListsStyleCSS.listEntryTemplate
- self.listEntryNoneTemplate = \
- TemplatesListsStyleCSS.listEntryNoneTemplate
- self.listEntryDeprecatedTemplate = \
- TemplatesListsStyleCSS.listEntryDeprecatedTemplate
- self.listEntrySimpleTemplate = \
- TemplatesListsStyleCSS.listEntrySimpleTemplate
+ self.listEntryNoneTemplate = (
+ TemplatesListsStyleCSS.listEntryNoneTemplate)
+ self.listEntryDeprecatedTemplate = (
+ TemplatesListsStyleCSS.listEntryDeprecatedTemplate)
+ self.listEntrySimpleTemplate = (
+ TemplatesListsStyleCSS.listEntrySimpleTemplate)
self.paragraphTemplate = TemplatesListsStyleCSS.paragraphTemplate
- self.parametersListTemplate = \
- TemplatesListsStyleCSS.parametersListTemplate
- self.parameterTypesListEntryTemplate = \
- TemplatesListsStyleCSS.parameterTypesListEntryTemplate
- self.parametersListEntryTemplate = \
- TemplatesListsStyleCSS.parametersListEntryTemplate
+ self.parametersListTemplate = (
+ TemplatesListsStyleCSS.parametersListTemplate)
+ self.parameterTypesListEntryTemplate = (
+ TemplatesListsStyleCSS.parameterTypesListEntryTemplate)
+ self.parametersListEntryTemplate = (
+ TemplatesListsStyleCSS.parametersListEntryTemplate)
self.returnsTemplate = TemplatesListsStyleCSS.returnsTemplate
- self.returnTypesTemplate = \
- TemplatesListsStyleCSS.returnTypesTemplate
- self.exceptionsListTemplate = \
- TemplatesListsStyleCSS.exceptionsListTemplate
- self.exceptionsListEntryTemplate = \
- TemplatesListsStyleCSS.exceptionsListEntryTemplate
- self.signalsListTemplate = \
- TemplatesListsStyleCSS.signalsListTemplate
- self.signalsListEntryTemplate = \
- TemplatesListsStyleCSS.signalsListEntryTemplate
+ self.returnTypesTemplate = (
+ TemplatesListsStyleCSS.returnTypesTemplate)
+ self.exceptionsListTemplate = (
+ TemplatesListsStyleCSS.exceptionsListTemplate)
+ self.exceptionsListEntryTemplate = (
+ TemplatesListsStyleCSS.exceptionsListEntryTemplate)
+ self.signalsListTemplate = (
+ TemplatesListsStyleCSS.signalsListTemplate)
+ self.signalsListEntryTemplate = (
+ TemplatesListsStyleCSS.signalsListEntryTemplate)
self.eventsListTemplate = TemplatesListsStyleCSS.eventsListTemplate
- self.eventsListEntryTemplate = \
- TemplatesListsStyleCSS.eventsListEntryTemplate
+ self.eventsListEntryTemplate = (
+ TemplatesListsStyleCSS.eventsListEntryTemplate)
self.deprecatedTemplate = TemplatesListsStyleCSS.deprecatedTemplate
self.authorInfoTemplate = TemplatesListsStyleCSS.authorInfoTemplate
self.seeListTemplate = TemplatesListsStyleCSS.seeListTemplate
- self.seeListEntryTemplate = \
- TemplatesListsStyleCSS.seeListEntryTemplate
+ self.seeListEntryTemplate = (
+ TemplatesListsStyleCSS.seeListEntryTemplate)
self.seeLinkTemplate = TemplatesListsStyleCSS.seeLinkTemplate
self.sinceInfoTemplate = TemplatesListsStyleCSS.sinceInfoTemplate
else:
from . import TemplatesListsStyle
- self.headerTemplate = \
- TemplatesListsStyle.headerTemplate.format(**colors)
- self.footerTemplate = \
- TemplatesListsStyle.footerTemplate.format(**colors)
- self.moduleTemplate = \
- TemplatesListsStyle.moduleTemplate.format(**colors)
- self.rbFileTemplate = \
- TemplatesListsStyle.rbFileTemplate.format(**colors)
- self.classTemplate = \
- TemplatesListsStyle.classTemplate.format(**colors)
- self.methodTemplate = \
- TemplatesListsStyle.methodTemplate.format(**colors)
- self.constructorTemplate = \
- TemplatesListsStyle.constructorTemplate.format(**colors)
- self.rbModuleTemplate = \
- TemplatesListsStyle.rbModuleTemplate.format(**colors)
- self.rbModulesClassTemplate = \
- TemplatesListsStyle.rbModulesClassTemplate.format(**colors)
- self.functionTemplate = \
- TemplatesListsStyle.functionTemplate.format(**colors)
- self.listTemplate = \
- TemplatesListsStyle.listTemplate.format(**colors)
- self.listEntryTemplate = \
- TemplatesListsStyle.listEntryTemplate.format(**colors)
- self.listEntryNoneTemplate = \
- TemplatesListsStyle.listEntryNoneTemplate.format(**colors)
- self.listEntryDeprecatedTemplate = \
+ self.headerTemplate = (
+ TemplatesListsStyle.headerTemplate.format(**colors))
+ self.footerTemplate = (
+ TemplatesListsStyle.footerTemplate.format(**colors))
+ self.moduleTemplate = (
+ TemplatesListsStyle.moduleTemplate.format(**colors))
+ self.rbFileTemplate = (
+ TemplatesListsStyle.rbFileTemplate.format(**colors))
+ self.classTemplate = (
+ TemplatesListsStyle.classTemplate.format(**colors))
+ self.methodTemplate = (
+ TemplatesListsStyle.methodTemplate.format(**colors))
+ self.constructorTemplate = (
+ TemplatesListsStyle.constructorTemplate.format(**colors))
+ self.rbModuleTemplate = (
+ TemplatesListsStyle.rbModuleTemplate.format(**colors))
+ self.rbModulesClassTemplate = (
+ TemplatesListsStyle.rbModulesClassTemplate.format(**colors))
+ self.functionTemplate = (
+ TemplatesListsStyle.functionTemplate.format(**colors))
+ self.listTemplate = (
+ TemplatesListsStyle.listTemplate.format(**colors))
+ self.listEntryTemplate = (
+ TemplatesListsStyle.listEntryTemplate.format(**colors))
+ self.listEntryNoneTemplate = (
+ TemplatesListsStyle.listEntryNoneTemplate.format(**colors))
+ self.listEntryDeprecatedTemplate = (
TemplatesListsStyle.listEntryDeprecatedTemplate.format(
- **colors)
- self.listEntrySimpleTemplate = \
- TemplatesListsStyle.listEntrySimpleTemplate.format(**colors)
- self.paragraphTemplate = \
- TemplatesListsStyle.paragraphTemplate.format(**colors)
- self.parametersListTemplate = \
- TemplatesListsStyle.parametersListTemplate.format(**colors)
- self.parametersListEntryTemplate = \
+ **colors))
+ self.listEntrySimpleTemplate = (
+ TemplatesListsStyle.listEntrySimpleTemplate.format(**colors))
+ self.paragraphTemplate = (
+ TemplatesListsStyle.paragraphTemplate.format(**colors))
+ self.parametersListTemplate = (
+ TemplatesListsStyle.parametersListTemplate.format(**colors))
+ self.parametersListEntryTemplate = (
TemplatesListsStyle.parametersListEntryTemplate.format(
- **colors)
- self.parameterTypesListEntryTemplate = \
+ **colors))
+ self.parameterTypesListEntryTemplate = (
TemplatesListsStyle.parameterTypesListEntryTemplate.format(
- **colors)
- self.returnsTemplate = \
- TemplatesListsStyle.returnsTemplate.format(**colors)
- self.returnTypesTemplate = \
- TemplatesListsStyle.returnTypesTemplate.format(**colors)
- self.exceptionsListTemplate = \
- TemplatesListsStyle.exceptionsListTemplate.format(**colors)
- self.exceptionsListEntryTemplate = \
+ **colors))
+ self.returnsTemplate = (
+ TemplatesListsStyle.returnsTemplate.format(**colors))
+ self.returnTypesTemplate = (
+ TemplatesListsStyle.returnTypesTemplate.format(**colors))
+ self.exceptionsListTemplate = (
+ TemplatesListsStyle.exceptionsListTemplate.format(**colors))
+ self.exceptionsListEntryTemplate = (
TemplatesListsStyle.exceptionsListEntryTemplate.format(
- **colors)
- self.signalsListTemplate = \
- TemplatesListsStyle.signalsListTemplate.format(**colors)
- self.signalsListEntryTemplate = \
- TemplatesListsStyle.signalsListEntryTemplate.format(**colors)
- self.eventsListTemplate = \
- TemplatesListsStyle.eventsListTemplate.format(**colors)
- self.eventsListEntryTemplate = \
- TemplatesListsStyle.eventsListEntryTemplate.format(**colors)
- self.deprecatedTemplate = \
- TemplatesListsStyle.deprecatedTemplate.format(**colors)
- self.authorInfoTemplate = \
- TemplatesListsStyle.authorInfoTemplate.format(**colors)
- self.seeListTemplate = \
- TemplatesListsStyle.seeListTemplate.format(**colors)
- self.seeListEntryTemplate = \
- TemplatesListsStyle.seeListEntryTemplate.format(**colors)
- self.seeLinkTemplate = \
- TemplatesListsStyle.seeLinkTemplate.format(**colors)
- self.sinceInfoTemplate = \
- TemplatesListsStyle.sinceInfoTemplate.format(**colors)
+ **colors))
+ self.signalsListTemplate = (
+ TemplatesListsStyle.signalsListTemplate.format(**colors))
+ self.signalsListEntryTemplate = (
+ TemplatesListsStyle.signalsListEntryTemplate.format(**colors))
+ self.eventsListTemplate = (
+ TemplatesListsStyle.eventsListTemplate.format(**colors))
+ self.eventsListEntryTemplate = (
+ TemplatesListsStyle.eventsListEntryTemplate.format(**colors))
+ self.deprecatedTemplate = (
+ TemplatesListsStyle.deprecatedTemplate.format(**colors))
+ self.authorInfoTemplate = (
+ TemplatesListsStyle.authorInfoTemplate.format(**colors))
+ self.seeListTemplate = (
+ TemplatesListsStyle.seeListTemplate.format(**colors))
+ self.seeListEntryTemplate = (
+ TemplatesListsStyle.seeListEntryTemplate.format(**colors))
+ self.seeLinkTemplate = (
+ TemplatesListsStyle.seeLinkTemplate.format(**colors))
+ self.sinceInfoTemplate = (
+ TemplatesListsStyle.sinceInfoTemplate.format(**colors))
self.keywords = []
# list of tuples containing the name (string) and
@@ -245,11 +245,14 @@
@return The source code documentation. (string)
"""
- doc = self.headerTemplate.format(
- **{'Title': self.module.name,
- 'Style': self.stylesheet}) + \
- self.__genModuleSection() + \
+ doc = (
+ self.headerTemplate.format(
+ **{'Title': self.module.name,
+ 'Style': self.stylesheet}
+ ) +
+ self.__genModuleSection() +
self.footerTemplate
+ )
self.generated = True
return doc
@@ -415,12 +418,12 @@
supers = 'None'
globalsList = self.__genGlobalsListSection(_class)
- classMethList, classMethBodies = \
- self.__genMethodSection(_class, className, Function.Class)
- methList, methBodies = \
- self.__genMethodSection(_class, className, Function.General)
- staticMethList, staticMethBodies = \
- self.__genMethodSection(_class, className, Function.Static)
+ classMethList, classMethBodies = self.__genMethodSection(
+ _class, className, Function.Class)
+ methList, methBodies = self.__genMethodSection(
+ _class, className, Function.General)
+ staticMethList, staticMethBodies = self.__genMethodSection(
+ _class, className, Function.Static)
try:
clsBody = self.classTemplate.format(
@@ -629,8 +632,8 @@
else:
supers = 'None'
- methList, methBodies = \
- self.__genMethodSection(_class, className, Function.General)
+ methList, methBodies = self.__genMethodSection(
+ _class, className, Function.General)
try:
clsBody = self.rbModulesClassTemplate.format(
@@ -740,8 +743,10 @@
if dotpos == -1:
sdlist.append(desc.strip())
else:
- while dotpos + 1 < len(desc) and \
- not desc[dotpos + 1].isspace():
+ while (
+ dotpos + 1 < len(desc) and
+ not desc[dotpos + 1].isspace()
+ ):
# don't recognize '.' inside a number or word as
# stop condition
dotpos = desc.find('.', dotpos + 1)
@@ -1045,10 +1050,13 @@
m = _signal(desc, 0)
if m is None:
raise TagError("Wrong format in @signal line.\n")
- signalName = 1 and m.group("SignalName1") \
- or m.group("SignalName2")
- signalDesc = 1 and m.group("SignalDescription1") \
- or m.group("SignalDescription2")
+ signalName = (
+ 1 and m.group("SignalName1") or m.group("SignalName2")
+ )
+ signalDesc = (
+ 1 and m.group("SignalDescription1") or
+ m.group("SignalDescription2")
+ )
signalDict[signalName] = []
if signalDesc is not None:
signalDict[signalName].append(signalDesc)
@@ -1060,10 +1068,13 @@
if m is None:
raise TagError(
"Wrong format in {0} line.\n".format(parts[0]))
- eventName = 1 and m.group("EventName1") \
- or m.group("EventName2")
- eventDesc = 1 and m.group("EventDescription1") \
- or m.group("EventDescription2")
+ eventName = (
+ 1 and m.group("EventName1") or m.group("EventName2")
+ )
+ eventDesc = (
+ 1 and m.group("EventDescription1") or
+ m.group("EventDescription2")
+ )
eventDict[eventName] = []
if eventDesc is not None:
eventDict[eventName].append(eventDesc)
