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

Fix links in method and properties summaries

Browse Source
This commit is contained in:
Robin Dunn
2016-05-24 01:37:11 -07:00
parent 0eff2654b5
commit ba5baabe77
2 changed files with 17 additions and 19 deletions
Download Patch File Download Diff File Expand all files Collapse all files

24
etg/_core.py
View File

@@ -310,17 +310,18 @@ def run():
module.addPyClass('CallLater', ['object'],
doc="""\
A convenience class for :class:`Timer`, that calls the given callable
A convenience class for :class:`wx.Timer`, that calls the given callable
object once after the given amount of milliseconds, passing any
positional or keyword args. The return value of the callable is
available after it has been run with the :meth:`~CallLater.GetResult` method.
available after it has been run with the :meth:`~wx.CallLater.GetResult`
method.
If you don't need to get the return value or restart the timer
then there is no need to hold a reference to this object. It will
hold a reference to itself while the timer is running (the timer
has a reference to :meth:`~CallLater.Notify`) but the cycle will be broken when
the timer completes, automatically cleaning up the :class:`CallLater`
object.
has a reference to :meth:`~wx.CallLater.Notify`) but the cycle will be
broken when the timer completes, automatically cleaning up the
:class:`wx.CallLater` object.
.. seealso::
:func:`wx.CallAfter`
@@ -329,12 +330,9 @@ def run():
items = [
PyFunctionDef('__init__', '(self, millis, callableObj, *args, **kwargs)',
doc="""\
A convenience class for :class:`Timer`, that calls the given callable
object once after the given amount of milliseconds, passing any
positional or keyword args. The return value of the callable is
available after it has been run with the :meth:`~CallLater.GetResult` method.
Constructs a new :class:`wx.CallLater` object.
:param int millis: number of milli seconds
:param int millis: number of milliseconds to delay until calling the callable object
:param PyObject callableObj: the callable object
:param args: arguments to be passed to the callable object
:param kw: keywords to be passed to the callable object
@@ -394,9 +392,9 @@ def run():
PyFunctionDef('SetArgs', '(self, *args, **kwargs)',
doc="""\
(Re)set the args passed to the callable object. This is
useful in conjunction with :meth:`Restart` if you want to schedule a
new call to the same callable object but with different
parameters.
useful in conjunction with :meth:`Start` if
you want to schedule a new call to the same callable
object but with different parameters.
:param args: arguments to be passed to the callable object
:param kw: keywords to be passed to the callable object

12
etgtools/sphinx_generator.py
View File

@@ -3162,24 +3162,24 @@ class SphinxGenerator(generators.DocsGeneratorBase):
item.sort_order = dispatch[item.__class__][1]
class_items = sorted(class_items, key=operator.attrgetter('sort_order', 'name'))
class_items = self.removeDuplicated(name, class_items)
class_items = self.removeDuplicated(fullname, class_items)
for item in class_items:
if isinstance(item, methods) and not self.IsFullyDeprecated(item):
method_name, simple_docs = self.getName(item)
self.current_class.method_list.append(('%s.%s'%(name, method_name), simple_docs))
self.current_class.method_list.append(('%s.%s'%(fullname, method_name), simple_docs))
elif isinstance(item, properties):
simple_docs = self.createPropertyLinks(name, item)
self.current_class.property_list.append(('%s.%s'%(name, item.name), simple_docs))
simple_docs = self.createPropertyLinks(fullname, item)
self.current_class.property_list.append(('%s.%s'%(fullname, item.name), simple_docs))
for item in ctors:
if item.isCtor:
method_name, simple_docs = self.getName(item)
self.current_class.method_list.insert(0, ('%s.__init__'%name, simple_docs))
self.current_class.method_list.insert(0, ('%s.__init__'%fullname, simple_docs))
docstring = XMLDocString(klass)
filename = "%s.txt" % imm.get_fullname(name)
filename = "%s.txt" % fullname
docstring.output_file = filename
docstring.current_module = self.current_module