|
From: Michalis K. <mic...@gm...> - 2008-10-14 19:23:52
|
Hans-Peter Diettrich wrote: > Now I've implemented in PasDoc2 a first version of an group tag, for > enums. The tag requires an group name, and an optional group > description. Then the tagged members are moved into added Values lists, > which are shown only by the FullHTML generator. > > In the next step @groupstart and @groupend tags will be added. Some > opinions are required, before the groups will become applicable to other > items, like constants. Most important: How should groups be presented in > the docs? > Groups are not supposed to be named (groups should never need names --- @groupwith() takes as a parameter any identifier name already belonging to the group). You already read [http://pasdoc.sipsolutions.net/MichalisKamburelis] --- a few grouped items are presented as a block of declarations followed by one description. I attach HTML mockup how I imagine { One comment that describes at once three procedures Foo, Bar and Xyz. @groupbegin } procedure Foo; procedure Bar; procedure Xyz; { @groupend } should look like in HTMl output (TGenericHTMLDocGenerator, to be usable both by full HTML and htmlhelp). If you already implemented something working in a different way, please at least document it in the wiki (e.g. on your home page). Michalis |