3
0
Fork 0
mirror of https://github.com/Z3Prover/z3 synced 2025-05-10 01:05:47 +00:00
z3/doc
Leonardo de Moura 99d0449272 added Java docs
Signed-off-by: Leonardo de Moura <leonardo@microsoft.com>
2012-12-10 07:51:45 -08:00
..
mk_api_doc.py
README
update_api_website.cmd
update_code_website.cmd
website.dox added Java docs 2012-12-10 07:51:45 -08:00
z3api.dox added Java docs 2012-12-10 07:51:45 -08:00
z3code.dox

API documentation
-----------------

To generate the API documentation for the C, .NET and Python APIs, we must execute

   python mk_api_doc.py

We must have doxygen installed in our system.

The documentation will be stored in the subdirectory './api/html'.
The main file is './api/html/index.html'

Code documentation
------------------

To generate documentation for the Z3 code, we must execute

   doxygen z3code.dox

We must also have dot installed in our system.

The documentation will be store in the subdirectory './code/html'.
The main file is './code/html/index.html'