To determine which of your programs files have help text, you can use the Help Report.
In the Help Report, you specify a set of help components for
which you want to search, such as examples or
See Also lines.
For each file searched, MATLAB® displays the help text for the
components it finds. Otherwise, MATLAB displays a highlighted
message to indicate that the component is missing.
Note: MATLAB does not support creating Help Reports for live scripts. When creating a report for all files in a folder, all live scripts in the selected folder are excluded from the report.
To generate a Help Report, in the Current Folder browser, navigate to the folder you want to check, click , and then select Reports > Help Report. The Help Report displays in the MATLAB web browser.
This table describes the available options for Help Reports.
|Help Report Option||Description|
Show class methods
Include methods in the report. If you do not select this option, then the report includes results for classes, but not for methods within a class definition file.
Show all help
Display all help text found in each file. If you also select individual help components, such as Description, then help text appears twice in the report for each file: once for the overall help text, and once for the component.
your program has the same name as other programs on the MATLAB search
path, then the
Check for an initial, nonempty comment line in the file. This line is sometimes called the H1 line.
Check for examples in the help text. The Help Report
performs a case-insensitive search for a help line with a single-word
Check for a line in the help that begins with the words
If the programs listed after
Check for a comment line in the file that begins with
The recommended practice is to include a range of years from the year you created the file to the current year.