Sign in Join

Live chat for Free Pascal, Lazarus, Delphi and every Pascal programmer.

Mailing lists / lazarus / 2011-12

Building documentation

3 messages · 2 people · –

Reply by email Subscribe to this list Your subscription

Read-only archive. Use j and k to move between messages.

Hans-Peter Diettrich

The fpdoc project feature simplifies the maintenance and building of the docmentation considerably. I've just uploaded an patch (#20787) with fpdoc projects for building the documentation for the LCL and LazUtils packages. Projects for building the RTL and FCL documentation are available on demand.

Some notes:

The latest (trunk) version of fpdoc is required, it contains a couple of updates which are missing in the release versions. Some more flaws shall be fixed soon, hopefully.

The project files must reside in the proper directory, because they contain relative references to the PAS and XML files. I found it convenient to use a user-specific filename prefix, e.g. "my", so that logfiles etc. can be found easily in a directory listing or file open dialog.

The projects assume that all FPC and Lazarus documentation resides in a common directory, the supplied projects assume \AllDocs\. Any better ideas? Most options (except booleans) can be overridden by commandline arguments, e.g.

fpdoc --project=mylcl --format=chm

For documentation writers docs\html\mkhtml.bat has been supplied, which allows to build the documentation for a single LCL unit. Usage:

mkhtml <unit> <extension>

e.g.

mkhtml controls pp

The build log goes into <unit>-log.txt, the HTML files into test\.

Any comments?

DoDi

Reply by email

Hans-Peter Diettrich
to Mattias Gaertner
Show quoted text 7 lines
On Sun, 11 Dec 2011 18:38:03 +0100 Hans-Peter Diettrich wrote: > The fpdoc project feature simplifies the maintenance and building of the > docmentation considerably. I've just uploaded an patch (#20787) Where?

Oops, #20878, and for some reason it arrived in the FPC tracker :-(

DoDi

Reply by email