Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP

Fetching latest commit…

Cannot retrieve the latest commit at this time

..
Failed to load latest commit information.
common
generator
js
resources
server
README
_tags
opadoc.css
opadoc.depends
opadoc.index.html.down.src
opadoc.index.html.up.src
opadoc.js
opadoc.opack

README

**************************************************************************************************************
*                  OPADOC v1 -------> The Opa documentation generator                                        *
**************************************************************************************************************

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


build:

# make 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




HOW TO BUILD DOC:

First you need to compile opalang with api files:
      cd $(OPALANG)
      make all packages-api

Then generate the HTML documentation:
- cd $(OPALANG)/opadoc
- opa opadoc.opack
- considering DOC_PATH=static_doc and DOCS=$(OPALANG)/_build/stdlib
- _build/generator/opaDoc/opaDoc.exe -o $(DOC_PATH) $(DOCS)
- your doc should be in $(DOC_PATH)
- open $(DOC_PATH)/index.html in your favorite browser
Something went wrong with that request. Please try again.