epydoc.checker

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

## Module epydoc.checker

Documentation completeness checker. This module defines a single class, `DocChecker`, which can be used to check the that specified classes of objects are documented.

Classes
`DocChecker` | Documentation completeness checker.

Function Summary
`boolean` | ``_is_private`(str)` Return true if `str` is the name of a public object.

Variable Summary
`list` | `_NO_BASIC` = `['__hash__', '__repr__', '__str__', '__cmp__...`
`list` | `_NO_DOCS` = `['__hash__', '__repr__', '__str__', '__cmp__'...`
`list` | `_NO_PARAM` = `['__cmp__']`
`list` | `_NO_RETURN` = `['__init__', '__hash__', '__repr__', '__str...`

Function Details

### _is_private(str) Parameters: `str` - The name to check. (type=`string`) Returns: True if `str` is the name of a public object. (type=`boolean`)

Variable Details

    ### _NO_BASIC Type: `list` Value:
        ['__hash__', '__repr__', '__str__', '__cmp__']

    ### _NO_DOCS Type: `list` Value:
        ['__hash__', '__repr__', '__str__', '__cmp__']

    ### _NO_PARAM Type: `list` Value:
        ['__cmp__']

    ### _NO_RETURN Type: `list` Value:
        ['__init__', '__hash__', '__repr__', '__str__', '__cmp__']

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