Logo Search packages:      
Sourcecode: zope-docfindertab version File versions  Download package

DocFinderTab::analyse::Doc Class Reference

List of all members.

Detailed Description

determine the documentation of an object.

The documentation is described by a 'Doc' instance.
It maintains.

 path -- the physical path of the documented object or 'None'

 title -- the title of the documented object or ''

 obj -- the documented object

 classes -- a two level sequence structure:

   1. classes, the object is build from, in message resolution order (mro).

      each class is described by a 'ClassDoc' instance

   2. for each class, the attributes defined by the class

      each attribute is described by a 'AttributeDoc' instance.

The documentation does not include instance level attributes
(they are too many). However, it does provide
summary information about access to unprotected attributes
in the doc for the pseudo class '-- Instance --'.
This information is not accurate, as the
evaluation is not precise.

Definition at line 67 of file analyse.py.

Public Member Functions

def __getitem__
def __init__
def __len__
def DocMethodRe__
def DocType__
def ObjToDoc__
def Path
def Title
def tpId
def tpId
def tpValues

Private Member Functions

def _analyseClass
def _attrRoles
def _makeUnprotectedChecker

Private Attributes


Static Private Attributes

 _classDict = None
tuple _secInfo = ClassSecurityInfo()

The documentation for this class was generated from the following file:

Generated by  Doxygen 1.6.0   Back to index