From: Brian Norris Date: Wed, 5 Jun 2013 02:06:35 +0000 (-0700) Subject: docs: improve Doxygen documentation X-Git-Url: http://plrg.eecs.uci.edu/git/?p=cdsspec-compiler.git;a=commitdiff_plain;h=c048e51dd194c09e76f6c1ec91b0e48a2a0f94d1 docs: improve Doxygen documentation * Fix the PROJECT_NAME title * Add include/ to documentation * Include our generated README.html as the main page in the docs - NOTE: Doxygen 1.8.0+ can directly generate documentation from the Markdown format (i.e., README.md). This may be useful in the future to get more integrated support, but for now, the separately-generated HTML is good enough --- diff --git a/Doxyfile b/Doxyfile index bb09915..ed9f000 100644 --- a/Doxyfile +++ b/Doxyfile @@ -26,7 +26,7 @@ DOXYFILE_ENCODING = UTF-8 # identify the project. Note that if you do not use Doxywizard you need # to put quotes around the project name if it contains spaces. -PROJECT_NAME = "Model Checker" +PROJECT_NAME = "CDSChecker: A Model Checker for C11/C++11 Atomics" # The PROJECT_NUMBER tag can be used to enter a project or revision number. # This could be handy for archiving the generated documentation or @@ -661,7 +661,8 @@ WARN_LOGFILE = # directories like "/usr/src/myproject". Separate the files or directories # with spaces. -INPUT = +INPUT = . include/ include/atomic include/condition_variable include/cstdatomic include/mutex + # 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 @@ -721,7 +722,7 @@ EXCLUDE_SYMBOLS = # directories that contain example code fragments that are included (see # the \include command). -EXAMPLE_PATH = +EXAMPLE_PATH = . # 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 diff --git a/mainpage.dox b/mainpage.dox new file mode 100644 index 0000000..a311802 --- /dev/null +++ b/mainpage.dox @@ -0,0 +1,4 @@ +/** + * @mainpage + * @htmlinclude README.html + */