mirrors/z3
3
0
Fork 0
mirror of https://github.com/Z3Prover/z3 synced 2025-04-28 11:25:51 +00:00
Code Activity
z3/doc
History
Dan Liew fa8f6f20a5 [Doxygen] Teach mk_api_doc.py to prevent ".NET", "Z3py" and "Java" 
bindings from appearing in the generated documentation. This can
be enabled with `--no-dotnet`, `--no-z3py`, and `--no-java`
respectively.

This fine-grained control is being added for the CMake build system
which will need this control.
2017-04-26 10:42:57 +01:00
..
mk_api_doc.py [Doxygen] Teach mk_api_doc.py to prevent ".NET", "Z3py" and "Java" 2017-04-26 10:42:57 +01:00
README Clean up README 2016-03-23 16:14:38 +01: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.in [Doxygen] Teach mk_api_doc.py to prevent ".NET", "Z3py" and "Java" 2017-04-26 10:42:57 +01:00
z3api.cfg.in [Doxygen] Teach mk_api_doc.py to prevent ".NET", "Z3py" and "Java" 2017-04-26 10:42:57 +01:00
z3code.dox C API cleanup. Mainly removal of ML-specific macros that are not used anymore and inline documentation fixes. 2015-12-03 17:33:25 +00:00

README 

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

To generate the API documentation for the C, C++, .NET, Java 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'