PageRenderTime 23ms CodeModel.GetById 19ms app.highlight 1ms RepoModel.GetById 1ms app.codeStats 0ms

/examples/helpforpackage/README.txt

http://github.com/graemeg/lazarus
Plain Text | 16 lines | 9 code | 7 blank | 0 comment | 0 complexity | af74cf8d9e8e000a7fb662aaa74abe4e MD5 | raw file
 1This package (demopackagewithhelp.lpk) demonstrates how to register help in the
 2IDE for the sources of a package.
 3
 4The help itself is in fpdoc format.
 5Here is an example how to create the basic fpdoc xml file from the source:
 6
 7makeskel --package=demopackagewithhelp --input=pkghelpdemounit1.pas --output=xml/pkghelpdemounit1.xml
 8
 9Use the program LazDE (lazarus/doceditor/lazde.lpi)
10or LazDoc tool in the IDE to write some documentation.
11
12Then create the html files from the xml files:
13
14cd html && fpdoc --package=demopackagewithhelp --descr=../xml/pkghelpdemounit1.xml --input=../pkghelpdemounit1.pas
15
16