lazarus/examples/fpdocmanager
dodi fd406b79ea DocMgr: added documentation
git-svn-id: trunk@34710 -
2012-01-11 13:48:51 +00:00
..
docs DocMgr: added documentation 2012-01-11 13:48:51 +00:00
fconfig.lfm
fconfig.pas
flogview.lfm
flogview.pas
fmain.lfm DocMgr: added documentation 2012-01-11 13:48:51 +00:00
fmain.pas DocMgr: added documentation 2012-01-11 13:48:51 +00:00
fpdocengine.lpk DocMgr: added documentation 2012-01-11 13:48:51 +00:00
FPDocManager.lpi DocMgr: added documentation 2012-01-11 13:48:51 +00:00
FPDocManager.lpr DocMgr: added documentation 2012-01-11 13:48:51 +00:00
fupdateview.lfm
fupdateview.pas
README.txt
ulpk.pp DocMgr: added documentation 2012-01-11 13:48:51 +00:00
umakeskel.pas DocMgr: added documentation 2012-01-11 13:48:51 +00:00
umanager.pas DocMgr: added documentation 2012-01-11 13:48:51 +00:00

The FPDoc documentation manager
===============================

This project simplifies the maintenance of (local) documentation.
A configuration wizard helps in the setup of the basic RTL, FCL and LCL docs.
Configuration and output is kept in a single user selectable directory.

A package FPDocEngine is supplied for use in commandline or GUI applications.
uMakeSkel is a copy of parts of the FPDoc and MakeSkel programs, modified
with workarounds for known problems with these FPC tools.

Organization
------------
A dedicated directory contains all package specifications and documentation.
INI files are created for the manager itself and every package.

Release notes 1.0
-----------------

The FPDoc Manager requires FPC 2.7 (rev. 19947) for proper operation of the
FPDoc units.

A package FPDocEngine.lpk has been created for the FPDoc units, please move it
into your $FPC/utils/fpdoc/ directory and compile the package there.

The project (FPDocManager.lpi) did not fully compile on my machine. Unit
dw_HTML could not be found, even if all other units of the package worked.
Adding the unit directly to the project made it compile, please remove or
update this entry as required, and give hints on how to fix the problem.

DoDi