lazarus

mirror of https://gitlab.com/freepascal.org/lazarus/lazarus.git synced 2025-04-27 19:13:52 +02:00

History

mattias 2996a3c332 rename COPYING.modifiedLGPL to COPYING.modifiedLGPL.txt git-svn-id: trunk@15834 -		2008-07-22 09:48:15 +00:00
..
html	added example to add IDE help for the sources of a package	2006-09-19 22:25:33 +00:00
xml	added example to add IDE help for the sources of a package	2006-09-19 22:25:33 +00:00
demopackagewithhelp.lpk	added example to add IDE help for the sources of a package	2006-09-19 22:25:33 +00:00
demopackagewithhelp.pas	added example to add IDE help for the sources of a package	2006-09-19 22:25:33 +00:00
pkghelpdemounit1.pas	rename COPYING.modifiedLGPL to COPYING.modifiedLGPL.txt	2008-07-22 09:48:15 +00:00
README.txt	added example to add IDE help for the sources of a package	2006-09-19 22:25:33 +00:00

README.txt

This package (demopackagewithhelp.lpk) demonstrates how to register help in the
IDE for the sources of a package.

The help itself is in fpdoc format.
Here is an example how to create the basic fpdoc xml file from the source:

makeskel --package=demopackagewithhelp --input=pkghelpdemounit1.pas --output=xml/pkghelpdemounit1.xml

Use the program LazDE (lazarus/doceditor/lazde.lpi)
or LazDoc tool in the IDE to write some documentation.

Then create the html files from the xml files:

cd html && fpdoc --package=demopackagewithhelp --descr=../xml/pkghelpdemounit1.xml --input=../pkghelpdemounit1.pas