[fpc-pascal] Re: [Lazarus] Adding Notes in FPDoc

[Graeme Geldenhuys]

On 11 February 2012 12:23, Michael Van Canneyt wrote:
>
> Seeing the discussions about annotating the documentation created by FPDoc,
> I added support for notes.
> (revision 20304)


Thank you Michael, this should definitely come in handy for some people.

I also investigated this functionality further with INF and DocView.
The INF specification has support for a "hide" function. These HIDE
tags takes into account an environment variable in the OS,  which
tells the INF viewer if that content should be displayed or not. INF
takes it one step further and even allows you to specify various
"access levels" separated by a + sign (eg: set IPF_KEYS=LEVEL1+LEVEL2)
to have even more fine-grained control over which notes are displayed
or not.

So based on this, fpdoc notes could be displayed or hidden using a
single INF file - simply by toggling the value of the IPF_KEYS
environment variable.

I'll pull the latest fpdoc code and experiment with this functionality
a bit more.


-- 
Regards,
  - Graeme -


_______________________________________________
fpGUI - a cross-platform Free Pascal GUI toolkit
http://fpgui.sourceforge.net