shithub: opusfile

Info  •  Files  •  Log  •  Branches

Add a doc directory with a minimal doxygen configuration.

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.

--- /dev/null

+++ b/doc/Doxyfile

@@ -1,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