From af28204ca8d9f3a86ee213e41a5b60b10451bcca Mon Sep 17 00:00:00 2001 From: doursse Date: Tue, 27 Sep 2005 22:10:09 +0000 Subject: [PATCH] installation of the doc with the autofoo. gendoc is not used anymore. The documentation is built and installed only if doxygen exists. If it's good, I'll commit the same stuff for the other packages git-svn-id: http://svn.enlightenment.org/svn/e/trunk/e17/libs/eet@17001 7cbeb6ba-43b4-40fd-8cce-4c39aea84d33 --- Makefile.am | 8 +++- configure.in | 31 +++++++++++++ doc/Doxyfile | 139 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++ doc/Makefile.am | 34 ++++++++++++++ eet.c.in | 2 +- m4/doxygen.m4 | 73 +++++++++++++++++++++++++++++ 6 files changed, 285 insertions(+), 2 deletions(-) create mode 100644 doc/Doxyfile create mode 100644 doc/Makefile.am create mode 100644 m4/doxygen.m4 diff --git a/Makefile.am b/Makefile.am index 3137d2f..20512fa 100644 --- a/Makefile.am +++ b/Makefile.am @@ -1,6 +1,12 @@ ## Process this file with automake to produce Makefile.in -SUBDIRS = src +if BUILD_DOCS +SUBDIRS_DOCS = doc +else +SUBDIRS_DOCS = +endif + +SUBDIRS = src $(SUBDIRS_DOCS) MAINTAINERCLEANFILES = Makefile.in aclocal.m4 config.guess \ config.h.in config.sub configure install-sh \ diff --git a/configure.in b/configure.in index 3ef07cd..d1951c4 100644 --- a/configure.in +++ b/configure.in @@ -123,9 +123,14 @@ dnl Set PACKAGE_SOURCE_DIR in config.h. packagesrcdir=`cd $srcdir && pwd` AC_DEFINE_UNQUOTED(PACKAGE_SOURCE_DIR, "${packagesrcdir}", [Source code directory]) +dnl Documentation +AM_CHECK_DOXYGEN() + AC_OUTPUT([ Makefile eet.pc +eet.c +doc/Makefile src/Makefile src/lib/Makefile src/bin/Makefile @@ -140,3 +145,29 @@ debian/changelog ],[ chmod +x eet-config ]) + + +##################################################################### +## Info + +echo +echo +echo +echo "------------------------------------------------------------------------" +echo "$PACKAGE $VERSION" +echo "------------------------------------------------------------------------" +echo +echo "Configuration Options Summary:" +echo +echo " Build documentation..: $BUILD_DOCS" +echo +echo " Compilation..........: make" +echo +echo " Installation.........: make install" +echo +echo " prefix.........: $prefix" +echo " binaries.......: $bindir" +echo " libraries......: $libdir" +echo " headers........: $includedir" +echo " documentation..: $datadir/$PACKAGE/doc" +echo diff --git a/doc/Doxyfile b/doc/Doxyfile new file mode 100644 index 0000000..b553e4c --- /dev/null +++ b/doc/Doxyfile @@ -0,0 +1,139 @@ +PROJECT_NAME = Eet +PROJECT_NUMBER = +OUTPUT_DIRECTORY = . +INPUT = ../eet.c ../src/lib +IMAGE_PATH = img +OUTPUT_LANGUAGE = English +GENERATE_HTML = YES +HTML_OUTPUT = html +HTML_FILE_EXTENSION = .html +HTML_HEADER = head.html +HTML_FOOTER = foot.html +HTML_STYLESHEET = eet.css +HTML_ALIGN_MEMBERS = YES +ENUM_VALUES_PER_LINE = 1 +GENERATE_HTMLHELP = NO +CHM_FILE = +HHC_LOCATION = +GENERATE_CHI = NO +BINARY_TOC = NO +TOC_EXPAND = NO +DISABLE_INDEX = NO +EXTRACT_ALL = NO +EXTRACT_PRIVATE = NO +EXTRACT_STATIC = NO +EXTRACT_LOCAL_CLASSES = NO +HIDE_UNDOC_MEMBERS = YES +HIDE_UNDOC_CLASSES = YES +HIDE_FRIEND_COMPOUNDS = YES +BRIEF_MEMBER_DESC = YES +REPEAT_BRIEF = YES +ALWAYS_DETAILED_SEC = NO +INLINE_INHERITED_MEMB = NO +FULL_PATH_NAMES = NO +STRIP_FROM_PATH = +INTERNAL_DOCS = NO +STRIP_CODE_COMMENTS = YES +CASE_SENSE_NAMES = YES +SHORT_NAMES = NO +HIDE_SCOPE_NAMES = NO +VERBATIM_HEADERS = NO +SHOW_INCLUDE_FILES = NO +JAVADOC_AUTOBRIEF = YES +MULTILINE_CPP_IS_BRIEF = NO +DETAILS_AT_TOP = NO +INHERIT_DOCS = YES +INLINE_INFO = YES +SORT_MEMBER_DOCS = YES +DISTRIBUTE_GROUP_DOC = NO +TAB_SIZE = 2 +GENERATE_TODOLIST = YES +GENERATE_TESTLIST = YES +GENERATE_BUGLIST = YES +GENERATE_DEPRECATEDLIST= YES +ALIASES = +ENABLED_SECTIONS = +MAX_INITIALIZER_LINES = 30 +OPTIMIZE_OUTPUT_FOR_C = YES +OPTIMIZE_OUTPUT_JAVA = NO +SHOW_USED_FILES = NO +QUIET = NO +WARNINGS = YES +WARN_IF_UNDOCUMENTED = YES +WARN_FORMAT = "$file:$line: $text" +WARN_LOGFILE = +FILE_PATTERNS = +RECURSIVE = NO +EXCLUDE = +EXCLUDE_SYMLINKS = NO +EXCLUDE_PATTERNS = +EXAMPLE_PATH = +EXAMPLE_PATTERNS = +EXAMPLE_RECURSIVE = NO +INPUT_FILTER = +FILTER_SOURCE_FILES = NO +SOURCE_BROWSER = NO +INLINE_SOURCES = NO +REFERENCED_BY_RELATION = YES +REFERENCES_RELATION = YES +ALPHABETICAL_INDEX = YES +COLS_IN_ALPHA_INDEX = 2 +IGNORE_PREFIX = +GENERATE_TREEVIEW = NO +TREEVIEW_WIDTH = 250 +GENERATE_LATEX = YES +LATEX_OUTPUT = latex +LATEX_CMD_NAME = latex +MAKEINDEX_CMD_NAME = makeindex +COMPACT_LATEX = NO +PAPER_TYPE = a4wide +EXTRA_PACKAGES = +LATEX_HEADER = +PDF_HYPERLINKS = YES +USE_PDFLATEX = NO +LATEX_BATCHMODE = NO +GENERATE_RTF = NO +RTF_OUTPUT = rtf +COMPACT_RTF = NO +RTF_HYPERLINKS = NO +RTF_STYLESHEET_FILE = +RTF_EXTENSIONS_FILE = +GENERATE_MAN = YES +MAN_OUTPUT = man +MAN_EXTENSION = .3 +MAN_LINKS = YES +GENERATE_XML = YES +XML_SCHEMA = +XML_DTD = +GENERATE_AUTOGEN_DEF = NO +ENABLE_PREPROCESSING = YES +MACRO_EXPANSION = NO +EXPAND_ONLY_PREDEF = NO +SEARCH_INCLUDES = NO +INCLUDE_PATH = +INCLUDE_FILE_PATTERNS = +PREDEFINED = +EXPAND_AS_DEFINED = +SKIP_FUNCTION_MACROS = YES +TAGFILES = +GENERATE_TAGFILE = +ALLEXTERNALS = NO +EXTERNAL_GROUPS = YES +PERL_PATH = /usr/bin/perl +CLASS_DIAGRAMS = NO +HIDE_UNDOC_RELATIONS = YES +HAVE_DOT = NO +CLASS_GRAPH = NO +COLLABORATION_GRAPH = NO +TEMPLATE_RELATIONS = NO +INCLUDE_GRAPH = NO +INCLUDED_BY_GRAPH = NO +GRAPHICAL_HIERARCHY = NO +DOT_IMAGE_FORMAT = png +DOT_PATH = +DOTFILE_DIRS = +MAX_DOT_GRAPH_WIDTH = 512 +MAX_DOT_GRAPH_HEIGHT = 512 +GENERATE_LEGEND = YES +DOT_CLEANUP = YES +SEARCHENGINE = NO diff --git a/doc/Makefile.am b/doc/Makefile.am new file mode 100644 index 0000000..db14644 --- /dev/null +++ b/doc/Makefile.am @@ -0,0 +1,34 @@ + +if BUILD_DOCS + +# install documentation +docdir = $(datadir)/$(PACKAGE)/doc + +all-local: doc-build.stamp + +# rule to remove all old created files +doc-prepare.stamp: + @if test x"html" != x ; then \ + rm -rf html/ latex/ man/ xml/; \ + fi + +# rule to build documentation and copy necessary files +doc-build.stamp: doc-prepare.stamp + @doxygen + @cp img/*.png html/ + +# rule to install the documentation in $(docdir) +install-data-local: + @if ! test -d $(datadir)/$(PACKAGE); then \ + mkdir $(datadir)/$(PACKAGE); \ + fi + @if ! test -d $(docdir); then \ + mkdir $(docdir); \ + fi + @cp -pr html/ man/ latex/ xml/ $(docdir) + +# rule to uninstall the documentation +uninstall-local: + rm -rf $(docdir) + +endif diff --git a/eet.c.in b/eet.c.in index 81a7371..78c9e17 100644 --- a/eet.c.in +++ b/eet.c.in @@ -9,7 +9,7 @@ These routines are used for Eet Library interaction @mainpage Eet Library Documentation @image html eet.png -@version 0.9.9 +@version @VERSION@ @author Carsten Haitzler @date 2000-2004 diff --git a/m4/doxygen.m4 b/m4/doxygen.m4 new file mode 100644 index 0000000..32c1349 --- /dev/null +++ b/m4/doxygen.m4 @@ -0,0 +1,73 @@ +dnl Configure script for doxygen +dnl Vincent Torri 2005-22-09 +dnl +dnl AM_CHECK_DOXYGEN([ACTION-IF-FOUND [, ACTION-IF-NOT-FOUND]]) +dnl Test for the doxygen program, and define BUILD_DOCS and DOXYGEN. +dnl +AC_DEFUN([AM_CHECK_DOXYGEN], + [ + DOXYGEN="doxygen" + dnl + dnl Disable the build of the documentation + dnl + AC_ARG_ENABLE( + [build_docs], + AC_HELP_STRING( + [--disable-build-docs], + [Disable the build of the documentation]), + [if test "${disable_build_docs}" = "yes" ; then + enable_build_docs="no" + else + enable_build_docs="yes" + fi], + [enable_build_docs="yes"]) + dnl + dnl Get the prefix where doxygen is installed. + dnl + AC_ARG_WITH( + [doxygen], + AC_HELP_STRING( + [--with-doxygen=FILE], + [doxygen program to use (eg /usr/bin/doxygen)]), + dnl + dnl Check the given doxygen program. + dnl + [DOXYGEN=${withval} + AC_CHECK_PROG( + [BUILD_DOCS], + [${DOXYGEN}], + [yes], + [no]) + if test $BUILD_DOCS = no; then + echo "WARNING:" + echo "The doxygen program you specified:" + echo "$DOXYGEN" + echo "was not found. Please check the path and make sure " + echo "the program exists and is executable." + AC_MSG_WARN( + [Warning: no doxygen detected. Documentation will not be built]) + fi], + [AC_CHECK_PROG( + [BUILD_DOCS], + [${DOXYGEN}], + [yes], + [no]) + if test ${BUILD_DOCS} = no; then + echo "WARNING:" + echo "The doxygen program was not found in your execute" + echo "You may have doxygen installed somewhere not covered by your path." + echo "" + echo "If this is the case make sure you have the packages installed, AND" + echo "that the doxygen program is in your execute path (see your" + echo "shell's manual page on setting the \$PATH environment variable), OR" + echo "alternatively, specify the program to use with --with-doxygen." + AC_MSG_WARN( + [Warning: no doxygen detected. Documentation will not be built]) + fi]) + dnl + dnl Substitution + dnl + AC_SUBST([DOXYGEN]) + AM_CONDITIONAL(BUILD_DOCS, test "x$BUILD_DOCS" = "xyes") + ]) +dnl End of doxygen.m4 -- 2.7.4