how to wrangle the "doc" system when writing a class?
Mostra commenti meno recenti
Hi
I have written a class which is quite complex (hundred or so methods). It exposes two public interfaces; one is to the framework within which it functions, the other is to the user. When I run "doc MyClass", the "Method Summary" provides an alphabetical list of all public methods.
Now, the ability to to "doc MyClass" and have HTML help automatically generated is fantastic, saves me a lot of double-documenting. But... my users are only supposed to see a handful of the methods.
i) Can I hide all the framework methods? They do not appear under Method Summary if I make them private, but that makes them inaccessible to the framework.
ii) Can I generally take more control of what appears on the front page of "doc MyClass"? If I could author all of that myself, the nice linked-to pages for each method would make for a natty set of documentation. At least, can I take control over what appears (and in what order) under Method Summary?
Thanks!
1 Commento
Ben Mitch
il 13 Ott 2011
Risposte (0)
Categorie
Scopri di più su Programming in Centro assistenza e File Exchange
Community Treasure Hunt
Find the treasures in MATLAB Central and discover how the community can help you!
Start Hunting!