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.
To specify multiple values from a single group, simply or their values
together:
|
|
__init__(self,
docindex)
Create a new DocChecker that can be used to run checks
on the documentation of the objects documented by
docindex |
source code
|
|
boolean
|
check(self,
*check_sets)
Run the specified checks on the documentation of the objects
contained by this DocChecker's DocIndex. |
source code
|
|
|
|
|
|
|
|
None
|
|
None
|
|
None
|
|
|
|
|
None
|
_check_var(self,
doc)
Run checks on the variable whose documentation is var
and whose name is name. |
source code
|
|
None
|
|
|
|
|
|
|
PROPERTY = 256
|
|
|
ALL = 24831
|
int
|
MODULE = 1
Type specifier that indicates that the documentation of modules
should be checked.
|
int
|
CLASS = 2
Type specifier that indicates that the documentation of classes
should be checked.
|
int
|
FUNC = 4
Type specifier that indicates that the documentation of functions
should be checked.
|
int
|
VAR = 8
Type specifier that indicates that the documentation of module
variables should be checked.
|
int
|
PARAM = 64
Type specifier that indicates that the documentation of function and
method parameters should be checked.
|
int
|
RETURN = 128
Type specifier that indicates that the documentation of return values
should be checked.
|
int
|
ALL_T = 511
Type specifier that indicates that the documentation of all objects
should be checked.
|
int
|
CVAR
Type specifier that indicates that the documentation of class
variables should be checked.
|
int
|
IVAR
Type specifier that indicates that the documentation of instance
variables should be checked.
|
int
|
TYPE = 256
Check specifier that indicates that every variable and parameter
should have a @type field.
|
int
|
AUTHOR = 1024
Check specifier that indicates that every object should have an
author field.
|
int
|
VERSION = 2048
Check specifier that indicates that every object should have a
version field.
|
int
|
DESCR = 4096
Check specifier that indicates that every object should have a
description.
|
int
|
ALL_C = 7936
Check specifier that indicates that all checks should be run.
|
int
|
PRIVATE = 16384
Specifier that indicates that private objects should be checked.
|