| __ocaml_lex_comment_rec [IgnoreLexer] | |
| __ocaml_lex_comment_rec [ConfigLexer] | |
| __ocaml_lex_string_rec [IgnoreLexer] | |
| __ocaml_lex_string_rec [ConfigLexer] | |
| __ocaml_lex_tables [IgnoreLexer] | |
| __ocaml_lex_tables [ConfigLexer] | |
| __ocaml_lex_token_rec [IgnoreLexer] | |
| __ocaml_lex_token_rec [ConfigLexer] | |
A | |
| add [Report] | add knd cat chk fn ln cn msg x returns x augmented with a new element,
duplicate elements being discarded.
|
| add_char [IgnoreLexer] | |
| add_char [ConfigLexer] | |
| add_desc [Parameter] | add_desc d m returns m augmented with parameter descriptor d.
|
| add_hexa_char [IgnoreLexer] | |
| add_hexa_char [ConfigLexer] | |
| add_octal_char [IgnoreLexer] | |
| add_octal_char [ConfigLexer] | |
| analyse_files [Ocamldep] | analyse_files ~path files analyzes the files in files through ocamldep
executable (whose path is given by path, defaulting to "ocamldep").
|
| analyse_lines [Aspell] | analyse_lines ~path ~dictionary lines analyzes the words in lines
through a Aspell-compatible executable (whose path is given by path,
defaulting to "aspell"), using the language set by dictionary
(defaulting to "en").
|
| any [Parameter] |
Always returns
true.
|
B | |
| binary_current_version [Utils] |
Current version of binary format.
|
| binary_magic_number [Utils] |
Magic number (header) for files using binary format.
|
| binary_names [Camlp4Utils] |
Base name of camlp4 syntax binaries.
|
| bool [Parameter] |
Converts a boolean descriptor into a boolean parameter.
|
C | |
| category [Check.T] |
Category name for check.
|
| category [Check] |
Returns the category of the passed check.
|
| check_first_not_white [Camlp4Utils] | check_first_not_white kind symbol report l applies check_not_white on the head of l
if non-empty, does nothing otherwise.
|
| check_first_white [Camlp4Utils] | check_first_white kind symbol report l applies check_white on the head of l
if non-empty, does nothing otherwise.
|
| check_not_white [Camlp4Utils] | check_not_white kind symbol report token calls report with a message about
symbol (of kind kind) if token is a white element.
|
| check_white [Camlp4Utils] | check_white kind symbol report token calls report with a message about
symbol (of kind kind) if token is not a white element.
|
| checks [Predefined] |
The list of predefined checks (module signatures in src/checks).
|
| checks [Args] |
Available checks, stored in a map from category names to list of checks.
|
| clear [Cache] |
Empties the passed cache.
|
| code [CategoryName] |
The predefined category for code errors.
|
| comment [IgnoreLexer] | |
| comment [ConfigLexer] | |
| concat [Report] |
Concatenates the passed reports into a new one.
|
| concat_list [Report] |
Concatenates the passed list of reports into a new one.
|
| config_file [Args] |
Configuration file: definition of activated checks.
|
| current_time [Utils] |
Returns the current time as a string.
|
D | |
| description [Check.T] |
Short description for check.
|
| description [Check] |
Returns the description of the passed check.
|
| disable_cache [Args] |
Whether cache file should be disabled
(useful to avoid data corruption by a buggy plugin).
|
| documentation [Check.T] |
Full documentation for check.
|
| documentation [Check] |
Returns the documentation of the passed check.
|
| documentation [CategoryName] |
The predefined category for documentation errors.
|
E | |
| empty [Report] |
The empty report.
|
| empty_map [Parameter] |
The empty parameter map.
|
| error [Images] |
The data for the image used to mark error elements, in base64 encoding.
|
| escape_xml [Utils] | escape_xml s escapes s in such a way it can be used in XML.
|
F | |
| fail [IgnoreLexer] | |
| fail [ConfigLexer] | |
| file [ConfigParser] | |
| file [IgnoreParser] | |
| files [Args] |
List of files to analyze.
|
| filter [Report] | filter no_info no_warning no_error il rep filters the report elements of
rep by ignoring elements in il; additionally: no_info indicates whether Info elements are ignored;, no_warning indicates whether Warning elements are ignored;, no_error indicates whether Error elements are ignored.
|
| find_check [Args] | find_check cat chk returns the check whose name is chk in the category
cat.
|
| fold [Report] | fold f z rep folds over the report elements of rep, starting with
value z and using function f.
|
G | |
| get [Cache] | get c x returns the value associated with x, either cached in c from
a previous execution, or by executing the function used at cache creation
over x.
|
| get_bool [Parameter] | get_bool n m returns the value of the parameter named n in m.
|
| get_int [Parameter] | get_int n m returns the value of the parameter named n in m.
|
| get_string [Parameter] | get_string n m returns the value of the parameter named n in m.
|
| get_symbol [Parameter] | get_symbol n m returns the value of the parameter named n in m.
|
| get_symbol_list [Parameter] | get_symbol_list n m returns the value of the parameter named n in m.
|
I | |
| ignore_file [Args] |
Ignore file: list of report element to ignore.
|
| incr_line [IgnoreLexer] | |
| incr_line [ConfigLexer] | |
| info [Images] |
The data for the image used to mark info elements, in base64 encoding.
|
| init [State] | init f Initializes a (collection of) state(s) by returning a pair that
consist of a getter and setter.
|
| int [Parameter] |
Converts an int descriptor into an int parameter.
|
| interface [CategoryName] |
The predefined category for interface errors.
|
| is_empty_info_option [OcamldocUtils] |
Tests whether the passed info option is empty, the passed boolean
indicating if the test is strict.
|
| is_revised_binary [Camlp4Utils] |
Tests whether a string from
binary_names is related to revised
syntax.
|
| iter [Parameter] | iter f m iterates over parameter map m with function f.
|
| iter [Report] | iter f rep iterates over the report elements of rep by applying f.
|
L | |
| level_symbol [Parameter] |
Checks whether the passed string is one of:
"info";, "warning";, "error".
|
| limits [Check.T] |
Limits of check.
|
| limits [Check] |
Returns the limits of the passed check.
|
| line_and_column_of_location [OcamldocUtils] |
Converts the passed
(file, offset) pair into a (line, column) pair.
|
| line_and_column_of_location [Camlp4Utils] |
Converts the passed location into a
(line, column) pair.
|
| load_file [Annotation] |
Loads annotations from passed file, raising
Exception if the file does
not respect the format of annotations.
|
M | |
| make [ParameterName] | make x returns the parameter name equal to x.
|
| make [RollingHash] | make hash init creates a new rolling hash base on hashing function
hash and returns the hash of passed strings.
|
| make [Cache] | make f returns an empty cache based on the function f.
|
| make [CheckName] | make x returns the check name equal to x.
|
| make [OutputName] | make x returns the check name equal to x.
|
| make [CategoryName] | make x returns the category name equal to x.
|
| make1 [Parameter] | make1 d1 returns a map along with a getter to retrieve the value
associated with the passed descriptor.
|
| make2 [Parameter] | make2 d1 d2 returns a map along with getters to retrieve the values
associated with the passed descriptors.
|
| make3 [Parameter] | make3 d1 d2 d3 returns a map along with getters to retrieve the values
associated with the passed descriptors.
|
| make4 [Parameter] | make4 d1 d2 d3 d4 returns a map along with getters to retrieve the values
associated with the passed descriptors.
|
| map [Report] | map f rep maps the report elements of rep through f.
|
| metrics [CategoryName] |
The predefined category for metrics.
|
| miscellaneous [CategoryName] |
The predefined category for miscellaneous errors.
|
| multiple [Check.T] |
Whether the checks supports multiple instances.
|
| multiple [Check] |
Returns whether the passed check supports multiple instances.
|
N | |
| name [Output.T] |
Output name.
|
| name [Check.T] |
Name for check.
|
| name [Check] |
Returns the name of the passed check.
|
| next_id [State] |
Returns a new state identifier.
|
| no_error [Args] |
Whether errors should be ignored.
|
| no_info [Args] |
Whether infos should be ignored.
|
| no_warning [Args] |
Whether warnings should be ignored.
|
| non_empty_string [Parameter] |
Checks whether the passed string is not empty.
|
O | |
| outputs [Predefined] |
The list of predefined outputs (module signatures in src/outputs).
|
| outputs [Args] |
Association list from outputs to result destination, an empty string means
that the output is not activated.
|
P | |
| parameters [Check.T] |
Parameters of check.
|
| parameters [Check] |
Returns the parameters of the passed check.
|
| parse [Args] |
Loads plugins, and then parses the command-line.
|
| parse_file [Utils] | parse_file file f parses the file file through function f.
|
| positive [Parameter] |
Checks whether the passed value is either positive or null.
|
| predefined_modules [Camlp4Utils] |
Predefined modules from camlp4 binaries.
|
| preprocessor [Args] |
Preprocessor to be applied on sources.
|
| print_signature [Camlp4Utils] |
Prints the passed element for debuging purposes.
|
| print_structure [Camlp4Utils] |
Prints the passed element for debuging purposes.
|
| print_tokens [Camlp4Utils] |
Prints the passed element for debuging purposes.
|
R | |
| rationale [Check.T] |
Justification for check.
|
| rationale [Check] |
Returns the rationale of the passed check.
|
| read_lines [Utils] | read_lines file returns the lines of file file
("-" being interpreted as the standard input).
|
| register_check [Plugin] |
Registers the passed check.
|
| register_lines_check [Plugin] |
Registers the passed check.
|
| register_ocamldoc_check [Plugin] |
Registers the passed check.
|
| register_output [Plugin] |
Registers the passed output.
|
| register_signature_check [Plugin] |
Registers the passed check.
|
| register_structure_check [Plugin] |
Registers the passed check.
|
| register_tokens_check [Plugin] |
Registers the passed check.
|
| report_only [Args] |
Whether report should be made from binary files.
|
| run [Output.T] | run dest deps rep outputs the report rep associated with dependencies
deps to the destination dest.
|
| run [Check.T] | run id deps x params report actually runs the check over value x.
|
S | |
| same [Output] |
Tests whether the passed outputs have the same name.
|
| same [Check] |
Tests whether the passed checks have the same name.
|
| search_path [Args] |
Where to look for additional files.
|
| set_bool [Parameter] | set_bool n v m returns m with the value named n being replaced by v.
|
| set_int [Parameter] | set_int n v m returns m with the value named n being replaced by v.
|
| set_string [Parameter] | set_string n v m returns m with the value named n being replaced by v.
|
| set_symbol [Parameter] | set_symbol n v m returns m with the value named n being replaced by v.
|
| set_symbol_list [Parameter] | set_symbol_list n v m returns m with the value named n being replaced by v.
|
| size [Parameter] |
Returns the number of parameters in the passed map.
|
| size [Cache] |
Returns the size of the passed cache.
|
| split_by_file [Report] |
Splits the passed report, returning an association list from filenames
to associated (sub-)reports.
|
| statistics [Report] |
Returns the numbers of
Info, Warning, and Error element in the passed
report.
|
| strictly_positive [Parameter] |
Checks whether the passed value is strictly positive.
|
| string [Parameter] |
Converts a string descriptor into a string parameter.
|
| string [IgnoreLexer] | |
| string [ConfigLexer] | |
| string_hash [Utils] |
Returns the hash value for the passed string.
|
| string_of_error [IgnoreLexer] | |
| string_of_error [ConfigLexer] | |
| string_of_ident [Camlp4Utils] |
Converts the passed identifier into a string.
|
| string_of_info [OcamldocUtils] |
Converts the passed info into a bare string, with no formatting.
|
| string_of_info_option [OcamldocUtils] |
Converts the passed info option into a bare string, with no formatting.
|
| string_of_kind [Report] |
Converts the passed kind into a string.
|
| string_of_text [OcamldocUtils] |
Converts the passed text into a bare string, with no formatting.
|
| string_of_text_element [OcamldocUtils] |
Converts the passed text element into a bare string, with no formatting.
|
| string_of_text_list [OcamldocUtils] |
Converts the passed text list into a bare string, with no formatting.
|
| string_of_text_option [OcamldocUtils] |
Converts the passed text option into a bare string, with no formatting.
|
| string_of_token [Camlp4Utils] |
Converts the passed element into a string.
|
| string_of_xml_tree [Utils] |
Converts the passed XML tree into a string.
|
| symbol [Parameter] |
Converts a symbol descriptor into a symbol parameter.
|
| symbol_list [Parameter] |
Converts a symbol descriptor into a list parameter.
|
| syntax [Args] |
Camlp4 preprocessor to be applied on sources.
|
| syntax_extensions [Args] |
Arguments to camlp4 preprocessor to be applied on sources.
|
T | |
| token [IgnoreLexer] | |
| token [ConfigLexer] | |
| trim [Utils] |
Returns the passed string without leading and trailing whitespaces.
|
| typography [CategoryName] |
The predefined category for typography errors.
|
U | |
| update [RollingHash] | update rh s update rolling hash rh with string s, that is: removes the oldest string from the rolling hash;, adds the passed string to the rolling hash;, returns the hash for the new set of strings.
|
| use_original_syntax [Camlp4Utils] |
Whether to use the original syntax (as opposed to the revised one),
initially set to
true.
|
V | |
| value [Version] |
The current version of Mascot as a string.
|
W | |
| warning [Images] |
The data for the image used to mark warning elements, in base64 encoding.
|
| write_lines [Utils] | write_lines lines file writes the strings lines to the file file.
|
X | |
| xml_header [Utils] |
The XML header for produced XML files.
|