From 5708daaac78361a8fd8677bf4387bd49694d2e57 Mon Sep 17 00:00:00 2001 From: Daniel Caujolle-Bert Date: Thu, 19 Apr 2001 23:13:09 +0000 Subject: Add doxygen support. just do 'make docs', and html version will be created into doc/xine-lib-API/html subdir. This is a pre-alpha API documentation, you're warned ;-). CVS patchset: 7 CVS date: 2001/04/19 23:13:09 --- doc/Makefile.am | 19 +++++++++++++++++-- doc/xine-lib-API.cfg | 27 +++++++++++++++++++++++++++ 2 files changed, 44 insertions(+), 2 deletions(-) create mode 100644 doc/xine-lib-API.cfg (limited to 'doc') diff --git a/doc/Makefile.am b/doc/Makefile.am index a463f1b98..79c4deebc 100644 --- a/doc/Makefile.am +++ b/doc/Makefile.am @@ -1,7 +1,7 @@ SUBDIRS = man -EXTRA_DIST = $(docs_DOCS) MRL.txt dataflow.dia +EXTRA_DIST = $(docs_DOCS) MRL.txt dataflow.dia xine-lib-API.cfg docdir = $(prefix)/share/doc/xine docs_DOCS = README README.syncfb README.freebsd FAQ bug_report_form @@ -30,12 +30,27 @@ uninstall-local: done +docs: + @if test x"$$DOXYGEN" != "xno"; then \ + echo -n " + Creating docs: "; \ + cp ../misc/xine_logo.png ./xine-lib-API; \ + echo -e "\n\n\$$projectname\n\"xine\n\n\n" > ./xine-lib-API/xine_header.html; \ + $(DOXYGEN) xine-lib-API.cfg; \ + echo "done.";\ + fi + + +erase-docs: + @rm -rf xine-lib-API/html + @rm xine-lib-API/xine_header.html xine-lib-API/xine_logo.png + + debug: mostlyclean-generic: -rm -f *~ \#* .*~ .\#* -maintainer-clean-generic: +maintainer-clean-generic: erase-docs -@echo "This command is intended for maintainers to use;" -@echo "it deletes files that may require special tools to rebuild." -rm -f Makefile.in diff --git a/doc/xine-lib-API.cfg b/doc/xine-lib-API.cfg new file mode 100644 index 000000000..021e283cc --- /dev/null +++ b/doc/xine-lib-API.cfg @@ -0,0 +1,27 @@ +PROJECT_NAME = "XINE, A Free Video Player Project - API reference" +OUTPUT_DIRECTORY = xine-lib-API +GENERATE_LATEX = NO +GENERATE_MAN = NO +GENERATE_RTF = NO + +HTML_HEADER = xine-lib-API/xine_header.html + +WARNINGS = YES + +CASE_SENSE_NAMES = NO +RECURSIVE = YES +FILE_PATTERNS = *.c *.h +QUIET = YES + +INPUT = ../include/xine.h + +EXTRACT_ALL = NO +EXTRACT_STATIC = NO +SHOW_INCLUDE_FILES = NO +JAVADOC_AUTOBRIEF = NO +INHERIT_DOCS = YES +ENABLED_SECTIONS = "" +PREDEFINED = "DOC_HIDDEN" + +OPTIMIZE_OUTPUT_FOR_C = YES +DISABLE_INDEX = NO -- cgit v1.2.3