3
0
Fork 0
mirror of https://github.com/Z3Prover/z3 synced 2025-04-06 17:44:08 +00:00
z3/doc/README
Leonardo de Moura 5e7436cb50 Removed (some) dead parameters. Added doxygen documentation for the whole code base.
Signed-off-by: Leonardo de Moura <leonardo@microsoft.com>
2012-11-22 10:06:24 -08:00

23 lines
530 B
Plaintext

API documentation
-----------------
To generate the API documentation for the C, .NET and Python APIs, we must execute
python mk_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
The documentation will be store in the subdirectory './code/html'.
The main file is './code/html/index.html'