show fpdoc?
lazarus / 9-Editor

----------------------------------------------------------------------
eMko · 2014-05-02 10:39

Hello,

is there a way how to show the documentation when typing?

E.g. I have a type called ErrandType

Code: [Select]ErrandType = (Arrival, Leave,
                BusinessArival, BusinessLeave,
                NonBussinesArrival, NonBusinessLeave);
which is documented via FPDoc editor. I have also compiled the
documentation using fpdoc command.

But how to add the documentation path so the Lazarus could find it? I
tried adding it in project and environment options, but without
success - if I put a pointer on the ErrandType somewhere in the code
and press F1, I got the error message telling that the documentation
could not be found.

The documentation looks nice in web browser but from my work
environments (Visual Studio, IntelliJ IDEA) I am used to have more
convenient way of browsing the documentation.

Thank you

----------------------------------------------------------------------
Martin_fr · 2014-05-02 10:45

I am not an exert on this.

But the help (F1) is using chm files (or if configured html). You can
compile fpdoc to chm. Though I would have to search myself, how to do
this. Also not sure wher to put the chm files then.

The fpdoc is used for the content in the hints though. If you have
added the fpdoc path, then it should show in hints.

----------------------------------------------------------------------
eMko · 2014-05-02 11:04

Thank you for fast reply!

Compiling to the chm file is pretty easy, you just use --format=chm
instead of --format=html when calling fpdoc program :-) .

I just don't know where and how to put the path to the
html/chm/whatever-else to tell the editor to search for documentation
there.

----------------------------------------------------------------------
Martin_fr · 2014-05-02 11:19

No idea myelf. but searching the wiki :
http://wiki.lazarus.freepascal.org/chmhelp

----------------------------------------------------------------------
marcov · 2014-05-02 11:39

What target and Lazarus version do you use? IIRC, the windows
installers should come with CHMs installed?

It seems SF doesn't carry 1.2.x documentation (lcl.chm)

----------------------------------------------------------------------
eMko · 2014-05-02 12:12

I use version 1.2.2 on windows.

It has preinstalled the chms for standard libraries. But I'd like to
open documentation for my library.

I can build a chm documentation - how to tell to Lazarus that it
should search documentation for my types/classes in this chm?

----------------------------------------------------------------------
marcov · 2014-05-02 13:28

I'm not entirely sure but afaik 3rd party help is currently not
pluggable into Lazarus.