Better documentation pages.
authorMorgan Deters <mdeters@cs.nyu.edu>
Sun, 22 Jun 2014 08:37:26 +0000 (04:37 -0400)
committerMorgan Deters <mdeters@cs.nyu.edu>
Sun, 22 Jun 2014 08:37:26 +0000 (04:37 -0400)
config/doxygen.cfg
doc/mainpage.md

index 9f7205f8b38680d9d82e6eed0fa7cd6fe7281203..b36196e2ac07a278943eeb1094e9ea086e8dbb39 100644 (file)
@@ -568,17 +568,10 @@ WARN_LOGFILE           =
 # directories like "/usr/src/myproject". Separate the files or directories
 # with spaces.
 
-INPUT                  = $(SRCDIR)/AUTHORS \
-                         $(SRCDIR)/COPYING \
-                         $(SRCDIR)/INSTALL \
-                         $(SRCDIR)/NEWS \
-                         $(SRCDIR)/README \
-                         $(SRCDIR)/RELEASE-NOTES \
-                         $(SRCDIR)/THANKS \
-                         $(SRCDIR)/doc/mainpage.md \
+INPUT                  = $(SRCDIR)/doc/mainpage.md \
                          $(CVC4_DOXYGEN_INPUT)
 
-USE_MDFILE_AS_MAINPAGE = $(SRCDIR)/doc/mainpage.md
+USE_MDFILE_AS_MAINPAGE = $(SRCDIR)/doc/mainpage.md
 
 # This tag can be used to specify the character encoding of the source files
 # that doxygen parses. Internally doxygen uses the UTF-8 encoding, which is
@@ -637,7 +630,7 @@ EXCLUDE_SYMBOLS        =
 # directories that contain example code fragments that are included (see
 # the \include command).
 
-EXAMPLE_PATH           =
+EXAMPLE_PATH           = $(SRCDIR)
 
 # If the value of the EXAMPLE_PATH tag contains directories, you can use the
 # EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
index 1fc04ab3cf5a0d07eb8c54cd1e34ecbfa955898c..60e2e5ee11cbdd58699b738450738eb622eed5d3 100644 (file)
@@ -1,4 +1,5 @@
-Getting started with the CVC4 API
+/**
+\mainpage Getting started with the CVC4 API
 
 The main classes of the CVC4 API are:
 - CVC4::Expr - an expression (a formula, term, variable, constant, etc.)
@@ -24,3 +25,19 @@ For examples of Java programs using the CVC4 API, look in the directory examples
 Thank you for your interest in CVC4!
 
 The CVC4 Development team
+
+\page authors AUTHORS
+\verbinclude AUTHORS
+\page copying COPYING
+\verbinclude COPYING
+\page install INSTALL
+\verbinclude INSTALL
+\page news NEWS
+\verbinclude NEWS
+\page release-notes RELEASE-NOTES
+\verbinclude RELEASE-NOTES
+\page readme README
+\verbinclude README
+\page thanks THANKS
+\verbinclude THANKS
+*/