* put documentation related files in doc, remove gendoc and add a doc rule to create the documentation and a doc tarball named eet-doc-$(version).tar.bz2 * minor cleanup in the autotools SVN revision: 36706devs/devilhorns/wayland_egl
parent
a3f8f5f27b
commit
3e4465c4fa
14 changed files with 300 additions and 394 deletions
@ -1,139 +0,0 @@ |
||||
PROJECT_NAME = Eet |
||||
PROJECT_NUMBER = |
||||
OUTPUT_DIRECTORY = doc |
||||
INPUT = eet.c src/lib/Eet.h |
||||
IMAGE_PATH = doc/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_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 = YES |
||||
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 = NO |
||||
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 |
||||
@ -1,46 +1,32 @@ |
||||
|
||||
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 -d html ; 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/
|
||||
MAINTAINERCLEANFILES = Makefile.in eet.c
|
||||
|
||||
# rules to clean
|
||||
clean-local: |
||||
@rm -rf html/ latex/ man/ xml/
|
||||
.PHONY: doc |
||||
|
||||
# rule to install the documentation in $(docdir)
|
||||
install-data-local: |
||||
@if ! test -d "$(DESTDIR)$(datadir)/$(PACKAGE)"; then \
|
||||
$(mkinstalldirs) "$(DESTDIR)$(datadir)/$(PACKAGE)"; \
|
||||
fi
|
||||
@if ! test -d "$(DESTDIR)$(docdir)"; then \
|
||||
$(mkinstalldirs) "$(DESTDIR)$(docdir)"; \
|
||||
fi
|
||||
@cp -pr html/ man/ latex/ xml/ "$(DESTDIR)$(docdir)"
|
||||
if EFL_BUILD_DOC |
||||
|
||||
# rule to uninstall the documentation
|
||||
uninstall-local: |
||||
rm -rf $(DESTDIR)$(docdir)
|
||||
doc-clean: |
||||
rm -rf html/ latex/ man/ xml/ $(PACKAGE_TARNAME)-$(PACKAGE_VERSION).tar*
|
||||
|
||||
doc: all doc-clean |
||||
$(DOXYGEN)
|
||||
cp img/*.png html/
|
||||
rm -rf $(PACKAGE_TARNAME)-doc-$(PACKAGE_VERSION).tar*
|
||||
mkdir -p $(PACKAGE_TARNAME)-doc-$(PACKAGE_VERSION)/doc
|
||||
cp -R html/ latex/ man/ $(PACKAGE_TARNAME)-doc-$(PACKAGE_VERSION)/doc
|
||||
tar cf $(PACKAGE_TARNAME)-doc-$(PACKAGE_VERSION).tar $(PACKAGE_TARNAME)-doc-$(PACKAGE_VERSION)
|
||||
bzip2 -9 $(PACKAGE_TARNAME)-doc-$(PACKAGE_VERSION).tar
|
||||
rm -rf $(PACKAGE_TARNAME)-doc-$(PACKAGE_VERSION)
|
||||
mv $(PACKAGE_TARNAME)-doc-$(PACKAGE_VERSION).tar.bz2 $(top_srcdir)
|
||||
|
||||
MAINTAINERCLEANFILES = Makefile.in eet.c
|
||||
else |
||||
|
||||
DISTCLEANFILES = Makefile.in eet.c
|
||||
doc: |
||||
@echo "Documentation not built. Run ./configure --help"
|
||||
|
||||
endif |
||||
|
||||
EXTRA_DIST = Doxyfile eet.css foot.html head.html img/
|
||||
clean-local: doc-clean |
||||
|
||||
EXTRA_DIST = Doxyfile eet.css foot.html head.html img/ eet.c.in
|
||||
|
||||
|
||||
@ -1,8 +0,0 @@ |
||||
#!/bin/sh |
||||
rm -rf ./doc/html ./doc/latex ./doc/man |
||||
doxygen |
||||
cp doc/img/* doc/html/ |
||||
rm -f eet_docs.tar eet_docs.tar.gz |
||||
tar -cvf eet_docs.tar doc/html doc/man doc/latex |
||||
gzip -9 eet_docs.tar |
||||
exit 0 |
||||
@ -0,0 +1,14 @@ |
||||
|
||||
AC_DEFUN([AC_C___ATTRIBUTE__], |
||||
[ |
||||
AC_MSG_CHECKING(for __attribute__) |
||||
AC_CACHE_VAL(ac_cv___attribute__, [ |
||||
AC_TRY_COMPILE([#include <stdlib.h>], |
||||
[int func(int x); int foo(int x __attribute__ ((unused))) { exit(1); }], |
||||
ac_cv___attribute__=yes, ac_cv___attribute__=no)]) |
||||
if test "$ac_cv___attribute__" = "yes"; then |
||||
AC_DEFINE(HAVE___ATTRIBUTE__, 1, [Define to 1 if your compiler has __attribute__]) |
||||
fi |
||||
AC_MSG_RESULT($ac_cv___attribute__) |
||||
]) |
||||
|
||||
@ -1,73 +0,0 @@ |
||||
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 |
||||
@ -0,0 +1,64 @@ |
||||
dnl Copyright (C) 2008 Vincent Torri <vtorri at univ-evry dot fr> |
||||
dnl That code is public domain and can be freely used or copied. |
||||
|
||||
dnl Macro that check if coverage support is wanted and, if yes, if |
||||
dnl lcov is available. |
||||
|
||||
dnl Usage: EFL_CHECK_COVERAGE(tests [, ACTION-IF-FOUND [, ACTION-IF-NOT-FOUND]]) |
||||
dnl The parameter 'tests' is used if a dependency is needed. If set to "yes", |
||||
dnl the dependency is available. |
||||
dnl Defines EFL_COVERAGE_CFLAGS and EFL_COVERAGE_LIBS variables |
||||
dnl Defines the automake conditionnal EFL_ENABLE_COVERAGE |
||||
|
||||
AC_DEFUN([EFL_CHECK_COVERAGE], |
||||
[ |
||||
|
||||
dnl configure option |
||||
|
||||
AC_ARG_ENABLE([coverage], |
||||
[AC_HELP_STRING([--enable-coverage], [compile with coverage profiling instrumentation @<:@default=no@:>@])], |
||||
[ |
||||
if test "x${enableval}" = "xyes" ; then |
||||
_efl_enable_coverage="yes" |
||||
else |
||||
_efl_enable_coverage="no" |
||||
fi |
||||
], |
||||
[_efl_enable_coverage="no"] |
||||
) |
||||
AC_MSG_CHECKING([whether to use profiling instrumentation]) |
||||
AC_MSG_RESULT([$_efl_enable_coverage]) |
||||
|
||||
dnl lcov check |
||||
|
||||
if test ! "x$1" = "xyes" -a "x$_efl_enable_coverage" = "xyes" ; then |
||||
AC_MSG_WARN([Coverage report requested but tests not being built, disable profiling instrumentation.]) |
||||
AC_MSG_WARN([Run configure with --enable-tests]) |
||||
_efl_enable_coverage="no" |
||||
fi |
||||
|
||||
if test "x$_efl_enable_coverage" = "xyes" ; then |
||||
AC_CHECK_PROG(have_lcov, [lcov], [yes], [no]) |
||||
if test "x$have_lcov" = "xyes" ; then |
||||
EFL_COVERAGE_CFLAGS="-fprofile-arcs -ftest-coverage" |
||||
EFL_COVERAGE_LIBS="-lgcov" |
||||
# remove any optimisation flag and force debug symbols |
||||
EFL_DEBUG_CFLAGS="-g -O0 -DDEBUG" |
||||
else |
||||
AC_MSG_WARN([lcov is not found, disable profiling instrumentation]) |
||||
_efl_enable_coverage="no" |
||||
fi |
||||
fi |
||||
|
||||
dnl Substitution |
||||
AC_SUBST(EFL_COVERAGE_CFLAGS) |
||||
AC_SUBST(EFL_COVERAGE_LIBS) |
||||
|
||||
AM_CONDITIONAL(EFL_ENABLE_COVERAGE, test "x${_efl_enable_coverage}" = "xyes") |
||||
|
||||
if test "x${_efl_enable_coverage}" = "xyes" ; then |
||||
ifelse([$2], , :, [$2]) |
||||
else |
||||
ifelse([$3], , :, [$3]) |
||||
fi |
||||
]) |
||||
@ -0,0 +1,88 @@ |
||||
dnl Copyright (C) 2008 Vincent Torri <vtorri at univ-evry dot fr> |
||||
dnl That code is public domain and can be freely used or copied. |
||||
|
||||
dnl Macro that check if doxygen is available or not. |
||||
|
||||
dnl EFL_CHECK_DOXYGEN([ACTION-IF-FOUND [, ACTION-IF-NOT-FOUND]]) |
||||
dnl Test for the doxygen program |
||||
dnl Defines DOXYGEN |
||||
dnl Defines the automake conditionnal EFL_BUILD_DOC |
||||
dnl |
||||
AC_DEFUN([EFL_CHECK_DOXYGEN], |
||||
[ |
||||
|
||||
DOXYGEN="doxygen" |
||||
|
||||
dnl |
||||
dnl Disable the build of the documentation |
||||
dnl |
||||
AC_ARG_ENABLE([doc], |
||||
AC_HELP_STRING( |
||||
[--disable-doc], |
||||
[Disable the build of the documentation]), |
||||
[if test "${disable_doc}" = "yes" ; then |
||||
enable_doc="no" |
||||
else |
||||
enable_doc="yes" |
||||
fi], |
||||
[enable_doc="yes"] |
||||
) |
||||
|
||||
dnl |
||||
dnl Specify the full file name, with path |
||||
dnl |
||||
AC_ARG_WITH([doxygen], |
||||
AC_HELP_STRING( |
||||
[--with-doxygen=FILE], |
||||
[doxygen program to use @<:@default=doxygen@:>@]), |
||||
dnl |
||||
dnl Check the given doxygen program. |
||||
dnl |
||||
[DOXYGEN=${withval} |
||||
AC_CHECK_PROG([BUILD_DOCS], |
||||
[${DOXYGEN}], |
||||
[yes], |
||||
[no]) |
||||
if test "x${BUILD_DOCS}" = "xno" ; 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 "x${BUILD_DOCS}" = "xno" ; 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 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(EFL_BUILD_DOC, test "x${BUILD_DOCS}" = "xyes") |
||||
|
||||
if test "x${BUILD_DOCS}" = "xyes" ; then |
||||
ifelse([$1], , :, [$1]) |
||||
else |
||||
ifelse([$2], , :, [$2]) |
||||
fi |
||||
|
||||
]) |
||||
|
||||
dnl End of doxygen.m4 |
||||
@ -0,0 +1,44 @@ |
||||
dnl Copyright (C) 2008 Vincent Torri <vtorri at univ-evry dot fr> |
||||
dnl That code is public domain and can be freely used or copied. |
||||
|
||||
dnl Macro that check if tests programs are wanted and if yes, if |
||||
dnl the Check library is available. |
||||
|
||||
dnl Usage: EFL_CHECK_TESTS([ACTION-IF-FOUND [, ACTION-IF-NOT-FOUND]]) |
||||
dnl Define the automake conditionnal EFL_ENABLE_TESTS |
||||
|
||||
AC_DEFUN([EFL_CHECK_TESTS], |
||||
[ |
||||
|
||||
dnl configure option |
||||
|
||||
AC_ARG_ENABLE([tests], |
||||
[AC_HELP_STRING([--enable-tests], [enable tests @<:@default=no@:>@])], |
||||
[ |
||||
if test "x${enableval}" = "xyes" ; then |
||||
_efl_enable_tests="yes" |
||||
else |
||||
_efl_enable_tests="no" |
||||
fi |
||||
], |
||||
[_efl_enable_tests="no"] |
||||
) |
||||
AC_MSG_CHECKING([whether tests are built]) |
||||
AC_MSG_RESULT([${_efl_enable_tests}]) |
||||
|
||||
if test "x${_efl_enable_tests}" = "xyes" ; then |
||||
PKG_CHECK_MODULES([CHECK], |
||||
[check >= 0.9.5], |
||||
[dummy="yes"], |
||||
[_efl_enable_tests="no"] |
||||
) |
||||
fi |
||||
|
||||
AM_CONDITIONAL(EFL_ENABLE_TESTS, test "x${_efl_enable_tests}" = "xyes") |
||||
|
||||
if test "x${_efl_enable_tests}" = "xyes" ; then |
||||
ifelse([$1], , :, [$1]) |
||||
else |
||||
ifelse([$2], , :, [$2]) |
||||
fi |
||||
]) |
||||
Loading…
Reference in new issue