Main Content

setHelp

Class: ModelAdvisor.Group
Package: ModelAdvisor

Set custom help for folders that have custom authored Model Advisor checks

Syntax


checkObj.setHelp('Format',format, 'Path', custom path)

Description

checkObj.setHelp('Format',format, 'Path', custom path) sets custom help for folders that have custom authored Model Advisor checks.

Input Arguments

expand all

Format of the help file, specified as pdf or webpage.

Example: checkObj.setHelp('Format','webpage','Path','c:/customhelp/help.html');

Data Types: char

Path of the help file for the custom check specified as a character vector.

Example: checkObj.setHelp('Format','pdf','Path','c:/customhelp/help.pdf');

Data Types: char

Examples

Set pdf as custom help to a custom check group

Create a group object.

group_obj = ModelAdvisor.Group('mathworks.example.ExampleGroup');

set pdf as custom help to your custom check.

group_obj.setHelp('Format','pdf','Path','c:/customhelp/help.pdf');

Version History

Introduced in R2022a