Explanation of some Lazarus documentation terms:
FPDoc - the command-line tool that is part of FPC and is documented in
the FPC manuals. Includes MakeSkel, for constructing a skeleton XML file
from the unit source code.
LazDE, aka Lazarus Documentation Editor - an application found in
/lazarus/docedit/lazde.lpi which you have to compile and use to edit XML
files built using MakeSkel; this is probably the most useful app for
doing the documentation, but takes a bit of getting used to.
LazDoc - part of the Lazarus IDE,; if you open a LazDoc window, you
should (if you have specified the correct paths etc) be able to edit
documentation XML files in parallel with the .pp or .pas source files.
I'm afraid I've never got it to work satisfactorily. However, it now has
a new feature (you don't even have to open a window or anything) whereby
a hinting pop-up appears if you hover over a keyword etc in your source
file in the source editor - it searches the source file and the XML file
to find information about the keyword and displays it (usually the
<short> description of the entity). It is very clever, but needs quite a
lot of tweaking (acknowledged by the developers) to correct it and make
it fully functional. I use it a lot to check on-line if the changes I
have made with LazDE produce sensible results.
There is also the option, of course, of hitting F1 for Help while
highlighting a keyword, in which case you get taken to the appropriate
SourceForge HTML file, which unfortunately can be several days out of date.
Hope this helps.
Regards - Chris
John wrote:
Chris Kirkpatrick wrote:
Hi John, Joost and Adrian -
snip
So I should very much like to collaborate with you guys in improving
the documentation of sqldb and fc-db, as well as the stuff in the
LCL. I agree we should try to use the FPDoc approach as suggested by
Joost.
snip
_
I agree with FPDoc in principle, but I haven't been able to get any
sort of handle on how it works. And I HAVE downloaded the
documentation for it and tried to read it. It was a while ago, but my
memory is that, like most IT documentation, it assumes you know
basically what you are trying to do, and just need to be reminded of
the details. I am also confused about the difference/connection
between fpdoc, lazdoc and lazde (have I even got the names right ? I
think there have been others mentioned as well on this list).
I'll try to have another read. :-)
cheers,
John Sunderland
_________________________________________________________________
To unsubscribe: mail [EMAIL PROTECTED] with
"unsubscribe" as the Subject
archives at http://www.lazarus.freepascal.org/mailarchives
_________________________________________________________________
To unsubscribe: mail [EMAIL PROTECTED] with
"unsubscribe" as the Subject
archives at http://www.lazarus.freepascal.org/mailarchives
