class documentation
class ZopeInterfaceModule(model.Module, extensions.ModuleMixin): (source)
Constructor: ZopeInterfaceModule(system, name, parent, source_path)
Undocumented
| Method | setup |
Undocumented |
| Instance Variable | implements |
Undocumented |
| Property | all |
Return all the interfaces provided by this module |
Inherited from Module:
| Method | docformat |
Undocumented |
| Method | submodules |
Returns an iterator over the visible submodules. |
| Class Variable | parsed |
When the AST of a module is succesfully parsed, it is encapsulated in a ParsedAstModule instance and stored here to be processed later. |
| Instance Variable | all |
Names listed in the __all__ variable of this module. |
| Property | docformat |
The name of the format to be used for parsing docstrings in this module. |
| Property | module |
This object's Module. |
| Property | privacy |
How visible this object should be. |
| Method | _local |
Undocumented |
| Instance Variable | _docformat |
Undocumented |
| Instance Variable | _is |
Whether this module is a C-extension. |
| Instance Variable | _py |
The live module if the module was built from introspection. |
| Instance Variable | _py |
The module string if the module was built from text. |
Inherited from CanContainImportsDocumentable (via Module):
| Method | is |
Is the given name defined in the globals/locals of self-context? Only the first name of a dotted name is checked. |
| Method | local |
Undocumented |
| Instance Variable | _local |
Undocumented |
Inherited from Documentable (via Module, CanContainImportsDocumentable):
| Method | __init__ |
Undocumented |
| Method | __repr__ |
Undocumented |
| Method | docsources |
Objects that can be considered as a source of documentation. |
| 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 | kind |
Undocumented |
| 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 | 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 | 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 | 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 |