On Fri, 20 Jan 2012 14:01:49 +0100
Hans-Peter Diettrich <drdiettri...@aol.com> wrote:

> Mattias Gaertner schrieb:
> 
> > The IDE registers fpdoc help for some FPC directories (rtl,
> > fcl-base/src;fcl-db/src;fcl-extra/src;fcl-process/src;fcl-web/src;paszlib/src)
> > and simply opens the URL
> > http://lazarus-ccr.sourceforge.net/docs/<fpdoc
> > path>.
> 
> Would it help to add a dummy package (or project?) with all (relevant) 
> FCL units?

You mean in the fpc sources?
Yes, such dummy packages would help the IDE to find out which unit
belongs to the FCL, which one to RTL, etc.
It could also setup the unit and include paths. Although I'm not sure
if the include file names are unique enough to use only one lpk for
the whole FCL.
Of course it can not be used for compiling, because for that you need
one lpk per output directory.

The alternative would be to store such dummy packages in the Lazarus
sources, but then it needs conditionals for every FPC version.


> Then an help author can add more units to that package, when adding docs 
> on further FCL units?

Yes.

 
> > The chmhelppkg package extends/overrides some of these settings.
> > Maybe the chm authors can give some clues about the chm parts.
> 
> Existing chm files seem to work off-the-shelf, I see no need for special 
> updates there. The critical points are how F1 finds the (CHM/HTML) file 
> for a unit, and how FPDoc Editor finds the XML file.

The IDE passes the information of the unit file name, the fpdoc
element path and the Lazarus package name of the unit to the chm
help database. I don't know what the chm db does with that.
The fpdoc editor has the same information, additionally searches all
ancestors and uses all this to search in the fpdoc paths of the
package(s) and the IDE.

Mattias

--
_______________________________________________
Lazarus mailing list
Lazarus@lists.lazarus.freepascal.org
http://lists.lazarus.freepascal.org/mailman/listinfo/lazarus

Reply via email to