New C++ Api: Initial setup of Api documentation. (#6295)

This configures the initial setup for generating Api documentation with
Sphinx via Breathe and Doxygen. All fixes in the documentation of the
cvc5.h header are for the purpose of eliminating warnings. This PR does
not check for completeness of the documentation, and does not yet tweak
the documentation to be nice, beautiful and consistent, which is
postponed to future PRs.

Configure with `--docs`, and then make. This will generate a `docs`
directory in the build directory. The Sphinx documentation can be found
at `build/docs/sphinx/index.html`. Doxygen documentation is only
generated as xml under `build/docs/doxygen`.

This PR further proposes a new style for copyright headers. If this
style is approved, I will submit a PR to update the update_copyright.pl
script.

1 files changed, 7 insertions, 0 deletions

diff --git a/configure.sh b/configure.sh
index 63d40403a..cf6556375 100755
--- a/configure.sh
+++ b/configure.sh
@@ -25,6 +25,7 @@ General options;
   --arm64                  cross-compile for Linux ARM 64 bit
   --win64                  cross-compile for Windows 64 bit
   --ninja                  use Ninja build system
+  --docs                   build Api documentation
 
 
 Features:
@@ -117,6 +118,7 @@ coverage=default
 cryptominisat=default
 debug_context_mm=default
 debug_symbols=default
+docs=default
 dumping=default
 glpk=default
 gpl=default
@@ -238,6 +240,9 @@ do
 
     --ninja) ninja=ON;;
 
+    --docs) docs=ON;;
+    --no-docs) docs=OFF;;
+
     --glpk) glpk=ON;;
     --no-glpk) glpk=OFF;;
 
@@ -379,6 +384,8 @@ cmake_opts=""
   && cmake_opts="$cmake_opts -DENABLE_UNIT_TESTING=$unit_testing"
 [ $python2 != default ] \
   && cmake_opts="$cmake_opts -DUSE_PYTHON2=$python2"
+[ $docs != default ] \
+  && cmake_opts="$cmake_opts -DBUILD_DOCS=$docs"
 [ $python_bindings != default ] \
   && cmake_opts="$cmake_opts -DBUILD_BINDINGS_PYTHON=$python_bindings"
 [ $java_bindings != default ] \