From 1a17357e8b44d340d7c76dea98934d15ee84590e Mon Sep 17 00:00:00 2001 From: Christopher Michael Date: Thu, 11 Feb 2010 04:39:58 +0000 Subject: [PATCH] Update me email address in AUTHORS file. 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 | 2 +- Makefile.am | 9 +++++++- configure.ac | 59 +++++++++++++++++++++++++++++----------------------- 3 files changed, 42 insertions(+), 28 deletions(-) diff --git a/AUTHORS b/AUTHORS index c62499790..401f5c3c9 100644 --- a/AUTHORS +++ b/AUTHORS @@ -7,7 +7,7 @@ dj2 (Dan Sinclair) Tilman Sauerbeck Aleksej Struk Brian Mattern -devilhorns (Christopher Michael) +devilhorns (Christopher Michael) /dev/urandom (Viktor Kojouharov) ilLogict (Chidambar Zinnoury) Stafford Horne diff --git a/Makefile.am b/Makefile.am index 8df5af8f0..c1c2b8e53 100644 --- a/Makefile.am +++ b/Makefile.am @@ -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 diff --git a/configure.ac b/configure.ac index 1e03fdb3e..edc1e4eeb 100644 --- a/configure.ac +++ b/configure.ac @@ -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" +UNUSED_MODS="" +for mod in $UNUSED_OPTIONAL_MODULES; do + UNUSED_MODS="$UNUSED_MODS${COLOR_HRED}$mod${COLOR_END} " +done + +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 -if test "x$UNUSED_MODS" != "x"; then - echo -e " * disabled modules: $UNUSED_MODS" -fi +cat << COMPILE_EOF +Compilation........: make (or gmake) +COMPILE_EOF +echo -cat << HINT_EOF - -now type: - - make all install - -HINT_EOF +cat << INSTALL_EOF +Installation.......: make all install (as root if needed, with 'su' or 'sudo') +INSTALL_EOF +echo