MATLAB Help Report shows No Examples and No See Also Line
5 views (last 30 days)
Show older comments
I written a number of help files (functionname_help.m) in the following format
%% functionname
% function description
% goes here
%% SYNTAX
% syntax info goes here
%% Scenario Example 1
% description of example
%% Scenario Example 2
% description of example
%% See also
% references to other similar functions
%% Copyright 2000-2020
When I run the Help Report as below,
I see following validation errors.
I tried following to fix the example error, however it did not work
%% Example for Scenario 1
Also I am not sure why See Also would not work even though I have that in the Help line.
2 Comments
Adam Danz
on 10 Jan 2020
When I copy-paste your code into a new m-file named "jff.m" and execute the help() command, it appears as expected.
Accepted Answer
stozaki
on 10 Jan 2020
Hello,
Please see my script.
Examples : Check for examples in the help text. The Help Report performs a case-insensitive search for a help line with "a single-word variant of example".
See Also : Check for a line in the help that begins with the words See also.
See[space]also[space]
% example
% See also
% Copyright 2000-2020
Please refer following URL
Regards,
More Answers (3)
Fangjun Jiang
on 10 Jan 2020
Edited: Fangjun Jiang
on 10 Jan 2020
use %, not %%
and provide real contents for examples and "See also".
0 Comments
See Also
Community Treasure Hunt
Find the treasures in MATLAB Central and discover how the community can help you!
Start Hunting!