class documentation
class ZopeInterfaceFunction(model.Function, extensions.FunctionMixin): (source)
Constructor: ZopeInterfaceFunction(system, name, parent, source_path)
Undocumented
Method | docsources |
Objects that can be considered as a source of documentation. |
Inherited from Function
:
Method | setup |
Undocumented |
Class Variable | annotations |
Undocumented |
Class Variable | decorators |
Undocumented |
Class Variable | is |
Undocumented |
Instance Variable | kind |
Undocumented |
Instance Variable | overloads |
Undocumented |
Instance Variable | signature |
Undocumented |
Inherited from Inheritable
(via Function
):
Method | is |
Is the given name defined in the globals/locals of self-context? Only the first name of a dotted name is checked. |
Instance Variable | parent |
Undocumented |
Method | _local |
Undocumented |
Inherited from Documentable
(via Function
, Inheritable
):
Method | __init__ |
Undocumented |
Method | __repr__ |
Undocumented |
Method | expand |
Like expandName but gives precedence to the module scope when a name is defined both in the current scope and the module scope. |
Method | expand |
Return a fully qualified name for the possibly-dotted `name`. |
Method | full |
Undocumented |
Method | reparent |
Undocumented |
Method | report |
Log an error or warning about this documentable object. |
Method | resolve |
Return the object named by "name" (using Python's lookup rules) in this context, if any is known to pydoctor. |
Method | set |
Undocumented |
Method | set |
Save the linenumber of this object. |
Class Variable | parsed |
Undocumented |
Class Variable | parsed |
Undocumented |
Instance Variable | contents |
Undocumented |
Instance Variable | docstring |
The object's docstring. But also see docsources. |
Instance Variable | docstring |
Undocumented |
Instance Variable | extra |
A list to store extra informations about this documentable, as ParsedDocstring . |
Instance Variable | linenumber |
Undocumented |
Instance Variable | name |
Undocumented |
Instance Variable | parent |
Undocumented |
Instance Variable | parsed |
Undocumented |
Instance Variable | source |
Undocumented |
Instance Variable | source |
Undocumented |
Instance Variable | system |
The system the object is part of. |
Property | description |
A string describing our source location to the user. |
Property | docstring |
Returns an instance of DocstringLinker suitable for resolving names in the context of the object. |
Property | doctarget |
Undocumented |
Property | is |
Is this object considered private API? |
Property | is |
Is this object so private as to be not shown at all? |
Property | module |
This object's Module . |
Property | page |
The documentable to which the page we're documented on belongs. For example methods are documented on the page of their class, functions are documented in their module's page etc. |
Property | privacy |
How visible this object should be. |
Property | url |
Relative URL at which the documentation for this Documentable can be found. |
Method | _handle |
Undocumented |
Method | _handle |
Undocumented |
Method | _set |
Undocumented |
Instance Variable | _linker |
Undocumented |
overrides
pydoctor.model.Inheritable.docsources
Objects that can be considered as a source of documentation.
The motivating example for having multiple sources is looking at a superclass' implementation of a method for documentation for a subclass'.