3
0
Fork 0
mirror of https://github.com/Z3Prover/z3 synced 2026-07-06 15:26:15 +00:00
z3/doc
Dan Liew a6a6a9c29f [Doxygen] Fix link to ".NET" documentation it should point to the
"Microsoft.Z3" namespace, not the "Microsoft.Z3.Context" class.

This mirrors the link provided for the Java API.
2017-04-26 11:02:36 +01:00
..
mk_api_doc.py [Doxygen] Fix link to ".NET" documentation it should point to the 2017-04-26 11:02:36 +01:00
README
update_api_website.cmd improved Z3 documentation 2012-11-22 17:09:30 -08:00
update_code_website.cmd
website.dox.in
z3api.cfg.in
z3code.dox

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'