mirror of https://gitlab.com/cppit/jucipp
You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
20 lines
493 B
20 lines
493 B
10 years ago
|
# juCi++ API doc
|
||
|
|
|
||
|
|
## Prerequisites:
|
||
|
|
* doxygen
|
||
|
|
* plantuml
|
||
|
|
* install via apt-get or download from http://plantuml.com/
|
||
|
|
* see also http://plantuml.com/starting.html
|
||
|
|
* if downloaded either copy the jar file to /usr/bin or set the environment variable PLANTUML_PATH to point to the path containing the jar file)
|
||
|
|
|
||
|
|
## How to build the API doc:
|
||
|
|
```sh
|
||
|
|
mkdir jucipp/build
|
||
|
|
cd jucipp/build
|
||
|
|
cmake ..
|
||
|
|
make doc
|
||
|
|
```
|
||
|
|
|
||
|
|
## Where is the generated API documentation
|
||
|
|
Open jupicpp/build/src/html/index.html
|