setHelp

Set custom help for custom authored Model Advisor checks

Since R2022a

Syntax

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


Description

setHelp(checkObj,'Format',format, 'Path',customPath) sets custom help for custom authored Model Advisor check object.

Input Arguments

format — Format of the help file

pdf | webpage

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

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

Data Types: char

customPath — Path of the help file

char vector

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

Example: setHelp(checkobj,'Format','pdf','path','c:/customhelp/help.pdf');

Data Types: char

Examples

Specify Web Page as Custom Help for Custom Check

Create a check object.

checkobj = ModelAdvisor.Check('SimplePassFailCheck');

Specify a web page as the custom help for your custom check.

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

Version History

Introduced in R2022a