From 4b27eae47fe28bc79f39c0f4974f237774f3880f Mon Sep 17 00:00:00 2001
From: Leonardo de Moura <leonardo@microsoft.com>
Date: Thu, 22 Nov 2012 18:41:43 -0800
Subject: [PATCH] using doxygen to document z3py API

Signed-off-by: Leonardo de Moura <leonardo@microsoft.com>
---
 doc/mk_api_doc.py  | 3 +++
 doc/website.dox    | 2 +-
 doc/z3api.dox      | 1 +
 src/api/c++/z3++.h | 3 +++
 4 files changed, 8 insertions(+), 1 deletion(-)

diff --git a/doc/mk_api_doc.py b/doc/mk_api_doc.py
index 5a6fef57f..6e530243a 100644
--- a/doc/mk_api_doc.py
+++ b/doc/mk_api_doc.py
@@ -25,6 +25,7 @@ try:
     mk_dir('api/html')
     mk_dir('tmp')
     shutil.copyfile('website.dox', 'tmp/website.dox')
+    shutil.copyfile('../src/api/python/z3.py', 'tmp/z3py.py')
     cleanup_API('../src/api/z3_api.h', 'tmp/z3_api.h')
     
     print "Removed annotations from z3_api.h."
@@ -40,6 +41,8 @@ try:
     print "Removed temporary file z3_api.h."
     os.remove('tmp/website.dox')	
     print "Removed temporary file website.dox"
+    os.remove('tmp/z3py.py')	
+    print "Removed temporary file z3py.py"
     os.removedirs('tmp')
     print "Removed temporary directory tmp."
     sys.path.append('../src/api/python')
diff --git a/doc/website.dox b/doc/website.dox
index 685bc0af1..efbf71f56 100644
--- a/doc/website.dox
+++ b/doc/website.dox
@@ -13,6 +13,6 @@
    - \ref capi 
    - \ref cppapi
    - <a class="el" href="class_microsoft_1_1_z3_1_1_context.html">.NET API</a>
-   - <a class="el" href="z3.html">Python API</a>
+   - <a class="el" href="namespacez3py.html">Python API</a> (also available in <a class="el" href="z3.html">pydoc format</a>).
    - Try Z3 online at <a href="http://rise4fun.com/z3py">RiSE4Fun</a> using <a href="http://rise4fun.com/z3py">Python</a> or <a href="http://rise4fun.com/z3">SMT 2.0</a>.
 */
diff --git a/doc/z3api.dox b/doc/z3api.dox
index 4ec574983..07c7fe0dc 100644
--- a/doc/z3api.dox
+++ b/doc/z3api.dox
@@ -709,6 +709,7 @@ INPUT_ENCODING         = UTF-8
 FILE_PATTERNS          = website.dox \
                          z3_api.h \
                          z3++.h \
+                         z3py.py \
                          ApplyResult.cs \
                          AST.cs \
                          ASTMap.cs \
diff --git a/src/api/c++/z3++.h b/src/api/c++/z3++.h
index 6ab087f9d..7fc36575a 100644
--- a/src/api/c++/z3++.h
+++ b/src/api/c++/z3++.h
@@ -39,6 +39,9 @@ Notes:
 */
 /*@{*/
 
+/**
+   \brief Z3 C++ namespace
+*/
 namespace z3 {
 
     class exception;