From 67caeb6e3cda44205ba8fe783274b20dc7ea216e Mon Sep 17 00:00:00 2001 From: jacqueline Date: Wed, 9 Aug 2023 12:00:02 +1000 Subject: Use opusfile instead of working directly with ogg and opus --- lib/opusfile/doc/Doxyfile.in | 22 ++++++ lib/opusfile/doc/Makefile | 35 +++++++++ lib/opusfile/doc/opus_logo.svg | 157 +++++++++++++++++++++++++++++++++++++++++ 3 files changed, 214 insertions(+) create mode 100644 lib/opusfile/doc/Doxyfile.in create mode 100644 lib/opusfile/doc/Makefile create mode 100644 lib/opusfile/doc/opus_logo.svg (limited to 'lib/opusfile/doc') diff --git a/lib/opusfile/doc/Doxyfile.in b/lib/opusfile/doc/Doxyfile.in new file mode 100644 index 00000000..d0b229c6 --- /dev/null +++ b/lib/opusfile/doc/Doxyfile.in @@ -0,0 +1,22 @@ +# Process with doxygen to generate API documentation + +PROJECT_NAME = @PACKAGE_NAME@ +PROJECT_NUMBER = @PACKAGE_VERSION@ +PROJECT_BRIEF = "Stand-alone decoder library for .opus files." +INPUT = @top_srcdir@/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 + +JAVADOC_AUTOBRIEF = YES +SORT_MEMBER_DOCS = NO + +HAVE_DOT = @HAVE_DOT@ + +PROJECT_LOGO = @top_srcdir@/doc/opus_logo.svg + +FULL_PATH_NAMES = NO diff --git a/lib/opusfile/doc/Makefile b/lib/opusfile/doc/Makefile new file mode 100644 index 00000000..1ae1adc9 --- /dev/null +++ b/lib/opusfile/doc/Makefile @@ -0,0 +1,35 @@ +## GNU makefile for opusfile documentation. + +-include ../package_version + +all: doxygen + +doxygen: Doxyfile ../include/opusfile.h + doxygen + +pdf: doxygen + make -C latex + +clean: + $(RM) -r html + $(RM) -r latex + +distclean: clean + $(RM) Doxyfile + +.PHONY: all clean distclean doxygen pdf + +../package_version: + @if [ -x ../update_version ]; then \ + ../update_version || true; \ + elif [ ! -e $@ ]; then \ + echo 'PACKAGE_VERSION="unknown"' > $@; \ + fi + +# run autoconf-like replacements to finalize our config +Doxyfile: Doxyfile.in Makefile ../package_version + sed -e 's/@PACKAGE_NAME@/opusfile/' \ + -e 's/@PACKAGE_VERSION@/$(PACKAGE_VERSION)/' \ + -e 's/@HAVE_DOT@/yes/' \ + -e 's/@top_srcdir@/../' \ + < $< > $@ diff --git a/lib/opusfile/doc/opus_logo.svg b/lib/opusfile/doc/opus_logo.svg new file mode 100644 index 00000000..794dd1dc --- /dev/null +++ b/lib/opusfile/doc/opus_logo.svg @@ -0,0 +1,157 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + -- cgit v1.2.3