mirror of
https://github.com/Z3Prover/z3
synced 2025-04-22 08:35:31 +00:00
Removed (some) dead parameters. Added doxygen documentation for the whole code base.
Signed-off-by: Leonardo de Moura <leonardo@microsoft.com>
This commit is contained in:
parent
66b02eb88d
commit
5e7436cb50
19 changed files with 1105 additions and 845 deletions
15
doc/README
15
doc/README
|
@ -7,5 +7,16 @@ To generate the API documentation for the C, .NET and Python APIs, we must execu
|
|||
|
||||
We must have doxygen installed in our system.
|
||||
|
||||
The documentation will be stored in the subdirectory './html'.
|
||||
The main file is './html/index.html'
|
||||
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'
|
||||
|
||||
|
|
|
@ -1,4 +1,4 @@
|
|||
REM Script for updating the website containing the Z3 API documentation.
|
||||
REM You must be inside the Microsoft network to execute this script, and
|
||||
REM robocopy must be in your PATH.
|
||||
robocopy /S html \\research\root\web\external\en-us\UM\redmond\projects\z3
|
||||
robocopy /S api\html \\research\root\web\external\en-us\UM\redmond\projects\z3
|
|
@ -38,7 +38,7 @@ PROJECT_NUMBER =
|
|||
# If a relative path is entered, it will be relative to the location
|
||||
# where doxygen was started. If left blank the current directory will be used.
|
||||
|
||||
OUTPUT_DIRECTORY = .
|
||||
OUTPUT_DIRECTORY = api
|
||||
|
||||
# If the CREATE_SUBDIRS tag is set to YES, then doxygen will create
|
||||
# 4096 sub-directories (in 2 levels) under the output directory of each output
|
||||
|
|
1081
doc/z3code.dox
Normal file
1081
doc/z3code.dox
Normal file
File diff suppressed because it is too large
Load diff
Loading…
Add table
Add a link
Reference in a new issue