3
0
Fork 0
mirror of https://github.com/Z3Prover/z3 synced 2025-06-25 15:23:41 +00:00
z3/doc
LeeYoungJoon 0a93ff515d
Centralize and document TRACE tags using X-macros (#7657)
* Introduce X-macro-based trace tag definition
- Created trace_tags.def to centralize TRACE tag definitions
- Each tag includes a symbolic name and description
- Set up enum class TraceTag for type-safe usage in TRACE macros

* Add script to generate Markdown documentation from trace_tags.def
- Python script parses trace_tags.def and outputs trace_tags.md

* Refactor TRACE_NEW to prepend TraceTag and pass enum to is_trace_enabled

* trace: improve trace tag handling system with hierarchical tagging

- Introduce hierarchical tag-class structure: enabling a tag class activates all child tags
- Unify TRACE, STRACE, SCTRACE, and CTRACE under enum TraceTag
- Implement initial version of trace_tag.def using X(tag, tag_class, description)
  (class names and descriptions to be refined in a future update)

* trace: replace all string-based TRACE tags with enum TraceTag
- Migrated all TRACE, STRACE, SCTRACE, and CTRACE macros to use enum TraceTag values instead of raw string literals

* trace : add cstring header

* trace : Add Markdown documentation generation from trace_tags.def via mk_api_doc.py

* trace : rename macro parameter 'class' to 'tag_class' and remove Unicode comment in trace_tags.h.

* trace : Add TODO comment for future implementation of tag_class activation

* trace : Disable code related to tag_class until implementation is ready (#7663).
2025-05-28 14:31:25 +01:00
..
CMakeLists.txt cmake: Use FindPython3. (#7019) 2023-11-27 11:20:21 +01:00
design_recfuns.md wip: add recursive functions 2017-12-25 22:51:39 +01:00
mk_api_doc.py Centralize and document TRACE tags using X-macros (#7657) 2025-05-28 14:31:25 +01:00
mk_params_doc.py Use sys.getdefaultencoding() instead of sys.stdout.encoding (#6612) 2023-02-28 11:46:10 -08:00
mk_tactic_doc.py Use sys.getdefaultencoding() instead of sys.stdout.encoding (#6612) 2023-02-28 11:46:10 -08:00
README Clean up README 2016-03-23 16:14:38 +01:00
website.dox.in Fix warning about \ref when building website.dox 2022-08-01 18:51:20 +03:00
z3api.cfg.in Remove remaining references to Z3_bool_opt. 2022-07-30 05:48:27 +02:00
z3code.dox Remove remaining references to Z3_bool_opt. 2022-07-30 05:48:27 +02:00

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'