Lerking/Phoenix
1
0
Fork 0
mirror of https://github.com/wxWidgets/Phoenix.git synced 2026-01-07 20:40:11 +01:00
Code Issues Actions Packages Projects Releases Wiki Activity

Remove the version from deprecations from doxygen, fix helper method between multiple classes.

Browse Source
This commit is contained in:
Mesalu
2018-02-21 15:28:27 -08:00
parent bd1cd5a52b
commit f0b6cbdae4
2 changed files with 21 additions and 23 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
docs/sphinx/itemToModuleMap.json
View File

@@ -801,7 +801,7 @@
"DirProperty":"wx.propgrid.",
"DirSelector":"wx.",
"DirSelectorPromptStr":"wx.",
"Direction":"wx.DataObject.",
"Direction":"wx.",
"DisableAsserts":"wx.",
"Display":"wx.",
"DisplayChangedEvent":"wx.",

42
etgtools/sphinx_generator.py
View File

@@ -1067,7 +1067,7 @@ class Section(Node):
elif section_type == 'deprecated':
# Special treatment for deprecated, wxWidgets devs do not put the version number
text = '%s\n%s%s'%(VERSION, sub_spacer, text.lstrip('Deprecated'))
text = '\n%s%s'%(sub_spacer, text.lstrip('Deprecated'))
elif section_type == 'par':
# Horrible hack... Why is there a </para> end tag inside the @par tag???
@@ -2620,7 +2620,7 @@ class XMLDocString(object):
self.Reformat(stream)
self._dumpDeprecationDirective(method, stream, 6)
writeDeprecationDirective(method, stream, 6)
possible_py = self.HuntContributedSnippets()
@@ -2667,7 +2667,7 @@ class XMLDocString(object):
self.Reformat(stream)
self._dumpDeprecationDirective(function, stream, 3)
writeDeprecationDirective(function, stream, 3)
possible_py = self.HuntContributedSnippets()
@@ -2887,24 +2887,6 @@ class XMLDocString(object):
stream.write(docstrings + "\n\n")
# -----------------------------------------------------------------------
def _dumpDeprecationDirective(self, defobj, stream, spacing):
"""
Writes the deprecation directive to the stream if necesseary.
:param BaseDef defobj: The extractor object that is potentially deprecated
:param stream: The IO stream to write to
:param spacing: indicates how much to pad the directive by, in number of spaces.
"""
# all BaseDefs have deprecated now:
dep = defobj.deprecated
if dep and isinstance(dep, string_base):
directive = "{space_a}.. wxdeprecated::\n{space_b}{message}".format(space_a = ' ' * spacing,
space_b = ' ' * (spacing + 3),
message = dep)
# ---------------------------------------------------------------------------
class SphinxGenerator(generators.DocsGeneratorBase):
@@ -3340,7 +3322,7 @@ class SphinxGenerator(generators.DocsGeneratorBase):
stream.write(newdocs + '\n\n')
self._dumpDeprecationDirective(pm, stream, 6)
writeDeprecationDirective(pm, stream, 6)
c = self.current_class
name = c.pyName if c.pyName else removeWxPrefix(c.name)
@@ -3622,4 +3604,20 @@ def guessTypeStr(v):
return True
return False
def writeDeprecationDirective(defobj, stream, spacing):
"""
Writes the deprecation directive to the stream if necesseary.
:param BaseDef defobj: The extractor object that is potentially deprecated
:param stream: The IO stream to write to
:param spacing: indicates how much to pad the directive by, in number of spaces.
"""
# all BaseDefs have deprecated now:
dep = defobj.deprecated
if dep and isinstance(dep, string_base):
directive = "{space_a}.. wxdeprecated::\n{space_b}{message}".format(space_a = ' ' * spacing,
space_b = ' ' * (spacing + 3),
message = dep)
# ---------------------------------------------------------------------------