3
0
Fork 0
mirror of https://github.com/Z3Prover/z3 synced 2025-04-06 09:34:08 +00:00
z3/doc
Christoph M. Wintersteiger 0713535fa6 Documentation website fixes.
Signed-off-by: Christoph M. Wintersteiger <cwinter@microsoft.com>
2014-10-24 21:00:23 +01:00
..
mk_api_doc.py Documentation fixes 2014-10-24 19:45:21 +01:00
README Merge branch 'unstable' of https://git01.codeplex.com/z3 into unstable 2012-11-22 17:09:36 -08:00
update_api_website.cmd improved Z3 documentation 2012-11-22 17:09:30 -08:00
update_code_website.cmd updated API doc generation 2012-11-22 18:16:58 -08:00
website.dox Documentation website fixes. 2014-10-24 21:00:23 +01:00
z3api.dox Documentation fixes 2014-10-24 19:45:21 +01:00
z3code.dox improved Z3 documentation 2012-11-22 17:09:30 -08:00

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'