diff options
| author | Jamie Bullock <jamie@jamiebullock.com> | 2014-07-17 16:31:36 +0100 |
|---|---|---|
| committer | Jamie Bullock <jamie@jamiebullock.com> | 2014-07-17 16:31:36 +0100 |
| commit | fb4a583fda06b0ba8a1cfd792982d929a6f45855 (patch) | |
| tree | 6e91b33c93b270afeffe15758e6e208a819dcb96 | |
| parent | 93395479f6f697193aa93c1369a465a8237b9340 (diff) | |
| download | LibXtract-fb4a583fda06b0ba8a1cfd792982d929a6f45855.tar.gz LibXtract-fb4a583fda06b0ba8a1cfd792982d929a6f45855.tar.bz2 LibXtract-fb4a583fda06b0ba8a1cfd792982d929a6f45855.zip | |
Add documentation information to README
| -rw-r--r-- | README.md | 14 |
1 files changed, 14 insertions, 0 deletions
@@ -111,6 +111,20 @@ To find out where your headers are: locate jni.h +## Documentation + +LibXtract headers are documented using [doxygen](http://www.stack.nl/~dimitri/doxygen/) comments. + +If you have doxygen installed, the LibXtract build system should automatically detect this during `configure` and generate [LaTeX](http://www.latex-project.org) and HTML documentation in the `doc` directory when LibXtract is built with `make`. + +The generated HTML documentation can then be viewed in a web browser by opening the file `doc/html/index.html`. + +**Pre-generated documentation can be found on the [LibXtract website](http://jamiebullock.github.io/LibXtract/documentation)** + + + + + ## License Copyright (C) 2012 Jamie Bullock |