API Documentation - bobjervis/parasol GitHub Wiki

You may generate a set of API documentation web pages by running the following command:

paradoc -X . -c /usr/parasol/latest/doc/parasol <output-directory> /usr/parasol/latest/src/lib

The output directory will be created if it doesn't exist. If it does exist it must be writeable and all current contents will be erased before writing new content to it..

The command should produce output like:

Writing to <output-directory> [0] Library /usr/parasol/latest/src/lib Could not read template2.html file from /usr/parasol/v0.1.0/bin/../template/template2.html When done, there should be a file named index.html in the output directory (along with a lot of other stuff). Load that page into your browser and you will see a page with a table of contents and links to further documentation.

The runtime API documentation is incomplete.

There are also bugs in the document generator that does not display full documentation for templates, among other bugs.