From d93a2cb4462a61f345be13021c79275c932c327d Mon Sep 17 00:00:00 2001 From: Rafael Antognolli Date: Wed, 29 Jun 2011 20:13:37 +0000 Subject: [PATCH] emotion/doc - doc build now uses the build system, instead gendoc. SVN revision: 60839 --- legacy/emotion/Makefile.am | 17 ++++++++--- legacy/emotion/configure.ac | 5 +++ legacy/emotion/{Doxyfile => doc/Doxyfile.in} | 18 ++++++----- legacy/emotion/doc/Makefile.am | 32 ++++++++++++++++++++ legacy/emotion/doc/emotion.dox.in | 24 +++++++++++++++ legacy/emotion/emotion.c.in | 22 -------------- legacy/emotion/gendoc | 16 ---------- 7 files changed, 84 insertions(+), 50 deletions(-) rename legacy/emotion/{Doxyfile => doc/Doxyfile.in} (90%) create mode 100644 legacy/emotion/doc/Makefile.am create mode 100644 legacy/emotion/doc/emotion.dox.in delete mode 100644 legacy/emotion/emotion.c.in delete mode 100755 legacy/emotion/gendoc diff --git a/legacy/emotion/Makefile.am b/legacy/emotion/Makefile.am index d85549a102..ed6f942a0b 100644 --- a/legacy/emotion/Makefile.am +++ b/legacy/emotion/Makefile.am @@ -2,19 +2,28 @@ ACLOCAL_AMFLAGS = -I m4 -SUBDIRS = src data +SUBDIRS = src data doc MAINTAINERCLEANFILES = Makefile.in aclocal.m4 config.guess emotion.spec \ config.h.in config.sub configure install-sh \ ltconfig ltmain.sh missing mkinstalldirs \ - stamp-h.in emotion_docs.tar emotion_docs.tar.gz \ - emotion.c acconfig.h depcomp + stamp-h.in emotion_docs.tar \ + emotion.c acconfig.h depcomp \ + $(PACKAGE_TARNAME)-$(PACKAGE_VERSION)-doc.tar.bz2 bin_SCRIPTS = EXTRA_DIST = README AUTHORS COPYING COPYING-PLAIN \ - emotion.spec emotion.spec.in emotion.c.in gendoc Doxyfile \ + emotion.spec emotion.spec.in emotion.c.in Doxyfile \ emotion.pc.in pkgconfigdir = $(libdir)/pkgconfig pkgconfig_DATA = emotion.pc + +.PHONY: doc + +# Documentation + +doc: + @echo "entering doc/" + make -C doc doc diff --git a/legacy/emotion/configure.ac b/legacy/emotion/configure.ac index bfddc57efe..889019e74b 100644 --- a/legacy/emotion/configure.ac +++ b/legacy/emotion/configure.ac @@ -242,6 +242,9 @@ src/modules/xine/Makefile src/modules/gstreamer/Makefile src/edje_external/Makefile src/bin/Makefile +doc/Makefile +doc/Doxyfile +doc/emotion.dox data/Makefile ]) @@ -271,6 +274,8 @@ echo echo " Xattr................: ${have_xattr}" echo " Eio..................: ${have_eio}" echo +echo "Documentation..........: ${build_doc}" +echo echo "Compilation............: make (or gmake)" echo " CPPFLAGS.............: $CPPFLAGS" echo " CFLAGS...............: $CFLAGS" diff --git a/legacy/emotion/Doxyfile b/legacy/emotion/doc/Doxyfile.in similarity index 90% rename from legacy/emotion/Doxyfile rename to legacy/emotion/doc/Doxyfile.in index 04a4ec3000..853fce1390 100644 --- a/legacy/emotion/Doxyfile +++ b/legacy/emotion/doc/Doxyfile.in @@ -1,15 +1,17 @@ PROJECT_NAME = Emotion -PROJECT_NUMBER = -OUTPUT_DIRECTORY = doc -INPUT = emotion.c -IMAGE_PATH = doc/img +PROJECT_NUMBER = @PACKAGE_VERSION@ +OUTPUT_DIRECTORY = . +INPUT = emotion.dox \ + @top_srcdir@/src/lib \ + @srcdir@/examples.dox +IMAGE_PATH = img OUTPUT_LANGUAGE = English GENERATE_HTML = YES HTML_OUTPUT = html HTML_FILE_EXTENSION = .html -HTML_HEADER = doc/head.html -HTML_FOOTER = doc/foot.html -HTML_STYLESHEET = doc/e.css +HTML_HEADER = @srcdir@/head.html +HTML_FOOTER = @srcdir@/foot.html +HTML_STYLESHEET = @srcdir@/e.css HTML_ALIGN_MEMBERS = YES ENUM_VALUES_PER_LINE = 1 GENERATE_HTMLHELP = NO @@ -67,7 +69,7 @@ RECURSIVE = NO EXCLUDE = EXCLUDE_SYMLINKS = NO EXCLUDE_PATTERNS = -EXAMPLE_PATH = +EXAMPLE_PATH = @top_srcdir@/src/examples EXAMPLE_PATTERNS = EXAMPLE_RECURSIVE = NO INPUT_FILTER = diff --git a/legacy/emotion/doc/Makefile.am b/legacy/emotion/doc/Makefile.am new file mode 100644 index 0000000000..79315037d0 --- /dev/null +++ b/legacy/emotion/doc/Makefile.am @@ -0,0 +1,32 @@ +MAINTAINERCLEANFILES = Makefile.in + +.PHONY: doc + +PACKAGE_DOCNAME = $(PACKAGE_TARNAME)-$(PACKAGE_VERSION)-doc + +if EFL_BUILD_DOC + +doc-clean: + rm -rf html/ latex/ man/ xml/ $(top_builddir)/$(PACKAGE_DOCNAME).tar* + +doc: all doc-clean + $(efl_doxygen) + cp $(srcdir)/img/* html/ + rm -rf $(PACKAGE_DOCNAME).tar* + mkdir -p $(PACKAGE_DOCNAME)/doc + cp -R html/ latex/ man/ $(PACKAGE_DOCNAME)/doc + tar cf $(PACKAGE_DOCNAME).tar $(PACKAGE_DOCNAME)/ + bzip2 -9 $(PACKAGE_DOCNAME).tar + rm -rf $(PACKAGE_DOCNAME)/ + mv $(PACKAGE_DOCNAME).tar.bz2 $(top_builddir) + +clean-local: doc-clean + +else + +doc: + @echo "Documentation not built. Run ./configure --help" + +endif + +EXTRA_DIST = Doxyfile.in $(wildcard img/*.*) e.css head.html foot.html diff --git a/legacy/emotion/doc/emotion.dox.in b/legacy/emotion/doc/emotion.dox.in new file mode 100644 index 0000000000..9bba42e10c --- /dev/null +++ b/legacy/emotion/doc/emotion.dox.in @@ -0,0 +1,24 @@ +/** + * @file + * @brief Emotion Media Library + * + * These routines are used for Emotion. + */ + +/** + * + * @mainpage Emotion Library Documentation + * @version @PACKAGE_VERSION@ + * @author Carsten Haitzler + * @author vtorri (Vincent Torri) + * @author Sebastian Dransfeld + * @author captainigloo + * @date 2003-2011 + * + * @section intro What is Emotion? + * + * A media object library for Evas and Ecore. + * + * @todo Complete documentation of API + * + */ diff --git a/legacy/emotion/emotion.c.in b/legacy/emotion/emotion.c.in deleted file mode 100644 index aa01486960..0000000000 --- a/legacy/emotion/emotion.c.in +++ /dev/null @@ -1,22 +0,0 @@ -/** -@file -@brief Emotion Media Library - -These routines are used for Emotion. -*/ - -/** - -@mainpage Emotion Library Documentation -@image html emotion.png -@version @VERSION@ -@author Carsten Haitzler -@date 2003-2004 - -@section intro What is Emotion? - -A media object library for Evas and Ecore. - -@todo Complete documentation of API - -*/ diff --git a/legacy/emotion/gendoc b/legacy/emotion/gendoc deleted file mode 100755 index 71c7a683d7..0000000000 --- a/legacy/emotion/gendoc +++ /dev/null @@ -1,16 +0,0 @@ -#!/bin/sh -cp ./emotion.c.in ./emotion.c -for I in `find ./src/lib -name "Emotion.h" -print`; do - cat $I >> ./emotion.c -done -#for I in `find ./src/lib -name "*.c" -print`; do -# cat $I >> ./emotion.c -#done -rm -rf ./doc/html ./doc/latex ./doc/man -doxygen -cp doc/img/*.png doc/html/ -cp doc/img/*.gif doc/html/ -rm -f emotion_docs.tar emotion_docs.tar.gz -tar -cvf emotion_docs.tar doc/html doc/man doc/latex -gzip -9 emotion_docs.tar -exit 0