All geek questions in one place

MATLAB markup for doc page

What resources exist for explaining how to write MATLAB comments in the correct format for display with "doc" (this is the help browser).

In particular, I am writing a class and would like the help documentation to look like MATLAB. I focus on practical features, such as documenting various ways to call a function. I could not find documentation on which markup to use in the comments to achieve this.

(As an added bonus, I would like the autocomplete tooltips for the class functions to display something meaningful, but not MyFunction(MyClass object...), but it becomes too specific at this stage! I will ask again if this happens Naturally, if I have documentation )

+3
source share
1 answer

Try the following:

Help / Matlab User Guide / Desktop Tools and Development Environment / Custromizing Help and Demos / Providing Your Own Help and Demos

Hope this helps.

Edit: It looks like it changed in 2012a:

Help / Matlab User Guides / Programming Basics / Software Development / Creating Help and Demos / Adding Help for Your Program Files

+3
source

Source: https://habr.com/ru/post/1793750/

More articles:


All Articles