How to generate the custom help box for a custom function (More Help...)

Hi everyone,

I recently dealt with proper help for my custom functions.

I found out that there are 4 points one can handle:

1. doc myfun: Will show file help or if available the html help (https://de.mathworks.com/help/matlab/matlab_prog/display-custom-documentation.html)
2. writing your function, then typing in the opening bracket and waiting. A small box will appear showing input parameters
3. 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)
4. 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.

Answer 1

[Sahithi Kanumarlapudi]

You can refer to a similar question here

[breathi]

Hi there,

this question you linked does not seem to be answered at all. From what I understood, this refers to point 4 I mentioned and is only referring to live scripts, not the command window? See Jan's comment.

Answer 2

[Ran]

I encountered the same issue.

Is there a solution (for the normal editor, not the live-script editor) ?

[Jan Kappen]

+1...

I bet the normal editor shall be replaced soon, no updates were made a long time and all efforts were spent to the javascript/online interface.

Answer 3

[Andrii Zelenko]

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

help your_custom_function

comments will poped up