Index of modules


A
Annotation
Definition annotation file contents.
Args
Handling of command-line arguments.
Aspell
Spell-checking through the Aspell tool.

B
Binary
Binary output mode.

C
Cache
Cache / memoization structures.
Camlp4Utils
Utility functions related to the camlp4 library.
CategoryMap [Args]
The type of maps, with CategoryName.t as keys.
CategoryName
Names for categories of checks.
Check
Definition of checks in various flavors.
CheckName
Names for checks.
Checkstyle
CheckStyle-compatible output mode.
Code_builtinTypes
Check: redefinition of builtin types.
Code_catchAll
Check: catch of all exceptions.
Code_complexCondition
Check: complex if/while/when conditions.
Code_deprecated
Check: deprecated elements.
Code_emptyFor
Check: empty 'for' constructs.
Code_emptyTry
Check: empty 'try' constructs.
Code_emptyWhile
Check: empty 'while' constructs.
Code_idempotentOperations
Check: detects some idempotent operations.
Code_identifierLength
Check: identifiers that are too short.
Code_ignoreUnit
Check: ignore over unit expressions.
Code_length
Check: elements that are too lengthy.
Code_magicNumber
Check: magic numbers.
Code_negatedIf
Check: negated 'if' condition.
Code_nestedFor
Check: nested 'for' constructs.
Code_nestedIf
Check: nested 'if' constructs.
Code_nestedTry
Check: nested 'try' constructs.
Code_nestedWhile
Check: nested 'while' constructs.
Code_noEffectAssignment
Check: detects assignments with no effect.
Code_open
Check: open statements.
Code_parameterCount
Check: functions with too many parameters.
Code_physicalComparisons
Check: detects physical comparisons.
Code_predefinedExceptions
Check: redefinition of predefined exceptions.
Code_predefinedOperators
Check: redefinition predefined of operators.
Code_stringLiterals
Check: duplicate string literals.
Code_textualDuplicate
Check: textual duplicates.
Code_tupleSize
Check: lengthy tuples.
Code_uselessBinding
Check: detects useless bindings.
Code_uselessExternalParentheses
Check: useless external parentheses.
ConfigLexer
ConfigParser
Configuration
Configuration files.
Csv
Comma-separated output mode.

D
Doc_classComment
Check: enforce presence of class comments.
Doc_classTypeComment
Check: enforce presence of class type comments.
Doc_exceptionComment
Check: enforce presence of exception comments.
Doc_moduleComment
Check: enforce presence of module comments.
Doc_moduleTypeComment
Check: enforce presence of module type comments.
Doc_spell
Check: spell-check the text of ocamldoc comments.
Doc_typeComment
Check: enforce presence of type comments.
Doc_valueComment
Check: enforce presence of value comments.

H
Html
HTML output mode.

I
Ignore
Ignore files.
IgnoreLexer
IgnoreParser
Images
Data for images used in HTML output mode.
Interf_duplicate
Check: duplicate exported values.
Interf_exportedCount
Check: presence of complex structures.
Interf_exportedEmpty
Check: presence of empty structures.
Interf_methodCount
Check: presence of complex classes.

J
Jdepend
JDepend-compatible output mode.

M
Metrics_coupling
Check: computes dependencies.
Metrics_halstead
Check: Halstead complexity.
Metrics_mccabe
Check: McCabe complexity.
Misc_regexp
Check: regular expression matching.

O
Ocamldep
Dependency analysis through the ocamldep tool.
OcamldocUtils
Utility functions related to the ocamldoc library.
Output
Definition of output modes.
OutputName
Names for outputs.

P
Parameter
Check parameters.
ParameterName
Names for parameters.
Plugin
Handling of dynamically-loaded plugins (both checks and outputs).
Predefined
Lists of predefined checks and outputs.

R
Report
Reports of check violations.
RollingHash
Naive implementation of a rolling hash over strings.

S
State
Definition of checks states.
Summary
Output mode writing only top-level statistics.

T
Text
Bare text output mode.
Typo_fileLength
Check: long files.
Typo_header
Check: coherent headers for source files.
Typo_lineLength
Check: long lines.
Typo_spacesAroundBlocks
Check: white spaces around block delimiters.
Typo_spacesAroundOperators
Check: white spaces around operators.
Typo_spacesAroundPunctuation
Check: white spaces around punctuation signs.
Typo_tabCharacter
Check: tabulation character.
Typo_trailingNewLine
Check: end-of-file newline.
Typo_trailingWhiteSpace
Check: end-of-line whitespace.

U
Utils
Miscellaneous utility functions (time, string, i/o, parsing, XML).

V
Version
Current Mascot version.

X
Xml
XML output mode.