[Doxygen-develop] dynamic 'protected' display
Brought to you by:
dimitri
From: Ethan Tira-T. <ej...@an...> - 2009-04-23 02:30:17
|
Another feature I am interested in is extending HTML_DYNAMIC_SECTIONS to allow users to show or hide the 'protected' fields. Some classes are meant to be used 'as is', and protected methods/ members are only intended for future expansion by the library authors, and so are not of interest to library users reading the documentation. Other classes are meant to be subclassed by end-users, in order to pass their classes back into the library. In this case they would be interested in the documentation for protected methods. Examples in our robotics code are Event classes, which are posted by the framework and not generally subclassed by users, vs. Behavior and Motion classes, which explicitly designed for users to inherit and extend. So what I would like to see is a way to add a "show protected members" link on the HTML output so by default it can be hidden, but still be available to expand for users who are going to be extending the class. A good implementation might allow individual classes to specify whether they display the protected section by default depending on expected usage. HTML_DYNAMIC_SECTIONS might be made a list of section names instead of a boolean so users could always display the inheritance graph but collapse the 'protected' stuff, and not include 'private' stuff at all... Thoughts? thanks, -Ethan |