setHelp

Class: ModelAdvisor.Group
Namespace: ModelAdvisor

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

Since R2022a

Syntax

setHelp(groupObj,'Format',format, 'Path', customPath)


Description

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

Input Arguments

format — Format of the help file

pdf | webpage

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

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

Data Types: char

customPath — Path of the help file

character vector

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

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

Data Types: char

Examples

Specify PDF as Custom Help for Custom Check Group

Create a group object.

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

Specify a PDF as the custom help for your custom check group.

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

Version History

Introduced in R2022a