Documentation

Note:

Reviewed for release 2.13.0.

Orca documentation is in HTML format and is generated by Doxygen (http://doxygen.org). You have 3 options on how to access it.

View On-line

• Latest release: http://orca-robotics.sf.net/orca

Download Archive

• Latest release: http://orca-robotics.sf.net/orca/orca-release-doc.tar.gz

Build Locally

First, download a hacked version of Doxygen from http://orca-robotics.sf.net/download/doxyorca which can compile documentation from Slice (.ice) files. This binary was compiled on Debian Linux. We have submitted a patch to Doxygen developers but haven't heard back from them.

To generate documentation, go to the doc directory on the top level of the Orca distribution. This works for both Orca releases and the SVN version.

$ cd [ORCA-SRC]/doc
$ doxyorca doxyfile

The documentation is created in a new directory called html. Open [ORCA-SRC]/doc/html/index.html in your browser.

If you can't download doxyorca or the binary doesn't work on your machine, you can use the standard version of Doxygen but you will be missing the Slice documentation for Orca interfaces.