Menu ▾ ▴

Tree [464b8d] master /
 History

HTTPS git://
HTTPS access

File Date Author Commit
 diagrams 2007-03-29 Graeme Geldenhuys Graeme Geldenhuys [3dd128] * update some of the documentation build scripts.
 html 2015-02-08 Graeme Geldenhuys Graeme Geldenhuys [fd0882] Removes html/* files we don't need any more.
 model-gui-mediator 2009-04-24 Graeme Geldenhuys Graeme Geldenhuys [b79ec8] * Updated MGM docs readme file.
 xml 2016-10-14 Graeme Geldenhuys Graeme Geldenhuys [464b8d] tiVisitor: defines what information needs to be...
 README.txt 2015-02-08 Graeme Geldenhuys Graeme Geldenhuys [2d820a] Adds a README file explaining the usage
 pretty_print.xsl 2007-02-22 Graeme Geldenhuys Graeme Geldenhuys [e910c4] * Added two helper xsl files to reformat ugly x...
 remove_whitespace.xsl 2007-02-22 Graeme Geldenhuys Graeme Geldenhuys [0862fb] * fixes some svn property settings on files.
 tiopf-docs-project.xml 2015-06-17 Graeme Geldenhuys Graeme Geldenhuys [109870] Some new documentation for the tiOPFManager.pas...

Read Me

To build new documentation the following directory layout is assumed.

  <some_dir>/tiopf/                           [1]
  <some_dir>/tiopf_docs/                      [2]
  
  
1: This is where the cloned fpGUI repository lives.
2: This is where the cloned fpGUI_docs repository lives.


Usage:
------
   fpdoc --project=tiopf-docs-project.xml


Note:
-----
At the time of writing, fpdoc doesn't have the ability to configure
multiple output formats in the XML project file. So you need to
comment/uncomment the output type and options you want. They are
clearly commented in the XML file.

I'm in the process of submitting a patch to fpdoc to allow multiple
configurations. I'll update this README file as soon as the functionality
is available.


                         ----------- oOo ----------
MongoDB Logo MongoDB