emotion/doc - doc build now uses the build system, instead gendoc.
authorantognolli <antognolli>
Wed, 29 Jun 2011 20:13:37 +0000 (20:13 +0000)
committerantognolli <antognolli@7cbeb6ba-43b4-40fd-8cce-4c39aea84d33>
Wed, 29 Jun 2011 20:13:37 +0000 (20:13 +0000)
git-svn-id: http://svn.enlightenment.org/svn/e/trunk/emotion@60839 7cbeb6ba-43b4-40fd-8cce-4c39aea84d33

Makefile.am
configure.ac
doc/Doxyfile.in [moved from Doxyfile with 90% similarity]
doc/Makefile.am [new file with mode: 0644]
doc/emotion.dox.in [new file with mode: 0644]
emotion.c.in [deleted file]
gendoc [deleted file]

index d85549a..ed6f942 100644 (file)
@@ -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
index bfddc57..889019e 100644 (file)
@@ -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"
similarity index 90%
rename from Doxyfile
rename to doc/Doxyfile.in
index 04a4ec3..853fce1 100644 (file)
--- a/Doxyfile
@@ -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/doc/Makefile.am b/doc/Makefile.am
new file mode 100644 (file)
index 0000000..7931503
--- /dev/null
@@ -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/doc/emotion.dox.in b/doc/emotion.dox.in
new file mode 100644 (file)
index 0000000..9bba42e
--- /dev/null
@@ -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 <raster@rasterman.com>
+ * @author vtorri (Vincent Torri) <torri@maths.univ-evry.fr>
+ * @author Sebastian Dransfeld <sd@tango.flipp.net>
+ * @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/emotion.c.in b/emotion.c.in
deleted file mode 100644 (file)
index aa01486..0000000
+++ /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 <raster@rasterman.com>
-@date 2003-2004
-
-@section intro What is Emotion?
-
-A media object library for Evas and Ecore.
-
-@todo Complete documentation of API
-
-*/
diff --git a/gendoc b/gendoc
deleted file mode 100755 (executable)
index 71c7a68..0000000
--- a/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