On Tue, 14 Feb 2012, Graeme Geldenhuys wrote:
On 14 February 2012 04:54, waldo kitty wrote:
so, basically, i'm working on the documentation and write a "local" note
that only belongs on my machine so that it doesn't "pollute" the
documentation...
This is something that does not belong in FPDoc.
Such functionality belongs in the viewer one uses for the output of FPDoc.
This is exactly how DocView's annotations work, and this is exactly
how I improve FPC and fpGUI documentation. I don't always have time to
immediately edit the XML documentation files (because I'm busy with
another task). But I often see a spelling or grammar mistake in the
docs, or note that something could be extended. I then quickly add an
annotation using DocView (seeing that it is already open and viewing
the topic in question). I can then later revisit all these annotations
and fix the real documentation.
As I mentioned before, I also use annotation for adding other personal
notes to extend the existing documentation so it makes it better for
myself - those are personal notes.
All annotations in DocView are stored in an external *.notes file that
travels with the *.inf files. I normally keep my *.inf files on a USB
flash drive because that always travels with me from computer to
computer. So my help files and personal notes travel with me.
PDF readers (okular and acrobat) have the same functionality.
Michael.
--
_______________________________________________
Lazarus mailing list
Lazarus@lists.lazarus.freepascal.org
http://lists.lazarus.freepascal.org/mailman/listinfo/lazarus
