Update me email address in AUTHORS file.
authorChristopher Michael <cpmichael1@comcast.net>
Thu, 11 Feb 2010 04:39:58 +0000 (04:39 +0000)
committerChristopher Michael <cpmichael1@comcast.net>
Thu, 11 Feb 2010 04:39:58 +0000 (04:39 +0000)
Add doxygen stuff to configure.ac & Makefile.am

E itself not supports basic structure for doxygen (the e.dox.in file may
need updating, and the Doxyfile in docs dir also). This will be handy for
documenting available API calls that people can use when writing modules, etc.

SVN revision: 46068

AUTHORS
Makefile.am
configure.ac

diff --git a/AUTHORS b/AUTHORS
index c624997..401f5c3 100644 (file)
--- a/AUTHORS
+++ b/AUTHORS
@@ -7,7 +7,7 @@ dj2 (Dan Sinclair) <dj2@everburning.com>
 Tilman Sauerbeck <tilman@code-monkey.de>
 Aleksej Struk <astruk@gmail.com>
 Brian Mattern <rephorm@rephorm.com>
-devilhorns (Christopher Michael) <devilhorns@devilhorns.us>
+devilhorns (Christopher Michael) <devilhorns@comcast.net>
 /dev/urandom (Viktor Kojouharov) <vkojouharov@gmail.com>
 ilLogict (Chidambar Zinnoury) <illogict@online.fr>
 Stafford Horne <shorne@softhome.net>
index 8df5af8..c1c2b8e 100644 (file)
@@ -4,7 +4,8 @@ MAINTAINERCLEANFILES = Makefile.in aclocal.m4 config.guess \
                        config.h.in config.sub configure install-sh \
                       ltconfig ltmain.sh missing mkinstalldirs \
                       stamp-h.in acconfig.h \
-                      enlightenment.spec enlightenment.pc
+                      enlightenment.spec enlightenment.pc \
+                       $(PACKAGE_TARNAME)-$(PACKAGE_VERSION)-doc.tar.bz2
 
 EXTRA_DIST = config.rpath  README AUTHORS COPYING COPYING-PLAIN \
              enlightenment.spec.in enlightenment.spec enlightenment.pc
@@ -16,3 +17,9 @@ ACLOCAL_AMFLAGS = -I m4
 
 pkgconfigdir = $(libdir)/pkgconfig
 pkgconfig_DATA = enlightenment.pc
+
+.PHONY: doc
+
+doc:
+       @echo "entering doc/"
+       make -C doc doc
index 1e03fdb..edc1e4e 100644 (file)
@@ -234,6 +234,10 @@ if test "[${e_cv_enable_files}]" = yes; then
 fi
 AC_MSG_RESULT([$e_cv_enable_files])
 
+# doxygen program for documentation building
+
+EFL_CHECK_DOXYGEN([build_doc="yes"], [build_doc="no"])
+
 # explicit libs for each binary to reduce linkage requirements
 PKG_CHECK_MODULES(E_REMOTE, [
   ecore
@@ -690,6 +694,7 @@ data/etc/Makefile
 data/icons/Makefile
 data/backgrounds/Makefile
 doc/Makefile
+doc/e.dox
 config/Makefile
 config/default/Makefile
 config/standard/Makefile
@@ -706,40 +711,42 @@ txt_strip() {
         echo "[$]@" | sed -e 's/^[[ \t]]*\([[^ \t]]*\)[[ \t]]*$/\1/g'
 }
 
-MODS=""
-for mod in $OPTIONAL_MODULES; do
-        MODS="$MODS ${COLOR_HGREEN}+$mod${COLOR_END}"
-done
-MODS=$(txt_strip $MODS)
-
-UNUSED_MODS=""
-for mod in $UNUSED_OPTIONAL_MODULES; do
-        UNUSED_MODS="$UNUSED_MODS ${COLOR_HRED}-$mod${COLOR_END}"
-done
-UNUSED_MODS=$(txt_strip $UNUSED_MODS)
-
+echo
 cat << SUMMARY_EOF
-
 Summary:
  * project.........: $PACKAGE $VERSION
  * prefix..........: $(txt_strip $prefix)
  * CFLAGS..........: $(txt_strip $CFLAGS)
  * LDFLAGS.........: $(txt_strip $LDFLAGS)
-
 SUMMARY_EOF
+echo
 
-if test "x$MODS" != "x"; then
-   echo -e " * enabled modules.: $MODS"
-fi
+UNUSED_MODS=""
+for mod in $UNUSED_OPTIONAL_MODULES; do
+        UNUSED_MODS="$UNUSED_MODS${COLOR_HRED}$mod${COLOR_END} "
+done
 
-if test "x$UNUSED_MODS" != "x"; then
-   echo -e " * disabled modules: $UNUSED_MODS"
+cat << MODULES_EOF
+Modules:
+ * disabled........: $(txt_strip $UNUSED_MODS)
+MODULES_EOF
+echo
+
+cat << DOCS_EOF
+Documentation:
+ * enabled.........: ${build_doc}
+DOCS_EOF
+if test "x${build_doc}" = "xyes" ; then
+   echo " Building..........: make doc"
 fi
+echo
 
-cat << HINT_EOF
-
-now type:
-
-     make all install
+cat << COMPILE_EOF
+Compilation........: make (or gmake)
+COMPILE_EOF
+echo
 
-HINT_EOF
+cat << INSTALL_EOF
+Installation.......: make all install (as root if needed, with 'su' or 'sudo')
+INSTALL_EOF
+echo