ModelAdvisor.Check.setHelp

R2026b

Set custom help for custom authored Model Advisor checks

Since R2022a

Syntax

setHelp(check_obj,Name=Value)

Description

setHelp(check_obj,Name=Value) sets the help documentation format and file path for the custom Model Advisor check object check_obj.

Examples

Specify Web Page as Custom Help for Custom Check

This example shows how to specify the web page format for custom help in a custom Model Advisor check.

Create a Model Advisor check object.

rec = ModelAdvisor.Check('com.mathworks.mySampleCheck');

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

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

Input Arguments

check_obj — Model Advisor check object

ModelAdvisor.Check object

Model Advisor check object, specified as a ModelAdvisor.Check object.

Name-Value Arguments

Specify optional pairs of arguments as Name1=Value1,...,NameN=ValueN, where Name is the argument name and Value is the corresponding value. Name-value arguments must appear after other arguments, but the order of the pairs does not matter.

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

Format — Format of help file

pdf | webpage

Specifies the format of the help file for the custom check object.

Example: Format='webpage'

Data Types: char

Path — Path of help file

char vector

Specifies the path of the help file for the custom check object.

Example: Path='c:/customhelp/help.html'

Data Types: char

Version History

Introduced in R2022a