checkHelpText
Checks if texts are provided in the required locations.
Configurable parameters
-
CheckHelpText: A list of locations where help text needs to comply with the settings as specified in the other parameters of this check. Options are: classdef, properties, events, enumerations, methods, top-level functions, local functions and nested functions.
-
HelpRequired (boolean): Set to true to make help text required for the items selected in CheckHelpText.
-
BlockHelpLocation: Location where help text should be provided for blocks. Options are: outside block, inside block and either.
Example:
% Outside block. function y = f(u) % Inside block. end -
FieldHelpLocation: Location where help text should be provided for fields. Options are: above field, after field and either.
Example:
properties % Above field. field % After field. end -
Format: Check on the format for the help text, specified as a regular expression. The check provides a
contextstructure, that can be used in the pattern. Depending on the context it provides the following fields:-
classdef: name, superclasses -
property: name -
event: name -
enumeration: name -
method: name, argin, argout -
function: name, argin, argoutExample:
'(??@context.name) .+\.\n\n.+'(??@cmd): Execute the MATLAB command represented by cmd, and include the output returned by the command in the match expression.
-
Exemption tag: %@ok<HELPT>