How to generate the custom help box for a custom function (More Help...)
32 views (last 30 days)
I recently dealt with proper help for my custom functions.
I found out that there are 4 points one can handle:
- doc myfun: Will show file help or if available the html help (https://de.mathworks.com/help/matlab/matlab_prog/display-custom-documentation.html)
- writing your function, then typing in the opening bracket and waiting. A small box will appear showing input parameters
- help myfun: Will display the comments at the top of the function (https://de.mathworks.com/help/matlab/matlab_prog/add-help-for-your-program.html)
- tab completion with functionSignatures.json (https://de.mathworks.com/help/matlab/matlab_prog/customize-code-suggestions-and-completions.html and also https://undocumentedmatlab.com/articles/user-defined-tab-completions-take-2)
For 2.: Where can I find how to do this? For custom functions, only the input parameters are shown. But for Matlab Built-Ins, all available syntaxes are shown. They sometimes even differ from the "syntax" part in the html help, see movmean function help and the "bracket opening"-help for the info on datetime object, see picture below.
Are there even other "standard" help functionalities besides the four above?
Thanks for some advice.
Ran on 5 Jan 2020
I encountered the same issue.
Is there a solution (for the normal editor, not the live-script editor) ?
Andrii Zelenko on 10 Jul 2021
I guess this might be helpful: https://www.mathworks.com/help/matlab/matlab_prog/add-help-for-your-program.html
You basically just add comments at the begining of your custom funciton and aafter typing
comments will poped up