| Home | Trees | Index | Help |  | 
|---|
| Package epydoc :: Module checker :: Class 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.
DocChecker. These constants are 
divided into three groups.
MODULE; CLASS; FUNC; VAR; IVAR; CVAR; PARAM; and RETURN.
  PUBLIC and PRIVATE.
  TYPE; DESCR; DESCR_LAZY; AUTHOR; and VERSION.
  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 | |
|---|---|
| Create a new DocCheckerthat can be used to run checks on 
the documentation of the objects documented bydocmap | |
| boolean | Run the specified checks on the documentation of the objects contained by this DocChecker'sDocMap. | 
| None | Check the description, author, version, and see-also fields of doc. | 
| None | Run checks on the class whose UID is doc. | 
| None | Run checks on the function whose UID is doc. | 
| None | Run checks on the module whose UID is doc. | 
| boolean | Return true if an object named nameshould be checked, given the 
public/private specifiers. | 
| _check_property(self,
          doc) | |
| None | Run checks on the variable whose documentation is varand 
whose name isname. | 
| None | Print a warning about the object named name. | 
| Class Variable Summary | |
|---|---|
| int | ALL= 65791 | 
| int | PROPERTY= 256 | 
| int | _DESCR_STRICT= 8192 | 
| Types | |
| int | MODULE: Type specifier that indicates that the documentation of modules should 
be checked. | 
| int | CLASS: Type specifier that indicates that the documentation of classes should 
be checked. | 
| int | FUNC: Type specifier that indicates that the documentation of functions 
should be checked. | 
| int | VAR: Type specifier that indicates that the documentation of module 
variables should be checked. | 
| int | IVAR: Type specifier that indicates that the documentation of instance 
variables should be checked. | 
| int | CVAR: Type specifier that indicates that the documentation of class 
variables should be checked. | 
| int | PARAM: Type specifier that indicates that the documentation of function and 
method parameters should be checked. | 
| int | RETURN: Type specifier that indicates that the documentation of return values 
should be checked. | 
| int | ALL_T: Type specifier that indicates that the documentation of all objects 
should be checked. | 
| Checks | |
| int | TYPE: Check specifier that indicates that every variable and parameter 
should have a@typefield. | 
| int | AUTHOR: Check specifier that indicates that every object should have anauthorfield. | 
| int | VERSION: Check specifier that indicates that every object should have aversionfield. | 
| int | DESCR_LAZY: Check specifier that indicates that every object should have a 
description. | 
| int | DESCR: Check specifier that indicates that every object should have a 
description. | 
| int | ALL_C: Check specifier that indicates that all checks should be run. | 
| Publicity | |
| int | PUBLIC: Specifier that indicates that public objects should be checked. | 
| int | PRIVATE: Specifier that indicates that private objects should be checked. | 
| int | ALL_P: Specifier that indicates that both public and private objects should 
be checked. | 
| Method Details | 
|---|
| __init__(self,
          docmap)
    Create a new | 
| check(self, checks=None)Run the specified checks on the documentation of the objects contained by thisDocChecker'sDocMap. Any 
  errors found are printed to standard out.
 | 
| _check_basic(self, doc)Check the description, author, version, and see-also fields ofdoc. This is used as a helper function by_check_module,_check_class, and_check_func.
 | 
| _check_class(self, doc)Run checks on the class whose UID isdoc.
 | 
| _check_func(self, doc)Run checks on the function whose UID isdoc.
 | 
| _check_module(self, doc)Run checks on the module whose UID isdoc.
 | 
| _check_name_publicity(self, name)
 | 
| _check_var(self, var, name, check_type=1)Run checks on the variable whose documentation isvarand whose name isname.
 | 
| _warn(self, error, name)Print a warning about the object namedname.
 | 
| Class Variable Details | 
|---|
| MODULEType specifier that indicates that the documentation of modules should be checked.
 | 
| CLASSType specifier that indicates that the documentation of classes should be checked.
 | 
| FUNCType specifier that indicates that the documentation of functions should be checked.
 | 
| VARType specifier that indicates that the documentation of module variables should be checked.
 | 
| IVARType specifier that indicates that the documentation of instance variables should be checked.
 | 
| CVARType specifier that indicates that the documentation of class variables should be checked.
 | 
| PARAMType specifier that indicates that the documentation of function and method parameters should be checked.
 | 
| RETURNType specifier that indicates that the documentation of return values should be checked.
 | 
| ALL_TType specifier that indicates that the documentation of all objects should be checked.
 | 
| TYPECheck specifier that indicates that every variable and parameter should have a@typefield.
 | 
| AUTHORCheck specifier that indicates that every object should have anauthorfield.
 | 
| VERSIONCheck specifier that indicates that every object should have aversionfield.
 | 
| DESCRCheck specifier that indicates that every object should have a description.
 | 
| ALL_CCheck specifier that indicates that all checks should be run.
 | 
| PUBLICSpecifier that indicates that public objects should be checked.
 | 
| PRIVATESpecifier that indicates that private objects should be checked.
 | 
| ALL_PSpecifier that indicates that both public and private objects should be checked.
 | 
| ALL
 | 
| PROPERTY
 | 
| _DESCR_STRICT
 | 
| Home | Trees | Index | Help |  | 
|---|
| Generated by Epydoc 2.1 on Sat Mar 20 17:46:18 2004 | http://epydoc.sf.net |