Hi,
I am trying to setup some script(s) or a Makefile (if I can) to handle
the documentation of tiOPF (open source project I work on and core of
our projects).
* How does FPC handle the creation of html output using fpdoc? From
what I can see it looks like everything is handled in a single
Makefile.fpc (quite complex but guess it work well)
* How does it handle updates to the source code, without overwriting
existing *.xml files.
* If running makeskel in update mode, how do you combine that *.xml
file to the existing description *.xml file?
* Is all the above done in some nightly event (automagically)...?
So far I have created the following directory layout. I can only
modify the Docs directory, the others are cast in stone. I had a look
at the Lazarus docs layout as well, for some ideas. If I could
automate the creation and updating of docs in some nightly event, it
would be a perfect world! ;-)
tiOPF
/Docs
/html <==== generate html from fpdoc
/xml
/build_core.sh <===== 3 build scripts
/build_gui.sh
/build_options.sh
/core
/examples <==== small code samples
/tiobjects.xml <==== xml documentation
<... *.xml ...> <==== all other .xml files
/gui
/examples
/tiobjects.xml
<... *.xml ...>
/options
/examples
/tiobjects.xml
<... *.xml ...>
/Source
/Core
/tiObjects.pas <==== all core source code
<... *.pas ...>
/Options
/tiSomeOptions.pas <==== all options source code
<... *.pas ...>
/GUI
/tiGUIUtils.pas <==== all gui components source code
<... *.pas ...>
Regards,
- Graeme -
--
There's no place like 127.0.0.1
_______________________________________________
fpc-pascal maillist - fpc-pascal@lists.freepascal.org
http://lists.freepascal.org/mailman/listinfo/fpc-pascal
