Quick start

The simpler way to get the documentation of your database magically appears is to change the file “conf.properties” with your database connection params.
Then choose the kind of report you need (html, htmlsinglepage, pdf) and execute the relative ant task.
The docs will be placed in the directory “target/docbook“.

NOTE: the docbook transformation uses DBF (DocBook Framework, http://velocity.apache.org/docbook/), that seems to have a bug if you launch “htmlsingle” without having ever launched “html” (it uses a tmp directory that is updated with “html”).

More documentation will come soon, in a docbook format too 🙂

Advertisements

Leave a Reply

Fill in your details below or click an icon to log in:

WordPress.com Logo

You are commenting using your WordPress.com account. Log Out / Change )

Twitter picture

You are commenting using your Twitter account. Log Out / Change )

Facebook photo

You are commenting using your Facebook account. Log Out / Change )

Google+ photo

You are commenting using your Google+ account. Log Out / Change )

Connecting to %s

%d bloggers like this: