Skip to content
This repository
tag: v464
Fetching contributors…

Cannot retrieve contributors at this time

file 36 lines (23 sloc) 0.98 kb
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36
**************************************************************************************************************
* OPADOC v1 -------> The Opa documentation generator *
**************************************************************************************************************

Opadoc is a utility written in Opa which generates an API documentation of opa source files.


build:

# ./bld opadoc/opadoc.native

This will build the 'opadoc.native' documentation generator.
In the installation, a wrapper is created, nammed opadoc.

An simple exemple:

# opadoc my_file.opa

this will generate
 - doc/index.html.
 - doc/index_values.html.
 - doc/index_types.html.
 - doc/my_file.opa.html.

Build the stdlib doc:

To build the API documentation of 'opa/stdlib'.

# opa --api-only test/empty.opa
# opadoc test -o doc

open doc/index.html and enjoy !

In general:
# opadoc FILE.opa* DIR* -o directory
# open directory/index.html
Something went wrong with that request. Please try again.