[fpc-pascal] fpdoc automation help

Graeme Geldenhuys graemeg.lists at gmail.com
Thu Sep 14 16:54:33 CEST 2006


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! ;-)

     /html            <==== generate html from fpdoc
       /build_core.sh         <===== 3 build scripts
          /examples            <==== small code samples
          /tiobjects.xml            <==== xml documentation
          <... *.xml  ...>          <==== all other .xml files
          <... *.xml  ...>
          <... *.xml  ...>
        /tiObjects.pas            <==== all core source code
        <... *.pas  ...>
        /tiSomeOptions.pas   <==== all options source code
        <... *.pas  ...>
        /tiGUIUtils.pas           <==== all gui components source code
        <... *.pas  ...>

  - Graeme -

There's no place like

More information about the fpc-pascal mailing list