Package       Module       Class       Trees       Index       Help   
epydoc
[show private | hide private]

epydoc.checker
Class epydoc.checker.DocChecker

Documentation completeness checker. DocChecker can be used to check that specified classes of objects are documented. To check the documentation for a group of objects, you should create a DocChecker from a DocMap that documents those objects; and then use the check method to run specified checks on the objects' documentation.

What checks are run, and what objects they are run on, are specified by the constants defined by DocChecker. These constants are divided into three groups. The check method is used to perform a check on the documentation. Its parameter is formed by or-ing together at least one value from each specifier group: 
>>> checker.check(DocChecker.MODULE | DocChecker.PUBLIC |
...               DocChecker.DESCR)
To specify multiple values from a single group, simply or their values together: 
>>> checker.check(DocChecker.MODULE | DocChecker.CLASS |
...               DocChecker.FUNC | DocChecker.DESCR_LAZY |
...               DocChecker.PUBLIC)
Method Summary
  __init__(self, docmap)
Create a new DocChecker that can be used to run checks on the documentation of the objects documented by docmap
boolean check(self, checks)
Run the specified checks on the documentation of the objects contained by this DocChecker's DocMap.

Class Variable Summary
int ALL_C - Check specifier that indicates that all checks should be run.
int ALL_P - Specifier that indicates that both public and private objects should be checked.
int ALL_T - Type specifier that indicates that the documentation of all objects should be checked.
int AUTHOR - Check specifier that indicates that every object should have an author field.
int CLASS - Type specifier that indicates that the documentation of classes should be checked.
int CVAR - Type specifier that indicates that the documentation of class variables should be checked.
int DESCR - Check specifier that indicates that every object should have a description.
int DESCR_LAZY - Check specifier that indicates that every object should have a description.
int FUNC - Type specifier that indicates that the documentation of functions should be checked.
int IVAR - Type specifier that indicates that the documentation of instance variables should be checked.
int MODULE - Type specifier that indicates that the documentation of modules should be checked.
int PARAM - Type specifier that indicates that the documentation of function and method parameters should be checked.
int PRIVATE - Specifier that indicates that private objects should be checked.
int PUBLIC - Specifier that indicates that public objects should be checked.
int RETURN - Type specifier that indicates that the documentation of return values should be checked.
int SEE - Check specifier that indicates that all @see fields should have valid targets.
int TYPE - Check specifier that indicates that every variable and parameter should have a @type field.
int VAR - Type specifier that indicates that the documentation of module variables should be checked.
int VERSION - Check specifier that indicates that every object should have a version field.

Method Details

Constructor

__init__(self, docmap)

Create a new DocChecker that can be used to run checks on the documentation of the objects documented by docmap
Parameters:
docmap - A documentation map containing the documentation for the objects to be checked.
           (type=DocMap)

check

check(self, checks=None)

Run the specified checks on the documentation of the objects contained by this DocChecker's DocMap. Any errors found are printed to standard out.
Parameters:
checks - The checks that should be run on the documentation. This value is constructed by or-ing together the specifiers that indicate which objects should be checked, and which checks should be run. See the module description for more information. If no checks are specified, then a default set of checks will be run.
           (type=int)
Returns:
True if no problems were found.
           (type=boolean)

Class Variable Details

ALL_C

Check specifier that indicates that all checks should be run.
Type: int

ALL_P

Specifier that indicates that both public and private objects should be checked.
Type: int

ALL_T

Type specifier that indicates that the documentation of all objects should be checked.
Type: int

AUTHOR

Check specifier that indicates that every object should have an author field.
Type: int

CLASS

Type specifier that indicates that the documentation of classes should be checked.
Type: int

CVAR

Type specifier that indicates that the documentation of class variables should be checked.
Type: int

DESCR

Check specifier that indicates that every object should have a description.
Type: int

DESCR_LAZY

Check specifier that indicates that every object should have a description. However, it is permissible for functions and methods that have a @return field to not have a description, since a description may be generated from the @return field.
Type: int

FUNC

Type specifier that indicates that the documentation of functions should be checked.
Type: int

IVAR

Type specifier that indicates that the documentation of instance variables should be checked.
Type: int

MODULE

Type specifier that indicates that the documentation of modules should be checked.
Type: int

PARAM

Type specifier that indicates that the documentation of function and method parameters should be checked.
Type: int

PRIVATE

Specifier that indicates that private objects should be checked.
Type: int

PUBLIC

Specifier that indicates that public objects should be checked.
Type: int

RETURN

Type specifier that indicates that the documentation of return values should be checked.
Type: int

SEE

Check specifier that indicates that all @see fields should have valid targets.
Type: int

TYPE

Check specifier that indicates that every variable and parameter should have a @type field.
Type: int

VAR

Type specifier that indicates that the documentation of module variables should be checked.
Type: int

VERSION

Check specifier that indicates that every object should have a version field.
Type: int

   Package       Module       Class       Trees       Index       Help   
epydoc
Generated by Epydoc on Sun Oct 6 03:32:11 2002 http://epydoc.sf.net