MATLAB Answers

Adding help content to AppDesigner App

14 views (last 30 days)
Greg
Greg on 29 Sep 2017
Answered: Nicholas Ayres on 18 Sep 2020
Does anybody know how to add comments to an .MLAPP such that "help myapp" returns the help content? Currently, all I get is "myapp is a class. [hyperlink]Reference page for myapp" The reference page is awesome, but my users like the standard help display.

Answers (3)

Ramanuja Jagannathan
Ramanuja Jagannathan on 5 Oct 2017
Edited: Ramanuja Jagannathan on 5 Oct 2017
I don't think the feature is currently available. The guess the reference page option (doc link below)available as of now.
https://www.mathworks.com/help/matlab/matlab_prog/display-custom-documentation.html

Greg
Greg on 10 Oct 2017
Edited: Greg on 10 Oct 2017
According to Function Precedence, .mlapp files are above .m files. This means we can create an .m file with the same name as our App, and put the help content in that .m file.
The caveat is at the command window:
help MyApp
returns the not-so-helpful "MyApp is a class." However,
help MyApp.m
forces MATLAB to look at the .m file rather than the .mlapp, and displays the help desired. This shouldn't have any run-time side effects, and only puts a small burden on users to explicitly add the ".m" to the help command input.

Nicholas Ayres
Nicholas Ayres on 18 Sep 2020
From what I can tell, no.
Greg's workaround is one suggestion. Alternatively, I've decided to write a static help function in my class which basically just contains an fprintf statement of what I want my help file to say.
At least then you can access it via myApp.help

Community Treasure Hunt

Find the treasures in MATLAB Central and discover how the community can help you!

Start Hunting!