On Mon, 27 Nov 2006 14:28:34 +0200
"Graeme Geldenhuys" <[EMAIL PROTECTED]> wrote:
> Hi,
>
> How well does the LazDoc support work inside the IDE? For example, I
> see the LazDoc tab in the Project Options dialog. I also see the View
> -> LazDoc Editor option. Unfortunately there is no help written on the
> wiki about these options yet.
There are some ToDos (see below) left, but basically it works like this:
Open lcl/buttons.pp
Place the cursor on TButton's property Align.
View -> LazDoc Editor
It will search and load the lcl fpdoc xml files and shows the
help content of TButton.Align (and the inherited entry TControl.Align).
You can edit the items for this entry. Move the source editor cursor to
go to other fpdoc entries.
> How does this actually work? I only know the LazDoc external
> (standalone) editor.
> Can I document packages used by my application, while my application
> is open?
Lazdoc edits fpdoc xml files. So, yes, you can edit while the
application is open. But there are some ToDos. See below.
> Does the warning about absolute paths still apply in the "Project
> Options" -> LazDoc tab?
No. Thanks for the hint. I removed it.
> Does that mean I can only document classes
> inside the same directory as the .lpi file.
No, you can add any number of relative search paths.
ToDo:
- Fix bugs: the update function sometimes looses the inheritage.
- Add a lazdoc search path for packages.
- Undo function
- auto create missing fpdoc entries (e.g. after adding a method to the
source). Basically the same as makeskel does, but on the fly for single
entries. This is started for attributes and simple elements, but not
yet for complex things like classes, methods, types, ... .
- use package/project fpdoc help when pressing F1. At the moment you
have to manually register it via design time packages. The idea is: As
soon as the lazdoc search path is set for a package: use it.
- IDE feature: setup fpdoc help for projects/packages: run makeskel
- search functions
- search & replace functions
...
Mattias
_________________________________________________________________
To unsubscribe: mail [EMAIL PROTECTED] with
"unsubscribe" as the Subject
archives at http://www.lazarus.freepascal.org/mailarchives
