Add a doc directory with a minimal doxygen configuration.
authorRalph Giles <giles@mozilla.com>
Tue, 18 Sep 2012 00:54:56 +0000 (17:54 -0700)
committerRalph Giles <giles@mozilla.com>
Tue, 18 Sep 2012 00:54:56 +0000 (17:54 -0700)
This is just to help us validate the api docs as they're
added. By using a minimal Doxyfile we save space, make
it easier to read, and avoid warnings from deprecated
and unknown options across different doxygen versions.

doc/Doxyfile [new file with mode: 0644]

diff --git a/doc/Doxyfile b/doc/Doxyfile
new file mode 100644 (file)
index 0000000..9302a4c
--- /dev/null
@@ -0,0 +1,13 @@
+# Process with doxygen to generate API documentation
+
+PROJECT_NAME           = "opusfile"
+PROJECT_NUMBER         = unknown
+PROJECT_BRIEF          = "Stand alone decoder library for .opus files."
+INPUT                  = ../include/opusfile.h
+OPTIMIZE_OUTPUT_FOR_C  = YES
+
+QUIET                  = YES
+WARNINGS               = YES
+WARN_IF_UNDOCUMENTED   = YES
+WARN_IF_DOC_ERROR      = YES
+WARN_NO_PARAMDOC       = YES