epydoc.objdoc

Package epydoc :: Module objdoc |
[show private | hide private]
[frames | no frames]

## Module epydoc.objdoc

Support for `ObjDoc`s, which encode the information about a Python object that is necessary to create its documentation. `ObjDoc`s are created and managed by the `DocMap` class, which acts like a dictionary from `UID`s to `ObjDoc`s.

Textual documentation entries (e.g., module descriptions, method descriptions, variable types, see-also entries) are encoded as `ParsedDocstrings`.

Each Python object is identified by a globally unique identifier, implemented with the `UID` class. These identifiers are also used by the `Link` class to implement crossreferencing between `ObjDoc`s.

Classes
`ClassDoc` | The documentation for a class.
`DocField` | A generic docstring field.
`DocMap` | A dictionary mapping each object to the object's documentation.
`FuncDoc` | The documentation for a function.
`ModuleDoc` | The documentation for a module or package.
`ObjDoc` | A base class for encoding the information about a Python object that is necessary to create its documentation.
`Param` | The documentation for a function parameter.
`PropertyDoc` | The documentation for a property.
`Raise` | The documentation for the raising of an exception.
`Var` | The documentation for a variable.

Function Summary
| `report_param_mismatches(docmap)`
`None` | ``set_default_docformat`(new_format)` Change the default value for `__docformat__` to the given value.

Variable Summary
`str` | `DEFAULT_DOCFORMAT`: The default value for `__docformat__`, if it is not specified by modules.
`tuple` | `KNOWN_DOCFORMATS` = `('plaintext', 'epytext', 'restructure...`

Function Details

### set_default_docformat(new_format) Change the default value for `__docformat__` to the given value. The current default value for `__docformat__` is recorded in `DEFAULT_DOCFORMAT`. Parameters: `new_format` - The new default value for `__docformat__` (type=`string`) Returns: `None` See Also: `DEFAULT_DOCFORMAT`

Variable Details

### DEFAULT_DOCFORMAT The default value for `__docformat__`, if it is not specified by modules. `__docformat__` is a module variable that specifies the markup language for the docstrings in a module. Its value is a string, consisting the name of a markup language, optionally followed by a language code (such as `en` for English). Some typical values for `__docformat__` are:
    >>> __docformat__ = 'plaintext'
    >>> __docformat__ = 'epytext'
    >>> __docformat__ = 'epytext en'
    Type: `str` Value:
        'plaintext'

    ### KNOWN_DOCFORMATS Type: `tuple` Value:
        ('plaintext', 'epytext', 'restructuredtext', 'javadoc')

Generated by Epydoc 2.1 on Sat Mar 20 17:46:19 2004 | http://epydoc.sf.net