skDisableMessage

skDisableMessage( 
S_functionName 
S_messageName 
[ x_occurrences ]
) 
=> t

Description

Disables a SKILL Lint message from being reported inside a given function definition.

Often a user does not want to disable a SKILL Lint message globally but only an individual case. You can put the call to this function in the .skinit file in the user’s home directory or the your_install_dir/local directory. This function can also be inserted in the file being analyzed, outside of any function definition, before the function is defined, and SKILL Lint will recognize the call. See SKILL lint messages.

Arguments

S_functionName	Function in which the given SKILL Lint error message is not reported.
S_messageName	Name of the message to ignore when SKILL Lint analyzes the file containing the function definition.
x_occurrences	Number of times to ignore the error message inside the function. This defaults to 1 if not given.

Value Returned

t	Always returns t.

Examples

The following example disables the first occurrence of the SKILL Lint message Unused when SKILL Lint analyzes the function definition for testFunction.

skDisableMessage('testFunction 'Unused 1)

Related Topics

Lint Functions

sklint

skIgnoreMessage

skUnignoreMessage

Return to top