Enum Tools.AutoDoc.Flags

Description

Flags affecting autodoc extractor behaviour.

See also

ProcessXML.extractXML(), MirarDocParser, Tools.Standalone.extract_autodoc()

Constant FLAG_COMPAT

constant Tools.AutoDoc.FLAG_COMPAT

Description

Attempt to be compatible with old Pike.

Constant FLAG_DEBUG

constant Tools.AutoDoc.FLAG_DEBUG

Description

Full verbosity.

Constant FLAG_KEEP_EMPTY

constant Tools.AutoDoc.FLAG_KEEP_EMPTY

Description

Set marker in XML to keep classes and modules even if they have empty documentation. This is used for C documentation, since someone has made the effort to document the existence.

Constant FLAG_KEEP_GOING

constant Tools.AutoDoc.FLAG_KEEP_GOING

Description

Attempt to keep going after errors.

Constant FLAG_NORMAL

constant Tools.AutoDoc.FLAG_NORMAL

Description

Normal verbosity.

Constant FLAG_NO_DYNAMIC

constant Tools.AutoDoc.FLAG_NO_DYNAMIC

Description

Reduce the amount of dynamic information in the generated files (line numbers, extractor version, extraction time, etc).

Constant FLAG_QUIET

constant Tools.AutoDoc.FLAG_QUIET

Description

Keep quiet about non-fatal errors.

Constant FLAG_VERBOSE

constant Tools.AutoDoc.FLAG_VERBOSE

Description

Extra verbosity.

Constant FLAG_VERB_MASK

constant Tools.AutoDoc.FLAG_VERB_MASK

Description

Verbosity mask.