You have to place @exclude tag (see [http://pasdoc.sipsolutions.net/ExcludeTag]) for each such
item if you really want to remove it from documentation. In
the future @excludeBegin and @excludeEnd are planned (see [http://pasdoc.sipsolutions.net/WantedFeatures]).
I'm not sure if a general option to pasdoc and pasdoc_gui to
exclude all global variables/constants/non-class-types a
good idea. If you put something in unit's interface, then
this is technically available for anyone using your unit, so
generally it should be shown in the documentation. I know,
sometimes Pascal rules force us to expose some "internal"
things in unit interface (for example complex types of
private fields in your classes), but this should happen
seldom. So @exclude tag should be enough.
Any comments anyone ?
If you would like to refer to this comment somewhere else in this project, copy and paste the following link:
When I documented the RLBoleto's sources I had to add many @exclude tags around the code on unimportant symbols, but I think that global switches or tags aren't the solution. It's better to take the control of the documentation instead of keep them fully automatic.
If you would like to refer to this comment somewhere else in this project, copy and paste the following link:
Logged In: YES
user_id=987895
You have to place @exclude tag (see
[http://pasdoc.sipsolutions.net/ExcludeTag]) for each such
item if you really want to remove it from documentation. In
the future @excludeBegin and @excludeEnd are planned (see
[http://pasdoc.sipsolutions.net/WantedFeatures]).
I'm not sure if a general option to pasdoc and pasdoc_gui to
exclude all global variables/constants/non-class-types a
good idea. If you put something in unit's interface, then
this is technically available for anyone using your unit, so
generally it should be shown in the documentation. I know,
sometimes Pascal rules force us to expose some "internal"
things in unit interface (for example complex types of
private fields in your classes), but this should happen
seldom. So @exclude tag should be enough.
Any comments anyone ?
When I documented the RLBoleto's sources I had to add many @exclude tags around the code on unimportant symbols, but I think that global switches or tags aren't the solution. It's better to take the control of the documentation instead of keep them fully automatic.