roboptim-commit Mailing List for RobOptim (Page 98)
Status: Beta
Brought to you by:
flamiraux
You can subscribe to this list here.
2009 |
Jan
|
Feb
|
Mar
|
Apr
|
May
|
Jun
(62) |
Jul
(62) |
Aug
(36) |
Sep
(24) |
Oct
(41) |
Nov
(182) |
Dec
(8) |
---|---|---|---|---|---|---|---|---|---|---|---|---|
2010 |
Jan
(12) |
Feb
(13) |
Mar
(104) |
Apr
(95) |
May
(90) |
Jun
(90) |
Jul
(93) |
Aug
(97) |
Sep
(91) |
Oct
(93) |
Nov
(90) |
Dec
(95) |
2011 |
Jan
(96) |
Feb
(84) |
Mar
(94) |
Apr
(91) |
May
(93) |
Jun
(91) |
Jul
(93) |
Aug
(93) |
Sep
(107) |
Oct
(93) |
Nov
(58) |
Dec
|
2012 |
Jan
(8) |
Feb
(4) |
Mar
|
Apr
(3) |
May
|
Jun
|
Jul
|
Aug
|
Sep
|
Oct
(1) |
Nov
(6) |
Dec
(5) |
2013 |
Jan
(16) |
Feb
(22) |
Mar
|
Apr
|
May
|
Jun
|
Jul
|
Aug
|
Sep
|
Oct
|
Nov
|
Dec
|
From: Thomas M. <tho...@us...> - 2009-06-10 09:54:04
|
This is an automated email from the git hooks/post-receive script. It was generated because a ref change was pushed to the repository containing the project "roboptim". The branch, trajectory has been updated via 45e922d711617be94758c6ab235c98262df09d49 (commit) from 0405cf16b81685971a4cdf6e073365d12f0148b4 (commit) Those revisions listed above that are new to this repository have not appeared on any other notification email; so we list those revisions in full, below. - Log ----------------------------------------------------------------- commit 45e922d711617be94758c6ab235c98262df09d49 Author: Thomas Moulard <tho...@gm...> Date: Wed Jun 10 18:52:48 2009 +0900 Synchronize with share. * build-aux/boost.m4, * build-aux/deb.mk: Synchronize. * build-aux/doxygen.m4: New. * build-aux/ebuild.mk, * build-aux/init.mk: Synchronize. * build-aux/pkg-config.mk: New. * build-aux/pkg-config.pc.in, * build-aux/rpm.mk: Synchronize. * configure.ac, * doc/Doxyfile.in, * doc/Makefile.am, * doc/sf-upload.sh.in: Synchronize. Signed-off-by: Thomas Moulard <tho...@gm...> diff --git a/ChangeLog b/ChangeLog index 29283b7..280bc66 100644 --- a/ChangeLog +++ b/ChangeLog @@ -1,3 +1,19 @@ +2009-06-10 Thomas Moulard <tho...@gm...> + + Synchronize with share. + * build-aux/boost.m4, + * build-aux/deb.mk: Synchronize. + * build-aux/doxygen.m4: New. + * build-aux/ebuild.mk, + * build-aux/init.mk: Synchronize. + * build-aux/pkg-config.mk: New. + * build-aux/pkg-config.pc.in, + * build-aux/rpm.mk: Synchronize. + * configure.ac, + * doc/Doxyfile.in, + * doc/Makefile.am, + * doc/sf-upload.sh.in: Synchronize. + 2009-06-08 Thomas Moulard <tho...@gm...> Update to new interface and document. diff --git a/build-aux/boost.m4 b/build-aux/boost.m4 index ae935d9..a9fc46c 100644 --- a/build-aux/boost.m4 +++ b/build-aux/boost.m4 @@ -153,7 +153,7 @@ boost-lib-version = BOOST_LIB_VERSION], # e.g. "134" for 1_34_1 or "135" for 1_35 boost_major_version=`echo "$boost_cv_lib_version" | sed 's/_//;s/_.*//'` case $boost_major_version in #( - '' | *[[^0-9]]*) + '' | *[[!0-9]]*) AC_MSG_ERROR([Invalid value: boost_major_version=$boost_major_version]) ;; esac @@ -451,6 +451,13 @@ AC_DEFUN([BOOST_FUNCTION], [BOOST_FIND_HEADER([boost/function.hpp])]) +# BOOST_FUSTION() +# ---------------- +# Look for Boost.Fusion +AC_DEFUN([BOOST_FUSION], +[BOOST_FIND_HEADER([boost/fusion/include/vector.hpp])]) + + # BOOST_GRAPH([PREFERRED-RT-OPT]) # ------------------------------- # Look for Boost.Graphs. For the documentation of PREFERRED-RT-OPT, see the diff --git a/build-aux/deb.mk b/build-aux/deb.mk index 994b575..74adbe4 100644 --- a/build-aux/deb.mk +++ b/build-aux/deb.mk @@ -1,6 +1,6 @@ include $(top_srcdir)/build-aux/init.mk -DPKG_BUILDPACKAGE = dpkg-buildpackage -rfakeroot -us -uc -d +DPKG_BUILDPACKAGE = dpkg-buildpackage -rfakeroot -E -W -d distdir = $(PACKAGE)-$(VERSION) DIST_ARCHIVE = $(distdir).tar.gz @@ -12,11 +12,21 @@ EXTRA_DIST += \ docs \ rules -.PHONY: deb +.PHONY: deb deb-prepare -deb: $(top_builddir)/$(DIST_ARCHIVE) +clean-local: + rm -rf $(PACKAGE)-$(VERSION) + rm -f $(DIST_ARCHIVE) + rm -f $(PACKAGE)_$(VERSION)-*.tar.gz + rm -f $(PACKAGE)_$(VERSION)-*.dsc + rm -f $(PACKAGE)_$(VERSION)-*.changes + rm -f $(PACKAGE)_$(VERSION)-*.deb + +deb-prepare: cd $(top_builddir) && $(MAKE) $(AM_MAKEFLAGS) dist-gzip rm -rf $(distdir) - tar xvzf $< + tar xzf $(top_builddir)/$(DIST_ARCHIVE) ln -s packages/debian $(distdir) + +deb: deb-prepare cd $(distdir) && $(DPKG_BUILDPACKAGE) diff --git a/build-aux/doxygen.m4 b/build-aux/doxygen.m4 new file mode 100644 index 0000000..eefbf3f --- /dev/null +++ b/build-aux/doxygen.m4 @@ -0,0 +1,63 @@ +# -*-Autoconf-*- +# Copyright (C) 2009 by Thomas Moulard, FIXME. +# This file is part of the roboptim. +# +# roboptim is free software: you can redistribute it and/or modify +# it under the terms of the GNU General Public License as published by +# the Free Software Foundation, either version 3 of the License, or +# (at your option) any later version. +# +# Additional permission under section 7 of the GNU General Public +# License, version 3 ("GPLv3"): +# +# If you convey this file as part of a work that contains a +# configuration script generated by Autoconf, you may do so under +# terms of your choice. +# +# roboptim is distributed in the hope that it will be useful, +# but WITHOUT ANY WARRANTY; without even the implied warranty of +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +# GNU General Public License for more details. +# +# You should have received a copy of the GNU General Public License +# along with roboptim. If not, see <http://www.gnu.org/licenses/>. + +# serial 1 + +# ------ # +# README # +# ------ # + +# This m4 file can be used to search for Doxygen and its dependencies. + +m4_pattern_forbid([^JRL]) + +# JRL_PROG_DOXYGEN([REQUIRED_VERSION]) +# -------------------------------------------- +# Search for Doxygen and related tools (perl and dot). +AC_DEFUN([JRL_PROG_DOXYGEN], +[# Search for Doxygen and its related tools. +# Search for Doxygen. +AC_ARG_VAR([DOXYGEN], [the Doxygen documentation generation program]) +AC_CHECK_PROGS([DOXYGEN], [doxygen]) + + +# Search for Perl. +AC_ARG_VAR([PERL], [the perl interpreter]) +AC_CHECK_PROGS([PERL], [perl]) + +if test x"$PERL" = x; then + AC_MSG_FAILURE([Perl not found.]) +fi + + +# Search for Dot. +AC_ARG_VAR([DOT], [the dot graphic tool]) +AC_CHECK_PROGS([DOT], [dot]) + +if test x"$DOT" = x; then + AC_SUBST([HAVE_DOT], [NO]) +else + AC_SUBST([HAVE_DOT], [YES]) +fi +]) # JRL_PROG_DOXYGEN diff --git a/build-aux/ebuild.mk b/build-aux/ebuild.mk index ccf527c..e02d5cd 100644 --- a/build-aux/ebuild.mk +++ b/build-aux/ebuild.mk @@ -18,7 +18,7 @@ install-ebuild: echo "to the portage root you want to install the ebuild into.";\ else \ DIR="$$PORTAGE_ROOT/$(EBUILD_CATEGORY)/$(PACKAGE)"; \ - $(MKDIR_P) $$DIR/files; \ + $(mkdir_p) $$DIR/files; \ for i in `echo "$(EXTRA_DIST)" | sed 's/ /\n/g'`; do \ cp "$(srcdir)/$$i" "$$DIR"; \ if test x`echo "$$i" | grep "\.ebuild$$"` = "x$$i"; then \ diff --git a/build-aux/init.mk b/build-aux/init.mk index 038cd44..f7218a7 100644 --- a/build-aux/init.mk +++ b/build-aux/init.mk @@ -18,3 +18,6 @@ AM_CPPFLAGS += -I$(top_builddir)/src -I$(top_srcdir)/src # ...then search in distributed headers. AM_CPPFLAGS += -I$(top_srcdir)/include + +# Add boost include dir +AM_CPPFLAGS += $(BOOST_CPPFLAGS) diff --git a/build-aux/pkg-config.mk b/build-aux/pkg-config.mk new file mode 100644 index 0000000..5dc23aa --- /dev/null +++ b/build-aux/pkg-config.mk @@ -0,0 +1,83 @@ +# -*-Automake-*- +# Copyright (C) 2009 by Thomas Moulard, AIST, CNRS, INRIA. +# This file is part of the roboptim. +# +# roboptim is free software: you can redistribute it and/or modify +# it under the terms of the GNU General Public License as published by +# the Free Software Foundation, either version 3 of the License, or +# (at your option) any later version. +# +# Additional permission under section 7 of the GNU General Public +# License, version 3 ("GPLv3"): +# +# If you convey this file as part of a work that contains a +# configuration script generated by Autoconf, you may do so under +# terms of your choice. +# +# roboptim is distributed in the hope that it will be useful, +# but WITHOUT ANY WARRANTY; without even the implied warranty of +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +# GNU General Public License for more details. +# +# You should have received a copy of the GNU General Public License +# along with roboptim. If not, see <http://www.gnu.org/licenses/>. + +# -------# +# README # +# -------# + +# This file contains pkg-config generation rules for Automake. +# +# This file assumes that: +# +# - you include *before* this file init.mk or make sure that any global +# variable can be used with the += syntax. +# - there is no other rule using install-data-local and uninstall-data-local. +# +# The generate pkg-config files can be customized using three Autoconf +# variables: +# - PKGCONFIG_REQUIRES: package dependencies, +# - PKGCONFIG_LIBS: package LDFLAGS, +# - PKGCONFIG_CFLAGS: package CFLAGS/CPPFLAGS/CXXFLAGS. + + +# Variables +pkg_config_file = '@PACKAGE_TARNAME@.pc' +pkgdir = "$(DESTDIR)$(libdir)/pkgconfig/" + +edit = $(SED) -e "s|@prefix\@|$(prefix)|" \ + -e 's,@exec_prefix\@,$(exec_prefix),g' \ + -e 's,@libdir\@,$(libdir),g' \ + -e 's,@includedir\@,$(includedir),g' \ + -e 's,@datarootdir\@,$(datarootdir),g' \ + -e 's,@PACKAGE\@,$(PACKAGE),g' \ + -e 's,@PACKAGE_TARNAME\@,$(PACKAGE_TARNAME),g' \ + -e 's,@VERSION\@,$(PACKAGE_VERSION),g' + +EXTRA_DIST += build-aux/pkg-config.pc.in +CLEANFILES += $(PKG_CONFIG_FILE) + +# pkg-config generation. +@PACKAGE_TARNAME@.pc: $(srcdir)/build-aux/pkg-config.pc.in + $(top_builddir)/config.status \ + --file="$@":"$(srcdir)/build-aux/pkg-config.pc.in" + +# Install, uninstall rules. +install-data-local: install-pkg-config +uninstall-local: uninstall-pkg-config + +install-pkg-config: $(PACKAGE_TARNAME).pc + $(mkdir_p) $(PKG_DIR) + $(install_sh_DATA) "$(PKG_CONFIG_FILE)" $(PKG_DIR) + +uninstall-pkg-config: + -rm -f "$(PKG_DIR)$(PKG_CONFIG_FILE)" + +# Check that the pkg-config file is generated. +check-local: @PACKAGE_TARNAME@.pc + @if ! test -f $(pkg_config_file); then \ + echo 'pkg-config file missing: failing...'; \ + return 1; \ + else \ + echo 'pkg-config file has been generated: ok.'; \ + fi diff --git a/build-aux/pkg-config.pc.in b/build-aux/pkg-config.pc.in index 3ab185d..0670c39 100644 --- a/build-aux/pkg-config.pc.in +++ b/build-aux/pkg-config.pc.in @@ -6,8 +6,11 @@ datarootdir=@datarootdir@ docdir=@datarootdir@/doc/@PACKAGE_TARNAME@ Name: @PACKAGE@ -Description: +Description: @PKGCONFIG_DESCRIPTION@ +URL: http://roboptim.sourceforge.net/ Version: @VERSION@ -Requires: @PACKAGE_REQD@ -Libs: -L${libdir} -lroboptim-trajectory -Cflags: -I${includedir} +Requires: @PKGCONFIG_REQUIRES@ +Conflicts: @PKGCONFIG_CONFLICTS@ +Libs: -L${libdir} @PKGCONFIG_LIBS@ +Libs.private: +Cflags: -I${includedir} @PKGCONFIG_CFLAGS@ diff --git a/build-aux/rpm.mk b/build-aux/rpm.mk index 65c82d9..1a7160d 100644 --- a/build-aux/rpm.mk +++ b/build-aux/rpm.mk @@ -30,11 +30,11 @@ install-rpm-tree: echo "Please define RPM_TREE."; \ exit 1; \ fi - $(MKDIR_P) $$RPM_TREE/BUILD - $(MKDIR_P) $$RPM_TREE/RPMS - $(MKDIR_P) $$RPM_TREE/SOURCES - $(MKDIR_P) $$RPM_TREE/SPECS - $(MKDIR_P) $$RPM_TREE/SRPMS + $(mkdir_p) $$RPM_TREE/BUILD + $(mkdir_p) $$RPM_TREE/RPMS + $(mkdir_p) $$RPM_TREE/SOURCES + $(mkdir_p) $$RPM_TREE/SPECS + $(mkdir_p) $$RPM_TREE/SRPMS install-rpm-tarball: @if test "x$$RPM_TREE" = "x"; then \ diff --git a/configure.ac b/configure.ac index 75dbc02..e2c0c09 100644 --- a/configure.ac +++ b/configure.ac @@ -52,15 +52,25 @@ AC_PROG_MKDIR_P AC_PROG_SED # Search for Doxygen. -AC_ARG_VAR([DOXYGEN], [the Doxygen documentation generation program]) -AC_CHECK_PROGS([DOXYGEN], [doxygen]) +JRL_PROG_DOXYGEN # Search for Libtool. LT_INIT([dlopen]) # Search for RobOptim core. ROBOPTIM_CORE_PKG_CONFIG([roboptim-core >= 0.2]) -AC_SUBST([PACKAGE_REQD], ["roboptim-core >= 0.2"]) + + +## ------------ ## +## Pkg-config. ## +## ------------ ## + +AC_SUBST([PKGCONFIG_DESCRIPTION], ['RobOptim core library']) +AC_SUBST([PKGCONFIG_REQUIRES], ["roboptim-core >= 0.2"]) +AC_SUBST([PKGCONFIG_CONFLICTS], []) +AC_SUBST([PKGCONFIG_LIBS], [-lroboptim-core]) +AC_SUBST([PKGCONFIG_CFLAGS], []) + ## ------------ ## ## Test-suite. ## @@ -88,9 +98,5 @@ AC_CONFIG_FILES([ tests/package.m4 ]) -AC_CONFIG_FILES([doc/Doxyfile]) - -AC_CONFIG_FILES([doc/sf-upload.sh], [chmod +x doc/sf-upload.sh]) - # Write files. AC_OUTPUT diff --git a/doc/Doxyfile.in b/doc/Doxyfile.in index 913ce28..fd90e82 100644 --- a/doc/Doxyfile.in +++ b/doc/Doxyfile.in @@ -1,4 +1,4 @@ -# Doxyfile 1.5.4 +# Doxyfile 1.5.8 # This file describes the settings to be used by the documentation system # doxygen (www.doxygen.org) for a project @@ -14,11 +14,11 @@ # Project related configuration options #--------------------------------------------------------------------------- -# This tag specifies the encoding used for all characters in the config file that -# follow. The default is UTF-8 which is also the encoding used for all text before -# the first occurrence of this tag. Doxygen uses libiconv (or the iconv built into -# libc) for the transcoding. See http://www.gnu.org/software/libiconv for the list of -# possible encodings. +# This tag specifies the encoding used for all characters in the config file +# that follow. The default is UTF-8 which is also the encoding used for all +# text before the first occurrence of this tag. Doxygen uses libiconv (or the +# iconv built into libc) for the transcoding. See +# http://www.gnu.org/software/libiconv for the list of possible encodings. DOXYFILE_ENCODING = UTF-8 @@ -54,10 +54,11 @@ CREATE_SUBDIRS = NO # information to generate all constant output in the proper language. # The default language is English, other supported languages are: # Afrikaans, Arabic, Brazilian, Catalan, Chinese, Chinese-Traditional, -# Croatian, Czech, Danish, Dutch, Finnish, French, German, Greek, Hungarian, -# Italian, Japanese, Japanese-en (Japanese with English messages), Korean, -# Korean-en, Lithuanian, Norwegian, Polish, Portuguese, Romanian, Russian, -# Serbian, Slovak, Slovene, Spanish, Swedish, and Ukrainian. +# Croatian, Czech, Danish, Dutch, Farsi, Finnish, French, German, Greek, +# Hungarian, Italian, Japanese, Japanese-en (Japanese with English messages), +# Korean, Korean-en, Lithuanian, Norwegian, Macedonian, Persian, Polish, +# Portuguese, Romanian, Russian, Serbian, Serbian-Cyrilic, Slovak, Slovene, +# Spanish, Swedish, and Ukrainian. OUTPUT_LANGUAGE = English @@ -154,13 +155,6 @@ QT_AUTOBRIEF = NO MULTILINE_CPP_IS_BRIEF = NO -# If the DETAILS_AT_TOP tag is set to YES then Doxygen -# will output the detailed description near the top, like JavaDoc. -# If set to NO, the detailed description appears after the member -# documentation. - -DETAILS_AT_TOP = NO - # If the INHERIT_DOCS tag is set to YES (the default) then an undocumented # member inherits the documentation from any documented member that it # re-implements. @@ -195,14 +189,37 @@ ALIASES = OPTIMIZE_OUTPUT_FOR_C = NO # Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java -# sources only. Doxygen will then generate output that is more tailored for Java. -# For instance, namespaces will be presented as packages, qualified scopes -# will look different, etc. +# sources only. Doxygen will then generate output that is more tailored for +# Java. For instance, namespaces will be presented as packages, qualified +# scopes will look different, etc. OPTIMIZE_OUTPUT_JAVA = NO -# If you use STL classes (i.e. std::string, std::vector, etc.) but do not want to -# include (a tag file for) the STL sources as input, then you should +# Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran +# sources only. Doxygen will then generate output that is more tailored for +# Fortran. + +OPTIMIZE_FOR_FORTRAN = NO + +# Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL +# sources. Doxygen will then generate output that is tailored for +# VHDL. + +OPTIMIZE_OUTPUT_VHDL = NO + +# Doxygen selects the parser to use depending on the extension of the files it parses. +# With this tag you can assign which parser to use for a given extension. +# Doxygen has a built-in mapping, but you can override or extend it using this tag. +# The format is ext=language, where ext is a file extension, and language is one of +# the parsers supported by doxygen: IDL, Java, Javascript, C#, C, C++, D, PHP, +# Objective-C, Python, Fortran, VHDL, C, C++. For instance to make doxygen treat +# .inc files as Fortran files (default is PHP), and .f files as C (default is Fortran), +# use: inc=Fortran f=C + +EXTENSION_MAPPING = + +# If you use STL classes (i.e. std::string, std::vector, etc.) but do not want +# to include (a tag file for) the STL sources as input, then you should # set this tag to YES in order to let doxygen match functions declarations and # definitions whose arguments contain STL classes (e.g. func(std::string); v.s. # func(std::string) {}). This also make the inheritance and collaboration @@ -221,6 +238,15 @@ CPP_CLI_SUPPORT = NO SIP_SUPPORT = NO +# For Microsoft's IDL there are propget and propput attributes to indicate getter +# and setter methods for a property. Setting this option to YES (the default) +# will make doxygen to replace the get and set methods by a property in the +# documentation. This will only work if the methods are indeed getting or +# setting a simple type. If this is not the case, or you want to show the +# methods anyway, you should set this option to NO. + +IDL_PROPERTY_SUPPORT = YES + # If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC # tag is set to YES, then doxygen will reuse the documentation of the first # member in the group (if any) for the other members of the group. By default @@ -236,16 +262,32 @@ DISTRIBUTE_GROUP_DOC = NO SUBGROUPING = YES -# When TYPEDEF_HIDES_STRUCT is enabled, a typedef of a struct (or union) is -# documented as struct with the name of the typedef. So +# When TYPEDEF_HIDES_STRUCT is enabled, a typedef of a struct, union, or enum +# is documented as struct, union, or enum with the name of the typedef. So # typedef struct TypeS {} TypeT, will appear in the documentation as a struct # with name TypeT. When disabled the typedef will appear as a member of a file, # namespace, or class. And the struct will be named TypeS. This can typically -# be useful for C code where the coding convention is that all structs are -# typedef'ed and only the typedef is referenced never the struct's name. +# be useful for C code in case the coding convention dictates that all compound +# types are typedef'ed and only the typedef is referenced, never the tag name. TYPEDEF_HIDES_STRUCT = NO +# The SYMBOL_CACHE_SIZE determines the size of the internal cache use to +# determine which symbols to keep in memory and which to flush to disk. +# When the cache is full, less often used symbols will be written to disk. +# For small to medium size projects (<1000 input files) the default value is +# probably good enough. For larger projects a too small cache size can cause +# doxygen to be busy swapping symbols to and from disk most of the time +# causing a significant performance penality. +# If the system has enough physical memory increasing the cache will improve the +# performance by keeping more symbols in memory. Note that the value works on +# a logarithmic scale so increasing the size by one will rougly double the +# memory usage. The cache size is given by this formula: +# 2^(16+SYMBOL_CACHE_SIZE). The valid range is 0..9, the default is 0, +# corresponding to a cache size of 2^16 = 65536 symbols + +SYMBOL_CACHE_SIZE = 0 + #--------------------------------------------------------------------------- # Build related configuration options #--------------------------------------------------------------------------- @@ -280,10 +322,11 @@ EXTRACT_LOCAL_CLASSES = YES EXTRACT_LOCAL_METHODS = NO -# If this flag is set to YES, the members of anonymous namespaces will be extracted -# and appear in the documentation as a namespace called 'anonymous_namespace{file}', -# where file will be replaced with the base name of the file that contains the anonymous -# namespace. By default anonymous namespace are hidden. +# If this flag is set to YES, the members of anonymous namespaces will be +# extracted and appear in the documentation as a namespace called +# 'anonymous_namespace{file}', where file will be replaced with the base +# name of the file that contains the anonymous namespace. By default +# anonymous namespace are hidden. EXTRACT_ANON_NSPACES = NO @@ -362,6 +405,12 @@ SORT_MEMBER_DOCS = YES SORT_BRIEF_DOCS = NO +# If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the +# hierarchy of group names into alphabetical order. If set to NO (the default) +# the group names will appear in their defined order. + +SORT_GROUP_NAMES = NO + # If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be # sorted by fully-qualified names, including namespaces. If set to # NO (the default), the class list will be sorted only by class name, @@ -423,9 +472,22 @@ SHOW_USED_FILES = NO SHOW_DIRECTORIES = NO +# Set the SHOW_FILES tag to NO to disable the generation of the Files page. +# This will remove the Files entry from the Quick Index and from the +# Folder Tree View (if specified). The default is YES. + +SHOW_FILES = YES + +# Set the SHOW_NAMESPACES tag to NO to disable the generation of the +# Namespaces page. +# This will remove the Namespaces entry from the Quick Index +# and from the Folder Tree View (if specified). The default is YES. + +SHOW_NAMESPACES = YES + # The FILE_VERSION_FILTER tag can be used to specify a program or script that -# doxygen should invoke to get the current version for each file (typically from the -# version control system). Doxygen will invoke the program by executing (via +# doxygen should invoke to get the current version for each file (typically from +# the version control system). Doxygen will invoke the program by executing (via # popen()) the command <command> <input-file>, where <command> is the value of # the FILE_VERSION_FILTER tag, and <input-file> is the name of an input file # provided by doxygen. Whatever the program writes to standard output @@ -433,6 +495,15 @@ SHOW_DIRECTORIES = NO FILE_VERSION_FILTER = +# The LAYOUT_FILE tag can be used to specify a layout file which will be parsed by +# doxygen. The layout file controls the global structure of the generated output files +# in an output format independent way. The create the layout file that represents +# doxygen's defaults, run doxygen with the -l option. You can optionally specify a +# file name after the option, if omitted DoxygenLayout.xml will be used as the name +# of the layout file. + +LAYOUT_FILE = + #--------------------------------------------------------------------------- # configuration options related to warning and progress messages #--------------------------------------------------------------------------- @@ -493,12 +564,14 @@ WARN_LOGFILE = # directories like "/usr/src/myproject". Separate the files or directories # with spaces. -INPUT = @top_srcdir@/include @top_srcdir@/src +INPUT = @abs_top_srcdir@/include \ + @abs_top_srcdir@/src -# This tag can be used to specify the character encoding of the source files that -# doxygen parses. Internally doxygen uses the UTF-8 encoding, which is also the default -# input encoding. Doxygen uses libiconv (or the iconv built into libc) for the transcoding. -# See http://www.gnu.org/software/libiconv for the list of possible encodings. +# This tag can be used to specify the character encoding of the source files +# that doxygen parses. Internally doxygen uses the UTF-8 encoding, which is +# also the default input encoding. Doxygen uses libiconv (or the iconv built +# into libc) for the transcoding. See http://www.gnu.org/software/libiconv for +# the list of possible encodings. INPUT_ENCODING = UTF-8 @@ -509,7 +582,10 @@ INPUT_ENCODING = UTF-8 # *.c *.cc *.cxx *.cpp *.c++ *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh *.hxx # *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm *.py *.f90 -FILE_PATTERNS = *.cc *.hh *.hxx *.ice +FILE_PATTERNS = *.cc \ + *.hh \ + *.hxx \ + *.ice # The RECURSIVE tag can be used to turn specify whether or not subdirectories # should be searched for input files as well. Possible values are YES and NO. @@ -521,9 +597,9 @@ RECURSIVE = YES # excluded from the INPUT source files. This way you can easily exclude a # subdirectory from a directory tree whose root is specified with the INPUT tag. -EXCLUDE = @top_builddir@/packages \ - @top_builddir@/doc \ - @top_builddir@/@PACKAGE_TARNAME@-@PACKAGE_VERSION@ +EXCLUDE = @abs_top_builddir@/packages \ + @abs_top_builddir@/doc \ + @abs_top_builddir@/@PACKAGE_TARNAME@-@PACKAGE_VERSION@ # The EXCLUDE_SYMLINKS tag can be used select whether or not files or # directories that are symbolic links (a Unix filesystem feature) are excluded @@ -540,9 +616,10 @@ EXCLUDE_SYMLINKS = NO EXCLUDE_PATTERNS = # The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names -# (namespaces, classes, functions, etc.) that should be excluded from the output. -# The symbol name can be a fully qualified name, a word, or if the wildcard * is used, -# a substring. Examples: ANamespace, AClass, AClass::ANamespace, ANamespace::*Test +# (namespaces, classes, functions, etc.) that should be excluded from the +# output. The symbol name can be a fully qualified name, a word, or if the +# wildcard * is used, a substring. Examples: ANamespace, AClass, +# AClass::ANamespace, ANamespace::*Test EXCLUDE_SYMBOLS = roboptim::detail @@ -550,7 +627,7 @@ EXCLUDE_SYMBOLS = roboptim::detail # directories that contain example code fragments that are included (see # the \include command). -EXAMPLE_PATH = @top_srcdir@/tests +EXAMPLE_PATH = @abs_top_srcdir@/tests # If the value of the EXAMPLE_PATH tag contains directories, you can use the # EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp @@ -570,21 +647,24 @@ EXAMPLE_RECURSIVE = NO # directories that contain image that are included in the documentation (see # the \image command). -IMAGE_PATH = +IMAGE_PATH = @abs_top_srcdir@/doc # The INPUT_FILTER tag can be used to specify a program that doxygen should # invoke to filter for each input file. Doxygen will invoke the filter program # by executing (via popen()) the command <filter> <input-file>, where <filter> # is the value of the INPUT_FILTER tag, and <input-file> is the name of an # input file. Doxygen will then use the output that the filter program writes -# to standard output. If FILTER_PATTERNS is specified, this tag will be +# to standard output. +# If FILTER_PATTERNS is specified, this tag will be # ignored. INPUT_FILTER = # The FILTER_PATTERNS tag can be used to specify filters on a per file pattern -# basis. Doxygen will compare the file name with each pattern and apply the -# filter if there is a match. The filters are a list of the form: +# basis. +# Doxygen will compare the file name with each pattern and apply the +# filter if there is a match. +# The filters are a list of the form: # pattern=filter (like *.cpp=my_cpp_filter). See INPUT_FILTER for further # info on how filters are used. If FILTER_PATTERNS is empty, INPUT_FILTER # is applied to all files. @@ -604,9 +684,7 @@ FILTER_SOURCE_FILES = NO # If the SOURCE_BROWSER tag is set to YES then a list of source files will # be generated. Documented entities will be cross-referenced with these sources. # Note: To get rid of all source code in the generated output, make sure also -# VERBATIM_HEADERS is set to NO. If you have enabled CALL_GRAPH or CALLER_GRAPH -# then you must also enable this option. If you don't then doxygen will produce -# a warning and turn it on anyway +# VERBATIM_HEADERS is set to NO. SOURCE_BROWSER = NO @@ -621,13 +699,13 @@ INLINE_SOURCES = NO STRIP_CODE_COMMENTS = YES -# If the REFERENCED_BY_RELATION tag is set to YES (the default) +# If the REFERENCED_BY_RELATION tag is set to YES # then for each documented function all documented # functions referencing it will be listed. REFERENCED_BY_RELATION = YES -# If the REFERENCES_RELATION tag is set to YES (the default) +# If the REFERENCES_RELATION tag is set to YES # then for each documented function all documented entities # called/used by that function will be listed. @@ -636,7 +714,8 @@ REFERENCES_RELATION = YES # If the REFERENCES_LINK_SOURCE tag is set to YES (the default) # and SOURCE_BROWSER tag is set to YES, then the hyperlinks from # functions in REFERENCES_RELATION and REFERENCED_BY_RELATION lists will -# link to the source code. Otherwise they will link to the documentstion. +# link to the source code. +# Otherwise they will link to the documentation. REFERENCES_LINK_SOURCE = YES @@ -702,13 +781,13 @@ HTML_FILE_EXTENSION = .html # each generated HTML page. If it is left blank doxygen will generate a # standard header. -HTML_HEADER = @top_srcdir@/doc/header.html +HTML_HEADER = @abs_top_srcdir@/doc/header.html # The HTML_FOOTER tag can be used to specify a personal HTML footer for # each generated HTML page. If it is left blank doxygen will generate a # standard footer. -HTML_FOOTER = @top_srcdir@/doc/footer.html +HTML_FOOTER = @abs_top_srcdir@/doc/footer.html # The HTML_STYLESHEET tag can be used to specify a user-defined cascading # style sheet that is used by each HTML page. It can be used to @@ -717,7 +796,7 @@ HTML_FOOTER = @top_srcdir@/doc/footer.html # the style sheet file to the HTML output directory, so don't put your own # stylesheet in the HTML output directory as well, or it will be erased! -HTML_STYLESHEET = @top_srcdir@/doc/package.css +HTML_STYLESHEET = @abs_top_srcdir@/doc/package.css # If the HTML_ALIGN_MEMBERS tag is set to YES, the members of classes, # files or namespaces will be aligned in HTML using tables. If set to @@ -725,13 +804,6 @@ HTML_STYLESHEET = @top_srcdir@/doc/package.css HTML_ALIGN_MEMBERS = YES -# If the GENERATE_HTMLHELP tag is set to YES, additional index files -# will be generated that can be used as input for tools like the -# Microsoft HTML help workshop to generate a compressed HTML help file (.chm) -# of the generated HTML documentation. - -GENERATE_HTMLHELP = NO - # If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML # documentation will contain sections that can be hidden and shown after the # page has loaded. For this to work a browser that supports @@ -740,6 +812,39 @@ GENERATE_HTMLHELP = NO HTML_DYNAMIC_SECTIONS = YES +# If the GENERATE_DOCSET tag is set to YES, additional index files +# will be generated that can be used as input for Apple's Xcode 3 +# integrated development environment, introduced with OSX 10.5 (Leopard). +# To create a documentation set, doxygen will generate a Makefile in the +# HTML output directory. Running make will produce the docset in that +# directory and running "make install" will install the docset in +# ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find +# it at startup. +# See http://developer.apple.com/tools/creatingdocsetswithdoxygen.html for more information. + +GENERATE_DOCSET = NO + +# When GENERATE_DOCSET tag is set to YES, this tag determines the name of the +# feed. A documentation feed provides an umbrella under which multiple +# documentation sets from a single provider (such as a company or product suite) +# can be grouped. + +DOCSET_FEEDNAME = "Doxygen generated docs" + +# When GENERATE_DOCSET tag is set to YES, this tag specifies a string that +# should uniquely identify the documentation set bundle. This should be a +# reverse domain-name style string, e.g. com.mycompany.MyDocSet. Doxygen +# will append .docset to the name. + +DOCSET_BUNDLE_ID = org.doxygen.Project + +# If the GENERATE_HTMLHELP tag is set to YES, additional index files +# will be generated that can be used as input for tools like the +# Microsoft HTML help workshop to generate a compiled HTML help file (.chm) +# of the generated HTML documentation. + +GENERATE_HTMLHELP = NO + # If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can # be used to specify the file name of the resulting .chm file. You # can add a path in front of the file if the result should not be @@ -760,6 +865,12 @@ HHC_LOCATION = GENERATE_CHI = NO +# If the GENERATE_HTMLHELP tag is set to YES, the CHM_INDEX_ENCODING +# is used to encode HtmlHelp index (hhk), content (hhc) and project file +# content. + +CHM_INDEX_ENCODING = + # If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag # controls whether a binary table of contents is generated (YES) or a # normal table of contents (NO) in the .chm file. @@ -771,6 +882,55 @@ BINARY_TOC = NO TOC_EXPAND = NO +# If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and QHP_VIRTUAL_FOLDER +# are set, an additional index file will be generated that can be used as input for +# Qt's qhelpgenerator to generate a Qt Compressed Help (.qch) of the generated +# HTML documentation. + +GENERATE_QHP = NO + +# If the QHG_LOCATION tag is specified, the QCH_FILE tag can +# be used to specify the file name of the resulting .qch file. +# The path specified is relative to the HTML output folder. + +QCH_FILE = + +# The QHP_NAMESPACE tag specifies the namespace to use when generating +# Qt Help Project output. For more information please see +# http://doc.trolltech.com/qthelpproject.html#namespace + +QHP_NAMESPACE = + +# The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating +# Qt Help Project output. For more information please see +# http://doc.trolltech.com/qthelpproject.html#virtual-folders + +QHP_VIRTUAL_FOLDER = doc + +# If QHP_CUST_FILTER_NAME is set, it specifies the name of a custom filter to add. +# For more information please see +# http://doc.trolltech.com/qthelpproject.html#custom-filters + +QHP_CUST_FILTER_NAME = + +# The QHP_CUST_FILT_ATTRS tag specifies the list of the attributes of the custom filter to add.For more information please see +# <a href="http://doc.trolltech.com/qthelpproject.html#custom-filters">Qt Help Project / Custom Filters</a>. + +QHP_CUST_FILTER_ATTRS = + +# The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this project's +# filter section matches. +# <a href="http://doc.trolltech.com/qthelpproject.html#filter-attributes">Qt Help Project / Filter Attributes</a>. + +QHP_SECT_FILTER_ATTRS = + +# If the GENERATE_QHP tag is set to YES, the QHG_LOCATION tag can +# be used to specify the location of Qt's qhelpgenerator. +# If non-empty doxygen will try to run qhelpgenerator on the generated +# .qhp file. + +QHG_LOCATION = + # The DISABLE_INDEX tag can be used to turn on/off the condensed index at # top of each HTML page. The value NO (the default) enables the index and # the value YES disables it. @@ -782,12 +942,20 @@ DISABLE_INDEX = NO ENUM_VALUES_PER_LINE = 4 -# If the GENERATE_TREEVIEW tag is set to YES, a side panel will be -# generated containing a tree-like index structure (just like the one that +# The GENERATE_TREEVIEW tag is used to specify whether a tree-like index +# structure should be generated to display hierarchical information. +# If the tag value is set to FRAME, a side panel will be generated +# containing a tree-like index structure (just like the one that # is generated for HTML Help). For this to work a browser that supports # JavaScript, DHTML, CSS and frames is required (for instance Mozilla 1.0+, # Netscape 6.0+, Internet explorer 5.0+, or Konqueror). Windows users are -# probably better off using the HTML help feature. +# probably better off using the HTML help feature. Other possible values +# for this tag are: HIERARCHIES, which will generate the Groups, Directories, +# and Class Hierarchy pages using a tree view instead of an ordered list; +# ALL, which combines the behavior of FRAME and HIERARCHIES; and NONE, which +# disables this behavior completely. For backwards compatibility with previous +# releases of Doxygen, the values YES and NO are equivalent to FRAME and NONE +# respectively. GENERATE_TREEVIEW = YES @@ -797,6 +965,14 @@ GENERATE_TREEVIEW = YES TREEVIEW_WIDTH = 250 +# Use this tag to change the font size of Latex formulas included +# as images in the HTML documentation. The default is 10. Note that +# when you change the font size after a successful doxygen run you need +# to manually remove any form_*.png images from the HTML output directory +# to force them to be regenerated. + +FORMULA_FONTSIZE = 10 + #--------------------------------------------------------------------------- # configuration options related to the LaTeX output #--------------------------------------------------------------------------- @@ -1009,8 +1185,10 @@ GENERATE_PERLMOD = NO PERLMOD_LATEX = NO # If the PERLMOD_PRETTY tag is set to YES the Perl module output will be -# nicely formatted so it can be parsed by a human reader. This is useful -# if you want to understand what is going on. On the other hand, if this +# nicely formatted so it can be parsed by a human reader. +# This is useful +# if you want to understand what is going on. +# On the other hand, if this # tag is set to NO the size of the Perl module output will be much smaller # and Perl will parse it just the same. @@ -1097,9 +1275,11 @@ SKIP_FUNCTION_MACROS = YES # Optionally an initial location of the external documentation # can be added for each tagfile. The format of a tag file without # this location is as follows: -# TAGFILES = file1 file2 ... +# +# TAGFILES = file1 file2 ... # Adding location for the tag files is done as follows: -# TAGFILES = file1=loc1 "file2 = loc2" ... +# +# TAGFILES = file1=loc1 "file2 = loc2" ... # where "loc1" and "loc2" can be relative or absolute paths or # URLs. If a location is present for each tag, the installdox tool # does not have to be run to correct the links. @@ -1108,8 +1288,7 @@ SKIP_FUNCTION_MACROS = YES # If a tag file is not located in the directory in which doxygen # is run, you must also specify the path to the tagfile here. -TAGFILES = \ - @ROBOPTIMCORE_DOCDIR@/html/roboptim-core.doxytag=@ROBOPTIMCORE_DOCDIR@/html +TAGFILES = # When a file name is specified after GENERATE_TAGFILE, doxygen will create # a tag file that is based on the input files it reads. @@ -1131,7 +1310,7 @@ EXTERNAL_GROUPS = YES # The PERL_PATH should be the absolute path and name of the perl script # interpreter (i.e. the result of `which perl'). -PERL_PATH = /usr/bin/perl +PERL_PATH = @PERL@ #--------------------------------------------------------------------------- # Configuration options related to the dot tool @@ -1147,10 +1326,11 @@ PERL_PATH = /usr/bin/perl CLASS_DIAGRAMS = YES # You can define message sequence charts within doxygen comments using the \msc -# command. Doxygen will then run the mscgen tool (see http://www.mcternan.me.uk/mscgen/) to -# produce the chart and insert it in the documentation. The MSCGEN_PATH tag allows you to -# specify the directory where the mscgen tool resides. If left empty the tool is assumed to -# be found in the default search path. +# command. Doxygen will then run the mscgen tool (see +# http://www.mcternan.me.uk/mscgen/) to produce the chart and insert it in the +# documentation. The MSCGEN_PATH tag allows you to specify the directory where +# the mscgen tool resides. If left empty the tool is assumed to be found in the +# default search path. MSCGEN_PATH = @@ -1165,7 +1345,30 @@ HIDE_UNDOC_RELATIONS = YES # toolkit from AT&T and Lucent Bell Labs. The other options in this section # have no effect if this option is set to NO (the default) -HAVE_DOT = YES +HAVE_DOT = @HAVE_DOT@ + +# By default doxygen will write a font called FreeSans.ttf to the output +# directory and reference it in all dot files that doxygen generates. This +# font does not include all possible unicode characters however, so when you need +# these (or just want a differently looking font) you can specify the font name +# using DOT_FONTNAME. You need need to make sure dot is able to find the font, +# which can be done by putting it in a standard location or by setting the +# DOTFONTPATH environment variable or by setting DOT_FONTPATH to the directory +# containing the font. + +DOT_FONTNAME = FreeSans + +# The DOT_FONTSIZE tag can be used to set the size of the font of dot graphs. +# The default size is 10pt. + +DOT_FONTSIZE = 10 + +# By default doxygen will tell dot to use the output directory to look for the +# FreeSans.ttf font (which doxygen will put there itself). If you specify a +# different font using DOT_FONTNAME you can set the path where dot +# can find it using this tag. + +DOT_FONTPATH = # If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen # will generate a graph for each documented class showing the direct and @@ -1211,19 +1414,19 @@ INCLUDE_GRAPH = YES INCLUDED_BY_GRAPH = YES -# If the CALL_GRAPH, SOURCE_BROWSER and HAVE_DOT tags are set to YES then doxygen will -# generate a call dependency graph for every global function or class method. -# Note that enabling this option will significantly increase the time of a run. -# So in most cases it will be better to enable call graphs for selected -# functions only using the \callgraph command. +# If the CALL_GRAPH and HAVE_DOT options are set to YES then +# doxygen will generate a call dependency graph for every global function +# or class method. Note that enabling this option will significantly increase +# the time of a run. So in most cases it will be better to enable call graphs +# for selected functions only using the \callgraph command. CALL_GRAPH = NO -# If the CALLER_GRAPH, SOURCE_BROWSER and HAVE_DOT tags are set to YES then doxygen will -# generate a caller dependency graph for every global function or class method. -# Note that enabling this option will significantly increase the time of a run. -# So in most cases it will be better to enable caller graphs for selected -# functions only using the \callergraph command. +# If the CALLER_GRAPH and HAVE_DOT tags are set to YES then +# doxygen will generate a caller dependency graph for every global function +# or class method. Note that enabling this option will significantly increase +# the time of a run. So in most cases it will be better to enable caller +# graphs for selected functions only using the \callergraph command. CALLER_GRAPH = NO @@ -1256,12 +1459,12 @@ DOT_PATH = DOTFILE_DIRS = -# The MAX_DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of +# The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of # nodes that will be shown in the graph. If the number of nodes in a graph # becomes larger than this value, doxygen will truncate the graph, which is -# visualized by representing a node as a red box. Note that doxygen if the number -# of direct children of the root node in a graph is already larger than -# MAX_DOT_GRAPH_NOTES then the graph will not be shown at all. Also note +# visualized by representing a node as a red box. Note that doxygen if the +# number of direct children of the root node in a graph is already larger than +# DOT_GRAPH_MAX_NODES then the graph will not be shown at all. Also note # that the size of a graph can be further restricted by MAX_DOT_GRAPH_DEPTH. DOT_GRAPH_MAX_NODES = 50 @@ -1277,10 +1480,10 @@ DOT_GRAPH_MAX_NODES = 50 MAX_DOT_GRAPH_DEPTH = 0 # Set the DOT_TRANSPARENT tag to YES to generate images with a transparent -# background. This is disabled by default, which results in a white background. -# Warning: Depending on the platform used, enabling this option may lead to -# badly anti-aliased labels on the edges of a graph (i.e. they become hard to -# read). +# background. This is disabled by default, because dot on Windows does not +# seem to support this out of the box. Warning: Depending on the platform used, +# enabling this option may lead to badly anti-aliased labels on the edges of +# a graph (i.e. they become hard to read). DOT_TRANSPARENT = YES @@ -1304,7 +1507,7 @@ GENERATE_LEGEND = YES DOT_CLEANUP = YES #--------------------------------------------------------------------------- -# Configuration::additions related to the search engine +# Options related to the search engine #--------------------------------------------------------------------------- # The SEARCHENGINE tag specifies whether or not a search engine should be diff --git a/doc/Makefile.am b/doc/Makefile.am index c5139b7..cd1b864 100644 --- a/doc/Makefile.am +++ b/doc/Makefile.am @@ -1,25 +1,57 @@ -.PHONY: doc html install-doxygen-html uninstall-doxygen-html - +include $(top_srcdir)/build-aux/init.mk + +# Variables. +EXTRA_DIST += \ + Doxyfile.in \ + header.html \ + footer.html \ + package.css \ + doxygen.css \ + tabs.css \ + sf-upload.sh.in + +CLEANFILES += \ + $(PACKAGE_TARNAME).doxytag \ + Doxyfile \ + config.log + + +.PHONY: doc \ + html \ + doxygen \ + install-doxygen-html \ + uninstall-doxygen-html + +# Rules. doc: html -html-local: Doxyfile - $(DOXYGEN) +html-local: doxygen -EXTRA_DIST = Doxyfile.in header.html footer.html \ - package.css doxygen.css tabs.css sf-upload.sh.in +doxygen: Doxyfile + $(DOXYGEN) "$<" -CLEANFILES = $(PACKAGE_TARNAME).doxytag +# Doxygen generation rule. +Doxyfile: $(srcdir)/Doxyfile.in + $(top_builddir)/config.status --file="$@":"$<" \ + && sed -i -e 's/^#.*//' -e '/^$$/d' "$@" +# Clean rule. clean-local: rm -rf html latex +# Install rules. install-data-local: install-doxygen-html uninstall-local: uninstall-doxygen-html install-doxygen-html: html-local - $(mkdir_p) "$(DESTDIR)$(htmldir)/html" - cp -rf html/* "$(DESTDIR)$(htmldir)/html" + $(mkdir_p) "$(DESTDIR)$(htmldir)" + cp -rf html "$(DESTDIR)$(htmldir)" $(INSTALL_DATA) $(PACKAGE_TARNAME).doxytag "$(DESTDIR)$(htmldir)/html" uninstall-doxygen-html: rm -rf "$(DESTDIR)$(htmldir)" + +# --- SourceForge upload script. +# sf-upload.sh generation rule. +sf-upload.sh: $(srcdir)/sf-upload.sh.in + $(top_builddir)/config.status --file="$@":"$<" && chmod 755 "$@" diff --git a/doc/sf-upload.sh.in b/doc/sf-upload.sh.in index 52bcb10..62f902b 100644 --- a/doc/sf-upload.sh.in +++ b/doc/sf-upload.sh.in @@ -16,7 +16,7 @@ # # Then launch the script. It will prompt for your password # and upload the documentation in a @PACKAGE_TARNAME@ folder. - +set -e rsync=$(which rsync) @@ -31,12 +31,26 @@ if test "x$SF_USERNAME" = x; then exit 2 fi -echo "Fixing permissions." -chmod 755 @abs_builddir@/html && chmod 644 @abs_builddir@/html/* +if test "x$VERSION" = x; then + echo "No version set, defaulting to \`\`HEAD''." + VERSION=HEAD +fi + +rsync_cmd="$rsync -avP -e ssh" +localdir="@abs_top_builddir@/doc/html/" +pkgname=$(echo '@PACKAGE_TARNAME@' | sed 's|^roboptim-||') +remotedir="htdocs/doc/$pkgname/$VERSION" +rsync_loghost="$SF_USERNAME,rob...@we...:" + +echo "Fixing local rights."; +chmod 755 "$localdir" +find "$localdir" -type d -print0 | xargs -0 chmod 755 +find "$localdir" -type f -print0 | xargs -0 chmod 644 -echo "Uploading documentation to SourceForge server, please wait."; -$rsync -avP -e ssh @abs_builddir@/html/ \ - $SF_USERNAME,rob...@we...:htdocs/doc/trajectory/HEAD/ +echo "Uploading documentation to SourceForge server."; +$rsync_cmd "$localdir" "$rsync_loghost$remotedir" +#echo "Fixing documentation rights."; +#echo "cd \"$remotedir\"; chmod 644 *" | $rsync_cmd "$rsync_loghost$remotedir" ret="$?"; if test 0 -eq "$ret"; then echo "Done. Exiting"; ----------------------------------------------------------------------- Summary of changes: ChangeLog | 16 ++ build-aux/boost.m4 | 9 +- build-aux/deb.mk | 18 +- build-aux/{roboptim-core.m4 => doxygen.m4} | 52 +++-- build-aux/ebuild.mk | 2 +- build-aux/init.mk | 3 + build-aux/pkg-config.mk | 83 ++++++ build-aux/pkg-config.pc.in | 11 +- build-aux/rpm.mk | 10 +- configure.ac | 20 +- doc/Doxyfile.in | 401 +++++++++++++++++++++------- doc/Makefile.am | 50 +++- doc/sf-upload.sh.in | 26 ++- 13 files changed, 544 insertions(+), 157 deletions(-) copy build-aux/{roboptim-core.m4 => doxygen.m4} (59%) create mode 100644 build-aux/pkg-config.mk hooks/post-receive -- roboptim |
From: Thomas M. <tho...@us...> - 2009-06-10 09:53:56
|
This is an automated email from the git hooks/post-receive script. It was generated because a ref change was pushed to the repository containing the project "roboptim". The branch, core has been updated via 2331fd79c977c584ba2656529e2527c16561a8e2 (commit) from 453c8ba5157b49abf4e2ff3df0b6e8f62e09fd89 (commit) Those revisions listed above that are new to this repository have not appeared on any other notification email; so we list those revisions in full, below. - Log ----------------------------------------------------------------- commit 2331fd79c977c584ba2656529e2527c16561a8e2 Author: Thomas Moulard <tho...@gm...> Date: Wed Jun 10 18:51:41 2009 +0900 Synchronize. * doc/sf-upload.sh.in: Here. Signed-off-by: Thomas Moulard <tho...@gm...> diff --git a/ChangeLog b/ChangeLog index 659461a..5a98f0e 100644 --- a/ChangeLog +++ b/ChangeLog @@ -1,5 +1,10 @@ 2009-06-10 Thomas Moulard <tho...@gm...> + Synchronize. + * doc/sf-upload.sh.in: Here. + +2009-06-10 Thomas Moulard <tho...@gm...> + Use new pkg-config rules. * Makefile.am: Here. diff --git a/doc/sf-upload.sh.in b/doc/sf-upload.sh.in index 5db289b..62f902b 100644 --- a/doc/sf-upload.sh.in +++ b/doc/sf-upload.sh.in @@ -38,7 +38,8 @@ fi rsync_cmd="$rsync -avP -e ssh" localdir="@abs_top_builddir@/doc/html/" -remotedir="htdocs/doc/core/$VERSION" +pkgname=$(echo '@PACKAGE_TARNAME@' | sed 's|^roboptim-||') +remotedir="htdocs/doc/$pkgname/$VERSION" rsync_loghost="$SF_USERNAME,rob...@we...:" echo "Fixing local rights."; ----------------------------------------------------------------------- Summary of changes: ChangeLog | 5 +++++ doc/sf-upload.sh.in | 3 ++- 2 files changed, 7 insertions(+), 1 deletions(-) hooks/post-receive -- roboptim |
From: Thomas M. <tho...@us...> - 2009-06-10 09:41:59
|
This is an automated email from the git hooks/post-receive script. It was generated because a ref change was pushed to the repository containing the project "roboptim". The branch, core has been updated via 453c8ba5157b49abf4e2ff3df0b6e8f62e09fd89 (commit) from 2899cd309eadd8a71814349c40999b8df7c0ad5a (commit) Those revisions listed above that are new to this repository have not appeared on any other notification email; so we list those revisions in full, below. - Log ----------------------------------------------------------------- commit 453c8ba5157b49abf4e2ff3df0b6e8f62e09fd89 Author: Thomas Moulard <tho...@gm...> Date: Wed Jun 10 18:41:22 2009 +0900 Use new pkg-config rules. * Makefile.am: Here. Signed-off-by: Thomas Moulard <tho...@gm...> diff --git a/ChangeLog b/ChangeLog index 5ba65b2..659461a 100644 --- a/ChangeLog +++ b/ChangeLog @@ -1,5 +1,10 @@ 2009-06-10 Thomas Moulard <tho...@gm...> + Use new pkg-config rules. + * Makefile.am: Here. + +2009-06-10 Thomas Moulard <tho...@gm...> + Synchronize with share. * doc/Makefile.am, * doc/sf-upload.sh.in: Synchronize. diff --git a/Makefile.am b/Makefile.am index ba43f09..acd4386 100644 --- a/Makefile.am +++ b/Makefile.am @@ -1,3 +1,5 @@ +include $(top_srcdir)/build-aux/init.mk + # Search for autoconf macros in build-aux. ACLOCAL_AMFLAGS = -I build-aux @@ -33,21 +35,7 @@ edit = $(SED) -e "s|@prefix\@|$(prefix)|" \ -e 's,@PACKAGE_TARNAME\@,$(PACKAGE_TARNAME),g' \ -e 's,@VERSION\@,$(PACKAGE_VERSION),g' -@PACKAGE_TARNAME@.pc: $(srcdir)/configure $(srcdir)/build-aux/pkg-config.pc.in - $(edit) $(srcdir)/build-aux/pkg-config.pc.in >$@ - -EXTRA_DIST += build-aux/pkg-config.pc.in -CLEANFILES = $(PKG_CONFIG_FILE) - -install-data-local: install-pkg-config -uninstall-local: uninstall-pkg-config - -install-pkg-config: $(PACKAGE_TARNAME).pc - $(mkdir_p) $(PKG_DIR) - cp "$(PKG_CONFIG_FILE)" $(PKG_DIR) - -uninstall-pkg-config: - rm "$(PKG_DIR)$(PKG_CONFIG_FILE)" +include $(top_srcdir)/build-aux/pkg-config.mk # -- Generate documentation ----------------------------------------------------------------------- Summary of changes: ChangeLog | 5 +++++ Makefile.am | 18 +++--------------- 2 files changed, 8 insertions(+), 15 deletions(-) hooks/post-receive -- roboptim |
From: Thomas M. <tho...@us...> - 2009-06-10 09:37:51
|
This is an automated email from the git hooks/post-receive script. It was generated because a ref change was pushed to the repository containing the project "roboptim". The branch, core has been updated via 2899cd309eadd8a71814349c40999b8df7c0ad5a (commit) from 632ffc70e3840571e8a9e2cdc19860f57f5a0cce (commit) Those revisions listed above that are new to this repository have not appeared on any other notification email; so we list those revisions in full, below. - Log ----------------------------------------------------------------- commit 2899cd309eadd8a71814349c40999b8df7c0ad5a Author: Thomas Moulard <tho...@gm...> Date: Wed Jun 10 18:36:58 2009 +0900 Synchronize with share. * doc/Makefile.am, * doc/sf-upload.sh.in: Synchronize. Signed-off-by: Thomas Moulard <tho...@gm...> diff --git a/ChangeLog b/ChangeLog index 459249e..5ba65b2 100644 --- a/ChangeLog +++ b/ChangeLog @@ -1,5 +1,11 @@ 2009-06-10 Thomas Moulard <tho...@gm...> + Synchronize with share. + * doc/Makefile.am, + * doc/sf-upload.sh.in: Synchronize. + +2009-06-10 Thomas Moulard <tho...@gm...> + Synhronize with share. * build-aux/doxygen.m4: New. * build-aux/pkg-config.mk: New. diff --git a/doc/Makefile.am b/doc/Makefile.am index 8b8ae75..cd1b864 100644 --- a/doc/Makefile.am +++ b/doc/Makefile.am @@ -10,7 +10,10 @@ EXTRA_DIST += \ tabs.css \ sf-upload.sh.in -CLEANFILES += $(PACKAGE_TARNAME).doxytag +CLEANFILES += \ + $(PACKAGE_TARNAME).doxytag \ + Doxyfile \ + config.log .PHONY: doc \ @@ -51,4 +54,4 @@ uninstall-doxygen-html: # --- SourceForge upload script. # sf-upload.sh generation rule. sf-upload.sh: $(srcdir)/sf-upload.sh.in - $(top_builddir)/config.status --file="$@":"$<" && chmod u+x "$@" + $(top_builddir)/config.status --file="$@":"$<" && chmod 755 "$@" diff --git a/doc/sf-upload.sh.in b/doc/sf-upload.sh.in index 3f11bc7..5db289b 100644 --- a/doc/sf-upload.sh.in +++ b/doc/sf-upload.sh.in @@ -32,17 +32,20 @@ if test "x$SF_USERNAME" = x; then fi if test "x$VERSION" = x; then - echo "No version set, defaulting to ``HEAD''." + echo "No version set, defaulting to \`\`HEAD''." VERSION=HEAD fi rsync_cmd="$rsync -avP -e ssh" -localdir="@abs_builddir@/html/" +localdir="@abs_top_builddir@/doc/html/" remotedir="htdocs/doc/core/$VERSION" rsync_loghost="$SF_USERNAME,rob...@we...:" echo "Fixing local rights."; -chmod 644 "$localdir/*" +chmod 755 "$localdir" +find "$localdir" -type d -print0 | xargs -0 chmod 755 +find "$localdir" -type f -print0 | xargs -0 chmod 644 + echo "Uploading documentation to SourceForge server."; $rsync_cmd "$localdir" "$rsync_loghost$remotedir" #echo "Fixing documentation rights."; ----------------------------------------------------------------------- Summary of changes: ChangeLog | 6 ++++++ doc/Makefile.am | 7 +++++-- doc/sf-upload.sh.in | 9 ++++++--- 3 files changed, 17 insertions(+), 5 deletions(-) hooks/post-receive -- roboptim |
From: Thomas M. <tho...@us...> - 2009-06-10 09:36:44
|
This is an automated email from the git hooks/post-receive script. It was generated because a ref change was pushed to the repository containing the project "roboptim". The branch, share has been updated via e71c6d43aa3bc575d7fd05c0279702f3c0cba844 (commit) from d6cbc53dbe2e353f7f064489559581863cb2c2f6 (commit) Those revisions listed above that are new to this repository have not appeared on any other notification email; so we list those revisions in full, below. - Log ----------------------------------------------------------------- commit e71c6d43aa3bc575d7fd05c0279702f3c0cba844 Author: Thomas Moulard <tho...@gm...> Date: Wed Jun 10 18:36:15 2009 +0900 Fix documentation rules. * doc/Makefile.am: Fix CLEANFILES variable. * doc/sf-upload.sh.in: Fix permissions before uploading documentation. Signed-off-by: Thomas Moulard <tho...@gm...> diff --git a/ChangeLog b/ChangeLog index a3acb2f..0aef146 100644 --- a/ChangeLog +++ b/ChangeLog @@ -1,5 +1,12 @@ 2009-06-10 Thomas Moulard <tho...@gm...> + Fix documentation rules. + * doc/Makefile.am: Fix CLEANFILES variable. + * doc/sf-upload.sh.in: Fix permissions + before uploading documentation. + +2009-06-10 Thomas Moulard <tho...@gm...> + Add roboptim-core.m4 file. * build-aux/roboptim-core.m4: New. diff --git a/doc/Makefile.am b/doc/Makefile.am index 8b8ae75..cd1b864 100644 --- a/doc/Makefile.am +++ b/doc/Makefile.am @@ -10,7 +10,10 @@ EXTRA_DIST += \ tabs.css \ sf-upload.sh.in -CLEANFILES += $(PACKAGE_TARNAME).doxytag +CLEANFILES += \ + $(PACKAGE_TARNAME).doxytag \ + Doxyfile \ + config.log .PHONY: doc \ @@ -51,4 +54,4 @@ uninstall-doxygen-html: # --- SourceForge upload script. # sf-upload.sh generation rule. sf-upload.sh: $(srcdir)/sf-upload.sh.in - $(top_builddir)/config.status --file="$@":"$<" && chmod u+x "$@" + $(top_builddir)/config.status --file="$@":"$<" && chmod 755 "$@" diff --git a/doc/sf-upload.sh.in b/doc/sf-upload.sh.in index 3f11bc7..5db289b 100644 --- a/doc/sf-upload.sh.in +++ b/doc/sf-upload.sh.in @@ -32,17 +32,20 @@ if test "x$SF_USERNAME" = x; then fi if test "x$VERSION" = x; then - echo "No version set, defaulting to ``HEAD''." + echo "No version set, defaulting to \`\`HEAD''." VERSION=HEAD fi rsync_cmd="$rsync -avP -e ssh" -localdir="@abs_builddir@/html/" +localdir="@abs_top_builddir@/doc/html/" remotedir="htdocs/doc/core/$VERSION" rsync_loghost="$SF_USERNAME,rob...@we...:" echo "Fixing local rights."; -chmod 644 "$localdir/*" +chmod 755 "$localdir" +find "$localdir" -type d -print0 | xargs -0 chmod 755 +find "$localdir" -type f -print0 | xargs -0 chmod 644 + echo "Uploading documentation to SourceForge server."; $rsync_cmd "$localdir" "$rsync_loghost$remotedir" #echo "Fixing documentation rights."; ----------------------------------------------------------------------- Summary of changes: ChangeLog | 7 +++++++ doc/Makefile.am | 7 +++++-- doc/sf-upload.sh.in | 9 ++++++--- 3 files changed, 18 insertions(+), 5 deletions(-) hooks/post-receive -- roboptim |
From: Thomas M. <tho...@us...> - 2009-06-10 09:22:45
|
This is an automated email from the git hooks/post-receive script. It was generated because a ref change was pushed to the repository containing the project "roboptim". The branch, core has been updated via 632ffc70e3840571e8a9e2cdc19860f57f5a0cce (commit) from 86b30c5db55e64fb78153b994af55177ecf2a360 (commit) Those revisions listed above that are new to this repository have not appeared on any other notification email; so we list those revisions in full, below. - Log ----------------------------------------------------------------- commit 632ffc70e3840571e8a9e2cdc19860f57f5a0cce Author: Thomas Moulard <tho...@gm...> Date: Wed Jun 10 18:22:16 2009 +0900 Synhronize with share. * build-aux/doxygen.m4: New. * build-aux/pkg-config.mk: New. * build-aux/pkg-config.pc.in: Synchronize. * build-aux/roboptim-core.m4: New. * configure.ac: Update to use new rules. * doc/Doxyfile.in, * doc/Makefile.am, * doc/sf-upload.sh.in: Synchronize. Signed-off-by: Thomas Moulard <tho...@gm...> diff --git a/ChangeLog b/ChangeLog index ef5a26d..459249e 100644 --- a/ChangeLog +++ b/ChangeLog @@ -1,3 +1,15 @@ +2009-06-10 Thomas Moulard <tho...@gm...> + + Synhronize with share. + * build-aux/doxygen.m4: New. + * build-aux/pkg-config.mk: New. + * build-aux/pkg-config.pc.in: Synchronize. + * build-aux/roboptim-core.m4: New. + * configure.ac: Update to use new rules. + * doc/Doxyfile.in, + * doc/Makefile.am, + * doc/sf-upload.sh.in: Synchronize. + 2009-06-08 Thomas Moulard <tho...@gm...> Fix compilation warning. diff --git a/build-aux/doxygen.m4 b/build-aux/doxygen.m4 new file mode 100644 index 0000000..eefbf3f --- /dev/null +++ b/build-aux/doxygen.m4 @@ -0,0 +1,63 @@ +# -*-Autoconf-*- +# Copyright (C) 2009 by Thomas Moulard, FIXME. +# This file is part of the roboptim. +# +# roboptim is free software: you can redistribute it and/or modify +# it under the terms of the GNU General Public License as published by +# the Free Software Foundation, either version 3 of the License, or +# (at your option) any later version. +# +# Additional permission under section 7 of the GNU General Public +# License, version 3 ("GPLv3"): +# +# If you convey this file as part of a work that contains a +# configuration script generated by Autoconf, you may do so under +# terms of your choice. +# +# roboptim is distributed in the hope that it will be useful, +# but WITHOUT ANY WARRANTY; without even the implied warranty of +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +# GNU General Public License for more details. +# +# You should have received a copy of the GNU General Public License +# along with roboptim. If not, see <http://www.gnu.org/licenses/>. + +# serial 1 + +# ------ # +# README # +# ------ # + +# This m4 file can be used to search for Doxygen and its dependencies. + +m4_pattern_forbid([^JRL]) + +# JRL_PROG_DOXYGEN([REQUIRED_VERSION]) +# -------------------------------------------- +# Search for Doxygen and related tools (perl and dot). +AC_DEFUN([JRL_PROG_DOXYGEN], +[# Search for Doxygen and its related tools. +# Search for Doxygen. +AC_ARG_VAR([DOXYGEN], [the Doxygen documentation generation program]) +AC_CHECK_PROGS([DOXYGEN], [doxygen]) + + +# Search for Perl. +AC_ARG_VAR([PERL], [the perl interpreter]) +AC_CHECK_PROGS([PERL], [perl]) + +if test x"$PERL" = x; then + AC_MSG_FAILURE([Perl not found.]) +fi + + +# Search for Dot. +AC_ARG_VAR([DOT], [the dot graphic tool]) +AC_CHECK_PROGS([DOT], [dot]) + +if test x"$DOT" = x; then + AC_SUBST([HAVE_DOT], [NO]) +else + AC_SUBST([HAVE_DOT], [YES]) +fi +]) # JRL_PROG_DOXYGEN diff --git a/build-aux/pkg-config.mk b/build-aux/pkg-config.mk new file mode 100644 index 0000000..5dc23aa --- /dev/null +++ b/build-aux/pkg-config.mk @@ -0,0 +1,83 @@ +# -*-Automake-*- +# Copyright (C) 2009 by Thomas Moulard, AIST, CNRS, INRIA. +# This file is part of the roboptim. +# +# roboptim is free software: you can redistribute it and/or modify +# it under the terms of the GNU General Public License as published by +# the Free Software Foundation, either version 3 of the License, or +# (at your option) any later version. +# +# Additional permission under section 7 of the GNU General Public +# License, version 3 ("GPLv3"): +# +# If you convey this file as part of a work that contains a +# configuration script generated by Autoconf, you may do so under +# terms of your choice. +# +# roboptim is distributed in the hope that it will be useful, +# but WITHOUT ANY WARRANTY; without even the implied warranty of +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +# GNU General Public License for more details. +# +# You should have received a copy of the GNU General Public License +# along with roboptim. If not, see <http://www.gnu.org/licenses/>. + +# -------# +# README # +# -------# + +# This file contains pkg-config generation rules for Automake. +# +# This file assumes that: +# +# - you include *before* this file init.mk or make sure that any global +# variable can be used with the += syntax. +# - there is no other rule using install-data-local and uninstall-data-local. +# +# The generate pkg-config files can be customized using three Autoconf +# variables: +# - PKGCONFIG_REQUIRES: package dependencies, +# - PKGCONFIG_LIBS: package LDFLAGS, +# - PKGCONFIG_CFLAGS: package CFLAGS/CPPFLAGS/CXXFLAGS. + + +# Variables +pkg_config_file = '@PACKAGE_TARNAME@.pc' +pkgdir = "$(DESTDIR)$(libdir)/pkgconfig/" + +edit = $(SED) -e "s|@prefix\@|$(prefix)|" \ + -e 's,@exec_prefix\@,$(exec_prefix),g' \ + -e 's,@libdir\@,$(libdir),g' \ + -e 's,@includedir\@,$(includedir),g' \ + -e 's,@datarootdir\@,$(datarootdir),g' \ + -e 's,@PACKAGE\@,$(PACKAGE),g' \ + -e 's,@PACKAGE_TARNAME\@,$(PACKAGE_TARNAME),g' \ + -e 's,@VERSION\@,$(PACKAGE_VERSION),g' + +EXTRA_DIST += build-aux/pkg-config.pc.in +CLEANFILES += $(PKG_CONFIG_FILE) + +# pkg-config generation. +@PACKAGE_TARNAME@.pc: $(srcdir)/build-aux/pkg-config.pc.in + $(top_builddir)/config.status \ + --file="$@":"$(srcdir)/build-aux/pkg-config.pc.in" + +# Install, uninstall rules. +install-data-local: install-pkg-config +uninstall-local: uninstall-pkg-config + +install-pkg-config: $(PACKAGE_TARNAME).pc + $(mkdir_p) $(PKG_DIR) + $(install_sh_DATA) "$(PKG_CONFIG_FILE)" $(PKG_DIR) + +uninstall-pkg-config: + -rm -f "$(PKG_DIR)$(PKG_CONFIG_FILE)" + +# Check that the pkg-config file is generated. +check-local: @PACKAGE_TARNAME@.pc + @if ! test -f $(pkg_config_file); then \ + echo 'pkg-config file missing: failing...'; \ + return 1; \ + else \ + echo 'pkg-config file has been generated: ok.'; \ + fi diff --git a/build-aux/pkg-config.pc.in b/build-aux/pkg-config.pc.in index 667ab3a..0670c39 100644 --- a/build-aux/pkg-config.pc.in +++ b/build-aux/pkg-config.pc.in @@ -6,8 +6,11 @@ datarootdir=@datarootdir@ docdir=@datarootdir@/doc/@PACKAGE_TARNAME@ Name: @PACKAGE@ -Description: +Description: @PKGCONFIG_DESCRIPTION@ +URL: http://roboptim.sourceforge.net/ Version: @VERSION@ -Requires: -Libs: -L${libdir} -lroboptim-core -Cflags: -I${includedir} +Requires: @PKGCONFIG_REQUIRES@ +Conflicts: @PKGCONFIG_CONFLICTS@ +Libs: -L${libdir} @PKGCONFIG_LIBS@ +Libs.private: +Cflags: -I${includedir} @PKGCONFIG_CFLAGS@ diff --git a/build-aux/roboptim-core.m4 b/build-aux/roboptim-core.m4 new file mode 100644 index 0000000..b21cdc1 --- /dev/null +++ b/build-aux/roboptim-core.m4 @@ -0,0 +1,53 @@ +# -*-Autoconf-*- +# Copyright (C) 2009 by Thomas Moulard, FIXME. +# This file is part of the roboptim. +# +# roboptim is free software: you can redistribute it and/or modify +# it under the terms of the GNU General Public License as published by +# the Free Software Foundation, either version 3 of the License, or +# (at your option) any later version. +# +# Additional permission under section 7 of the GNU General Public +# License, version 3 ("GPLv3"): +# +# If you convey this file as part of a work that contains a +# configuration script generated by Autoconf, you may do so under +# terms of your choice. +# +# roboptim is distributed in the hope that it will be useful, +# but WITHOUT ANY WARRANTY; without even the implied warranty of +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +# GNU General Public License for more details. +# +# You should have received a copy of the GNU General Public License +# along with roboptim. If not, see <http://www.gnu.org/licenses/>. + +# serial 2 + +# ------ # +# README # +# ------ # + +# This m4 file can be used to check for the roboptim library. +# You can copy it into your software's aux dir and call the following +# macro to check for the library. +# +# ROBOPTIM_CORE_PKG_CONFIG: add a hard dependency against roboptim-core +# using pkg-config. + +m4_pattern_forbid([^ROBOPTIM_CORE]) + +# ROBOPTIM_CORE_PKG_CONFIG([REQUIRED_VERSION]) +# -------------------------------------------- +# Search for roboptim-core using pkg-config. +# REQUIRED_VERSION represent how to check the version. +# Example: ``roboptim-core >= 0.1'' +AC_DEFUN([ROBOPTIM_CORE_PKG_CONFIG], +[ +PKG_CHECK_MODULES([ROBOPTIMCORE], m4_default($1, roboptim-core)) + +ROBOPTIMCORE_DOCDIR=`$PKG_CONFIG roboptim-core --variable=docdir` +AC_SUBST([ROBOPTIMCORE_DOCDIR]) +AC_SUBST([ROBOPTIMCORE_CFLAGS]) +AC_SUBST([ROBOPTIMCORE_LIBS]) +]) # ROBOPTIM_CORE_PKG_CONFIG diff --git a/configure.ac b/configure.ac index 47591c3..3c4b268 100644 --- a/configure.ac +++ b/configure.ac @@ -51,8 +51,8 @@ AC_CONFIG_MACRO_DIR([build-aux]) AC_PROG_MKDIR_P AC_PROG_SED -AC_ARG_VAR([DOXYGEN], [the Doxygen documentation generation program]) -AC_CHECK_PROGS([DOXYGEN], [doxygen]) +# Search for Doxygen. +JRL_PROG_DOXYGEN # Search for Libtool. LT_INIT([dlopen]) @@ -72,6 +72,18 @@ BOOST_TYPETRAITS BOOST_UTILITY BOOST_VARIANT + +## ------------ ## +## Pkg-config. ## +## ------------ ## + +AC_SUBST([PKGCONFIG_DESCRIPTION], ['RobOptim core library']) +AC_SUBST([PKGCONFIG_REQUIRES], []) +AC_SUBST([PKGCONFIG_CONFLICTS], []) +AC_SUBST([PKGCONFIG_LIBS], [-lroboptim-core]) +AC_SUBST([PKGCONFIG_CFLAGS], []) + + ## ------------ ## ## Test-suite. ## ## ------------ ## @@ -98,9 +110,5 @@ AC_CONFIG_FILES([ tests/package.m4 ]) -AC_CONFIG_FILES([doc/Doxyfile]) - -AC_CONFIG_FILES([doc/sf-upload.sh], [chmod +x doc/sf-upload.sh]) - # Write files. AC_OUTPUT diff --git a/doc/Doxyfile.in b/doc/Doxyfile.in index f764f10..fd90e82 100644 --- a/doc/Doxyfile.in +++ b/doc/Doxyfile.in @@ -1,4 +1,4 @@ -# Doxyfile 1.5.4 +# Doxyfile 1.5.8 # This file describes the settings to be used by the documentation system # doxygen (www.doxygen.org) for a project @@ -14,11 +14,11 @@ # Project related configuration options #--------------------------------------------------------------------------- -# This tag specifies the encoding used for all characters in the config file that -# follow. The default is UTF-8 which is also the encoding used for all text before -# the first occurrence of this tag. Doxygen uses libiconv (or the iconv built into -# libc) for the transcoding. See http://www.gnu.org/software/libiconv for the list of -# possible encodings. +# This tag specifies the encoding used for all characters in the config file +# that follow. The default is UTF-8 which is also the encoding used for all +# text before the first occurrence of this tag. Doxygen uses libiconv (or the +# iconv built into libc) for the transcoding. See +# http://www.gnu.org/software/libiconv for the list of possible encodings. DOXYFILE_ENCODING = UTF-8 @@ -54,10 +54,11 @@ CREATE_SUBDIRS = NO # information to generate all constant output in the proper language. # The default language is English, other supported languages are: # Afrikaans, Arabic, Brazilian, Catalan, Chinese, Chinese-Traditional, -# Croatian, Czech, Danish, Dutch, Finnish, French, German, Greek, Hungarian, -# Italian, Japanese, Japanese-en (Japanese with English messages), Korean, -# Korean-en, Lithuanian, Norwegian, Polish, Portuguese, Romanian, Russian, -# Serbian, Slovak, Slovene, Spanish, Swedish, and Ukrainian. +# Croatian, Czech, Danish, Dutch, Farsi, Finnish, French, German, Greek, +# Hungarian, Italian, Japanese, Japanese-en (Japanese with English messages), +# Korean, Korean-en, Lithuanian, Norwegian, Macedonian, Persian, Polish, +# Portuguese, Romanian, Russian, Serbian, Serbian-Cyrilic, Slovak, Slovene, +# Spanish, Swedish, and Ukrainian. OUTPUT_LANGUAGE = English @@ -154,13 +155,6 @@ QT_AUTOBRIEF = NO MULTILINE_CPP_IS_BRIEF = NO -# If the DETAILS_AT_TOP tag is set to YES then Doxygen -# will output the detailed description near the top, like JavaDoc. -# If set to NO, the detailed description appears after the member -# documentation. - -DETAILS_AT_TOP = NO - # If the INHERIT_DOCS tag is set to YES (the default) then an undocumented # member inherits the documentation from any documented member that it # re-implements. @@ -195,14 +189,37 @@ ALIASES = OPTIMIZE_OUTPUT_FOR_C = NO # Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java -# sources only. Doxygen will then generate output that is more tailored for Java. -# For instance, namespaces will be presented as packages, qualified scopes -# will look different, etc. +# sources only. Doxygen will then generate output that is more tailored for +# Java. For instance, namespaces will be presented as packages, qualified +# scopes will look different, etc. OPTIMIZE_OUTPUT_JAVA = NO -# If you use STL classes (i.e. std::string, std::vector, etc.) but do not want to -# include (a tag file for) the STL sources as input, then you should +# Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran +# sources only. Doxygen will then generate output that is more tailored for +# Fortran. + +OPTIMIZE_FOR_FORTRAN = NO + +# Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL +# sources. Doxygen will then generate output that is tailored for +# VHDL. + +OPTIMIZE_OUTPUT_VHDL = NO + +# Doxygen selects the parser to use depending on the extension of the files it parses. +# With this tag you can assign which parser to use for a given extension. +# Doxygen has a built-in mapping, but you can override or extend it using this tag. +# The format is ext=language, where ext is a file extension, and language is one of +# the parsers supported by doxygen: IDL, Java, Javascript, C#, C, C++, D, PHP, +# Objective-C, Python, Fortran, VHDL, C, C++. For instance to make doxygen treat +# .inc files as Fortran files (default is PHP), and .f files as C (default is Fortran), +# use: inc=Fortran f=C + +EXTENSION_MAPPING = + +# If you use STL classes (i.e. std::string, std::vector, etc.) but do not want +# to include (a tag file for) the STL sources as input, then you should # set this tag to YES in order to let doxygen match functions declarations and # definitions whose arguments contain STL classes (e.g. func(std::string); v.s. # func(std::string) {}). This also make the inheritance and collaboration @@ -221,6 +238,15 @@ CPP_CLI_SUPPORT = NO SIP_SUPPORT = NO +# For Microsoft's IDL there are propget and propput attributes to indicate getter +# and setter methods for a property. Setting this option to YES (the default) +# will make doxygen to replace the get and set methods by a property in the +# documentation. This will only work if the methods are indeed getting or +# setting a simple type. If this is not the case, or you want to show the +# methods anyway, you should set this option to NO. + +IDL_PROPERTY_SUPPORT = YES + # If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC # tag is set to YES, then doxygen will reuse the documentation of the first # member in the group (if any) for the other members of the group. By default @@ -236,16 +262,32 @@ DISTRIBUTE_GROUP_DOC = NO SUBGROUPING = YES -# When TYPEDEF_HIDES_STRUCT is enabled, a typedef of a struct (or union) is -# documented as struct with the name of the typedef. So +# When TYPEDEF_HIDES_STRUCT is enabled, a typedef of a struct, union, or enum +# is documented as struct, union, or enum with the name of the typedef. So # typedef struct TypeS {} TypeT, will appear in the documentation as a struct # with name TypeT. When disabled the typedef will appear as a member of a file, # namespace, or class. And the struct will be named TypeS. This can typically -# be useful for C code where the coding convention is that all structs are -# typedef'ed and only the typedef is referenced never the struct's name. +# be useful for C code in case the coding convention dictates that all compound +# types are typedef'ed and only the typedef is referenced, never the tag name. TYPEDEF_HIDES_STRUCT = NO +# The SYMBOL_CACHE_SIZE determines the size of the internal cache use to +# determine which symbols to keep in memory and which to flush to disk. +# When the cache is full, less often used symbols will be written to disk. +# For small to medium size projects (<1000 input files) the default value is +# probably good enough. For larger projects a too small cache size can cause +# doxygen to be busy swapping symbols to and from disk most of the time +# causing a significant performance penality. +# If the system has enough physical memory increasing the cache will improve the +# performance by keeping more symbols in memory. Note that the value works on +# a logarithmic scale so increasing the size by one will rougly double the +# memory usage. The cache size is given by this formula: +# 2^(16+SYMBOL_CACHE_SIZE). The valid range is 0..9, the default is 0, +# corresponding to a cache size of 2^16 = 65536 symbols + +SYMBOL_CACHE_SIZE = 0 + #--------------------------------------------------------------------------- # Build related configuration options #--------------------------------------------------------------------------- @@ -280,10 +322,11 @@ EXTRACT_LOCAL_CLASSES = YES EXTRACT_LOCAL_METHODS = NO -# If this flag is set to YES, the members of anonymous namespaces will be extracted -# and appear in the documentation as a namespace called 'anonymous_namespace{file}', -# where file will be replaced with the base name of the file that contains the anonymous -# namespace. By default anonymous namespace are hidden. +# If this flag is set to YES, the members of anonymous namespaces will be +# extracted and appear in the documentation as a namespace called +# 'anonymous_namespace{file}', where file will be replaced with the base +# name of the file that contains the anonymous namespace. By default +# anonymous namespace are hidden. EXTRACT_ANON_NSPACES = NO @@ -362,6 +405,12 @@ SORT_MEMBER_DOCS = YES SORT_BRIEF_DOCS = NO +# If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the +# hierarchy of group names into alphabetical order. If set to NO (the default) +# the group names will appear in their defined order. + +SORT_GROUP_NAMES = NO + # If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be # sorted by fully-qualified names, including namespaces. If set to # NO (the default), the class list will be sorted only by class name, @@ -423,9 +472,22 @@ SHOW_USED_FILES = NO SHOW_DIRECTORIES = NO +# Set the SHOW_FILES tag to NO to disable the generation of the Files page. +# This will remove the Files entry from the Quick Index and from the +# Folder Tree View (if specified). The default is YES. + +SHOW_FILES = YES + +# Set the SHOW_NAMESPACES tag to NO to disable the generation of the +# Namespaces page. +# This will remove the Namespaces entry from the Quick Index +# and from the Folder Tree View (if specified). The default is YES. + +SHOW_NAMESPACES = YES + # The FILE_VERSION_FILTER tag can be used to specify a program or script that -# doxygen should invoke to get the current version for each file (typically from the -# version control system). Doxygen will invoke the program by executing (via +# doxygen should invoke to get the current version for each file (typically from +# the version control system). Doxygen will invoke the program by executing (via # popen()) the command <command> <input-file>, where <command> is the value of # the FILE_VERSION_FILTER tag, and <input-file> is the name of an input file # provided by doxygen. Whatever the program writes to standard output @@ -433,6 +495,15 @@ SHOW_DIRECTORIES = NO FILE_VERSION_FILTER = +# The LAYOUT_FILE tag can be used to specify a layout file which will be parsed by +# doxygen. The layout file controls the global structure of the generated output files +# in an output format independent way. The create the layout file that represents +# doxygen's defaults, run doxygen with the -l option. You can optionally specify a +# file name after the option, if omitted DoxygenLayout.xml will be used as the name +# of the layout file. + +LAYOUT_FILE = + #--------------------------------------------------------------------------- # configuration options related to warning and progress messages #--------------------------------------------------------------------------- @@ -493,12 +564,14 @@ WARN_LOGFILE = # directories like "/usr/src/myproject". Separate the files or directories # with spaces. -INPUT = @top_srcdir@/include @top_srcdir@/src +INPUT = @abs_top_srcdir@/include \ + @abs_top_srcdir@/src -# This tag can be used to specify the character encoding of the source files that -# doxygen parses. Internally doxygen uses the UTF-8 encoding, which is also the default -# input encoding. Doxygen uses libiconv (or the iconv built into libc) for the transcoding. -# See http://www.gnu.org/software/libiconv for the list of possible encodings. +# This tag can be used to specify the character encoding of the source files +# that doxygen parses. Internally doxygen uses the UTF-8 encoding, which is +# also the default input encoding. Doxygen uses libiconv (or the iconv built +# into libc) for the transcoding. See http://www.gnu.org/software/libiconv for +# the list of possible encodings. INPUT_ENCODING = UTF-8 @@ -509,7 +582,10 @@ INPUT_ENCODING = UTF-8 # *.c *.cc *.cxx *.cpp *.c++ *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh *.hxx # *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm *.py *.f90 -FILE_PATTERNS = *.cc *.hh *.hxx *.ice +FILE_PATTERNS = *.cc \ + *.hh \ + *.hxx \ + *.ice # The RECURSIVE tag can be used to turn specify whether or not subdirectories # should be searched for input files as well. Possible values are YES and NO. @@ -521,9 +597,9 @@ RECURSIVE = YES # excluded from the INPUT source files. This way you can easily exclude a # subdirectory from a directory tree whose root is specified with the INPUT tag. -EXCLUDE = @top_builddir@/packages \ - @top_builddir@/doc \ - @top_builddir@/@PACKAGE_TARNAME@-@PACKAGE_VERSION@ +EXCLUDE = @abs_top_builddir@/packages \ + @abs_top_builddir@/doc \ + @abs_top_builddir@/@PACKAGE_TARNAME@-@PACKAGE_VERSION@ # The EXCLUDE_SYMLINKS tag can be used select whether or not files or # directories that are symbolic links (a Unix filesystem feature) are excluded @@ -540,9 +616,10 @@ EXCLUDE_SYMLINKS = NO EXCLUDE_PATTERNS = # The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names -# (namespaces, classes, functions, etc.) that should be excluded from the output. -# The symbol name can be a fully qualified name, a word, or if the wildcard * is used, -# a substring. Examples: ANamespace, AClass, AClass::ANamespace, ANamespace::*Test +# (namespaces, classes, functions, etc.) that should be excluded from the +# output. The symbol name can be a fully qualified name, a word, or if the +# wildcard * is used, a substring. Examples: ANamespace, AClass, +# AClass::ANamespace, ANamespace::*Test EXCLUDE_SYMBOLS = roboptim::detail @@ -550,7 +627,7 @@ EXCLUDE_SYMBOLS = roboptim::detail # directories that contain example code fragments that are included (see # the \include command). -EXAMPLE_PATH = @top_srcdir@/tests +EXAMPLE_PATH = @abs_top_srcdir@/tests # If the value of the EXAMPLE_PATH tag contains directories, you can use the # EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp @@ -570,21 +647,24 @@ EXAMPLE_RECURSIVE = NO # directories that contain image that are included in the documentation (see # the \image command). -IMAGE_PATH = +IMAGE_PATH = @abs_top_srcdir@/doc # The INPUT_FILTER tag can be used to specify a program that doxygen should # invoke to filter for each input file. Doxygen will invoke the filter program # by executing (via popen()) the command <filter> <input-file>, where <filter> # is the value of the INPUT_FILTER tag, and <input-file> is the name of an # input file. Doxygen will then use the output that the filter program writes -# to standard output. If FILTER_PATTERNS is specified, this tag will be +# to standard output. +# If FILTER_PATTERNS is specified, this tag will be # ignored. INPUT_FILTER = # The FILTER_PATTERNS tag can be used to specify filters on a per file pattern -# basis. Doxygen will compare the file name with each pattern and apply the -# filter if there is a match. The filters are a list of the form: +# basis. +# Doxygen will compare the file name with each pattern and apply the +# filter if there is a match. +# The filters are a list of the form: # pattern=filter (like *.cpp=my_cpp_filter). See INPUT_FILTER for further # info on how filters are used. If FILTER_PATTERNS is empty, INPUT_FILTER # is applied to all files. @@ -604,9 +684,7 @@ FILTER_SOURCE_FILES = NO # If the SOURCE_BROWSER tag is set to YES then a list of source files will # be generated. Documented entities will be cross-referenced with these sources. # Note: To get rid of all source code in the generated output, make sure also -# VERBATIM_HEADERS is set to NO. If you have enabled CALL_GRAPH or CALLER_GRAPH -# then you must also enable this option. If you don't then doxygen will produce -# a warning and turn it on anyway +# VERBATIM_HEADERS is set to NO. SOURCE_BROWSER = NO @@ -621,13 +699,13 @@ INLINE_SOURCES = NO STRIP_CODE_COMMENTS = YES -# If the REFERENCED_BY_RELATION tag is set to YES (the default) +# If the REFERENCED_BY_RELATION tag is set to YES # then for each documented function all documented # functions referencing it will be listed. REFERENCED_BY_RELATION = YES -# If the REFERENCES_RELATION tag is set to YES (the default) +# If the REFERENCES_RELATION tag is set to YES # then for each documented function all documented entities # called/used by that function will be listed. @@ -636,7 +714,8 @@ REFERENCES_RELATION = YES # If the REFERENCES_LINK_SOURCE tag is set to YES (the default) # and SOURCE_BROWSER tag is set to YES, then the hyperlinks from # functions in REFERENCES_RELATION and REFERENCED_BY_RELATION lists will -# link to the source code. Otherwise they will link to the documentstion. +# link to the source code. +# Otherwise they will link to the documentation. REFERENCES_LINK_SOURCE = YES @@ -702,13 +781,13 @@ HTML_FILE_EXTENSION = .html # each generated HTML page. If it is left blank doxygen will generate a # standard header. -HTML_HEADER = @top_srcdir@/doc/header.html +HTML_HEADER = @abs_top_srcdir@/doc/header.html # The HTML_FOOTER tag can be used to specify a personal HTML footer for # each generated HTML page. If it is left blank doxygen will generate a # standard footer. -HTML_FOOTER = @top_srcdir@/doc/footer.html +HTML_FOOTER = @abs_top_srcdir@/doc/footer.html # The HTML_STYLESHEET tag can be used to specify a user-defined cascading # style sheet that is used by each HTML page. It can be used to @@ -717,7 +796,7 @@ HTML_FOOTER = @top_srcdir@/doc/footer.html # the style sheet file to the HTML output directory, so don't put your own # stylesheet in the HTML output directory as well, or it will be erased! -HTML_STYLESHEET = @top_srcdir@/doc/package.css +HTML_STYLESHEET = @abs_top_srcdir@/doc/package.css # If the HTML_ALIGN_MEMBERS tag is set to YES, the members of classes, # files or namespaces will be aligned in HTML using tables. If set to @@ -725,13 +804,6 @@ HTML_STYLESHEET = @top_srcdir@/doc/package.css HTML_ALIGN_MEMBERS = YES -# If the GENERATE_HTMLHELP tag is set to YES, additional index files -# will be generated that can be used as input for tools like the -# Microsoft HTML help workshop to generate a compressed HTML help file (.chm) -# of the generated HTML documentation. - -GENERATE_HTMLHELP = NO - # If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML # documentation will contain sections that can be hidden and shown after the # page has loaded. For this to work a browser that supports @@ -740,6 +812,39 @@ GENERATE_HTMLHELP = NO HTML_DYNAMIC_SECTIONS = YES +# If the GENERATE_DOCSET tag is set to YES, additional index files +# will be generated that can be used as input for Apple's Xcode 3 +# integrated development environment, introduced with OSX 10.5 (Leopard). +# To create a documentation set, doxygen will generate a Makefile in the +# HTML output directory. Running make will produce the docset in that +# directory and running "make install" will install the docset in +# ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find +# it at startup. +# See http://developer.apple.com/tools/creatingdocsetswithdoxygen.html for more information. + +GENERATE_DOCSET = NO + +# When GENERATE_DOCSET tag is set to YES, this tag determines the name of the +# feed. A documentation feed provides an umbrella under which multiple +# documentation sets from a single provider (such as a company or product suite) +# can be grouped. + +DOCSET_FEEDNAME = "Doxygen generated docs" + +# When GENERATE_DOCSET tag is set to YES, this tag specifies a string that +# should uniquely identify the documentation set bundle. This should be a +# reverse domain-name style string, e.g. com.mycompany.MyDocSet. Doxygen +# will append .docset to the name. + +DOCSET_BUNDLE_ID = org.doxygen.Project + +# If the GENERATE_HTMLHELP tag is set to YES, additional index files +# will be generated that can be used as input for tools like the +# Microsoft HTML help workshop to generate a compiled HTML help file (.chm) +# of the generated HTML documentation. + +GENERATE_HTMLHELP = NO + # If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can # be used to specify the file name of the resulting .chm file. You # can add a path in front of the file if the result should not be @@ -760,6 +865,12 @@ HHC_LOCATION = GENERATE_CHI = NO +# If the GENERATE_HTMLHELP tag is set to YES, the CHM_INDEX_ENCODING +# is used to encode HtmlHelp index (hhk), content (hhc) and project file +# content. + +CHM_INDEX_ENCODING = + # If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag # controls whether a binary table of contents is generated (YES) or a # normal table of contents (NO) in the .chm file. @@ -771,6 +882,55 @@ BINARY_TOC = NO TOC_EXPAND = NO +# If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and QHP_VIRTUAL_FOLDER +# are set, an additional index file will be generated that can be used as input for +# Qt's qhelpgenerator to generate a Qt Compressed Help (.qch) of the generated +# HTML documentation. + +GENERATE_QHP = NO + +# If the QHG_LOCATION tag is specified, the QCH_FILE tag can +# be used to specify the file name of the resulting .qch file. +# The path specified is relative to the HTML output folder. + +QCH_FILE = + +# The QHP_NAMESPACE tag specifies the namespace to use when generating +# Qt Help Project output. For more information please see +# http://doc.trolltech.com/qthelpproject.html#namespace + +QHP_NAMESPACE = + +# The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating +# Qt Help Project output. For more information please see +# http://doc.trolltech.com/qthelpproject.html#virtual-folders + +QHP_VIRTUAL_FOLDER = doc + +# If QHP_CUST_FILTER_NAME is set, it specifies the name of a custom filter to add. +# For more information please see +# http://doc.trolltech.com/qthelpproject.html#custom-filters + +QHP_CUST_FILTER_NAME = + +# The QHP_CUST_FILT_ATTRS tag specifies the list of the attributes of the custom filter to add.For more information please see +# <a href="http://doc.trolltech.com/qthelpproject.html#custom-filters">Qt Help Project / Custom Filters</a>. + +QHP_CUST_FILTER_ATTRS = + +# The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this project's +# filter section matches. +# <a href="http://doc.trolltech.com/qthelpproject.html#filter-attributes">Qt Help Project / Filter Attributes</a>. + +QHP_SECT_FILTER_ATTRS = + +# If the GENERATE_QHP tag is set to YES, the QHG_LOCATION tag can +# be used to specify the location of Qt's qhelpgenerator. +# If non-empty doxygen will try to run qhelpgenerator on the generated +# .qhp file. + +QHG_LOCATION = + # The DISABLE_INDEX tag can be used to turn on/off the condensed index at # top of each HTML page. The value NO (the default) enables the index and # the value YES disables it. @@ -782,12 +942,20 @@ DISABLE_INDEX = NO ENUM_VALUES_PER_LINE = 4 -# If the GENERATE_TREEVIEW tag is set to YES, a side panel will be -# generated containing a tree-like index structure (just like the one that +# The GENERATE_TREEVIEW tag is used to specify whether a tree-like index +# structure should be generated to display hierarchical information. +# If the tag value is set to FRAME, a side panel will be generated +# containing a tree-like index structure (just like the one that # is generated for HTML Help). For this to work a browser that supports # JavaScript, DHTML, CSS and frames is required (for instance Mozilla 1.0+, # Netscape 6.0+, Internet explorer 5.0+, or Konqueror). Windows users are -# probably better off using the HTML help feature. +# probably better off using the HTML help feature. Other possible values +# for this tag are: HIERARCHIES, which will generate the Groups, Directories, +# and Class Hierarchy pages using a tree view instead of an ordered list; +# ALL, which combines the behavior of FRAME and HIERARCHIES; and NONE, which +# disables this behavior completely. For backwards compatibility with previous +# releases of Doxygen, the values YES and NO are equivalent to FRAME and NONE +# respectively. GENERATE_TREEVIEW = YES @@ -797,6 +965,14 @@ GENERATE_TREEVIEW = YES TREEVIEW_WIDTH = 250 +# Use this tag to change the font size of Latex formulas included +# as images in the HTML documentation. The default is 10. Note that +# when you change the font size after a successful doxygen run you need +# to manually remove any form_*.png images from the HTML output directory +# to force them to be regenerated. + +FORMULA_FONTSIZE = 10 + #--------------------------------------------------------------------------- # configuration options related to the LaTeX output #--------------------------------------------------------------------------- @@ -1009,8 +1185,10 @@ GENERATE_PERLMOD = NO PERLMOD_LATEX = NO # If the PERLMOD_PRETTY tag is set to YES the Perl module output will be -# nicely formatted so it can be parsed by a human reader. This is useful -# if you want to understand what is going on. On the other hand, if this +# nicely formatted so it can be parsed by a human reader. +# This is useful +# if you want to understand what is going on. +# On the other hand, if this # tag is set to NO the size of the Perl module output will be much smaller # and Perl will parse it just the same. @@ -1097,9 +1275,11 @@ SKIP_FUNCTION_MACROS = YES # Optionally an initial location of the external documentation # can be added for each tagfile. The format of a tag file without # this location is as follows: -# TAGFILES = file1 file2 ... +# +# TAGFILES = file1 file2 ... # Adding location for the tag files is done as follows: -# TAGFILES = file1=loc1 "file2 = loc2" ... +# +# TAGFILES = file1=loc1 "file2 = loc2" ... # where "loc1" and "loc2" can be relative or absolute paths or # URLs. If a location is present for each tag, the installdox tool # does not have to be run to correct the links. @@ -1130,7 +1310,7 @@ EXTERNAL_GROUPS = YES # The PERL_PATH should be the absolute path and name of the perl script # interpreter (i.e. the result of `which perl'). -PERL_PATH = /usr/bin/perl +PERL_PATH = @PERL@ #--------------------------------------------------------------------------- # Configuration options related to the dot tool @@ -1146,10 +1326,11 @@ PERL_PATH = /usr/bin/perl CLASS_DIAGRAMS = YES # You can define message sequence charts within doxygen comments using the \msc -# command. Doxygen will then run the mscgen tool (see http://www.mcternan.me.uk/mscgen/) to -# produce the chart and insert it in the documentation. The MSCGEN_PATH tag allows you to -# specify the directory where the mscgen tool resides. If left empty the tool is assumed to -# be found in the default search path. +# command. Doxygen will then run the mscgen tool (see +# http://www.mcternan.me.uk/mscgen/) to produce the chart and insert it in the +# documentation. The MSCGEN_PATH tag allows you to specify the directory where +# the mscgen tool resides. If left empty the tool is assumed to be found in the +# default search path. MSCGEN_PATH = @@ -1164,7 +1345,30 @@ HIDE_UNDOC_RELATIONS = YES # toolkit from AT&T and Lucent Bell Labs. The other options in this section # have no effect if this option is set to NO (the default) -HAVE_DOT = YES +HAVE_DOT = @HAVE_DOT@ + +# By default doxygen will write a font called FreeSans.ttf to the output +# directory and reference it in all dot files that doxygen generates. This +# font does not include all possible unicode characters however, so when you need +# these (or just want a differently looking font) you can specify the font name +# using DOT_FONTNAME. You need need to make sure dot is able to find the font, +# which can be done by putting it in a standard location or by setting the +# DOTFONTPATH environment variable or by setting DOT_FONTPATH to the directory +# containing the font. + +DOT_FONTNAME = FreeSans + +# The DOT_FONTSIZE tag can be used to set the size of the font of dot graphs. +# The default size is 10pt. + +DOT_FONTSIZE = 10 + +# By default doxygen will tell dot to use the output directory to look for the +# FreeSans.ttf font (which doxygen will put there itself). If you specify a +# different font using DOT_FONTNAME you can set the path where dot +# can find it using this tag. + +DOT_FONTPATH = # If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen # will generate a graph for each documented class showing the direct and @@ -1210,19 +1414,19 @@ INCLUDE_GRAPH = YES INCLUDED_BY_GRAPH = YES -# If the CALL_GRAPH, SOURCE_BROWSER and HAVE_DOT tags are set to YES then doxygen will -# generate a call dependency graph for every global function or class method. -# Note that enabling this option will significantly increase the time of a run. -# So in most cases it will be better to enable call graphs for selected -# functions only using the \callgraph command. +# If the CALL_GRAPH and HAVE_DOT options are set to YES then +# doxygen will generate a call dependency graph for every global function +# or class method. Note that enabling this option will significantly increase +# the time of a run. So in most cases it will be better to enable call graphs +# for selected functions only using the \callgraph command. CALL_GRAPH = NO -# If the CALLER_GRAPH, SOURCE_BROWSER and HAVE_DOT tags are set to YES then doxygen will -# generate a caller dependency graph for every global function or class method. -# Note that enabling this option will significantly increase the time of a run. -# So in most cases it will be better to enable caller graphs for selected -# functions only using the \callergraph command. +# If the CALLER_GRAPH and HAVE_DOT tags are set to YES then +# doxygen will generate a caller dependency graph for every global function +# or class method. Note that enabling this option will significantly increase +# the time of a run. So in most cases it will be better to enable caller +# graphs for selected functions only using the \callergraph command. CALLER_GRAPH = NO @@ -1255,12 +1459,12 @@ DOT_PATH = DOTFILE_DIRS = -# The MAX_DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of +# The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of # nodes that will be shown in the graph. If the number of nodes in a graph # becomes larger than this value, doxygen will truncate the graph, which is -# visualized by representing a node as a red box. Note that doxygen if the number -# of direct children of the root node in a graph is already larger than -# MAX_DOT_GRAPH_NOTES then the graph will not be shown at all. Also note +# visualized by representing a node as a red box. Note that doxygen if the +# number of direct children of the root node in a graph is already larger than +# DOT_GRAPH_MAX_NODES then the graph will not be shown at all. Also note # that the size of a graph can be further restricted by MAX_DOT_GRAPH_DEPTH. DOT_GRAPH_MAX_NODES = 50 @@ -1276,10 +1480,10 @@ DOT_GRAPH_MAX_NODES = 50 MAX_DOT_GRAPH_DEPTH = 0 # Set the DOT_TRANSPARENT tag to YES to generate images with a transparent -# background. This is disabled by default, which results in a white background. -# Warning: Depending on the platform used, enabling this option may lead to -# badly anti-aliased labels on the edges of a graph (i.e. they become hard to -# read). +# background. This is disabled by default, because dot on Windows does not +# seem to support this out of the box. Warning: Depending on the platform used, +# enabling this option may lead to badly anti-aliased labels on the edges of +# a graph (i.e. they become hard to read). DOT_TRANSPARENT = YES @@ -1303,7 +1507,7 @@ GENERATE_LEGEND = YES DOT_CLEANUP = YES #--------------------------------------------------------------------------- -# Configuration::additions related to the search engine +# Options related to the search engine #--------------------------------------------------------------------------- # The SEARCHENGINE tag specifies whether or not a search engine should be diff --git a/doc/Makefile.am b/doc/Makefile.am index c5139b7..8b8ae75 100644 --- a/doc/Makefile.am +++ b/doc/Makefile.am @@ -1,25 +1,54 @@ -.PHONY: doc html install-doxygen-html uninstall-doxygen-html +include $(top_srcdir)/build-aux/init.mk +# Variables. +EXTRA_DIST += \ + Doxyfile.in \ + header.html \ + footer.html \ + package.css \ + doxygen.css \ + tabs.css \ + sf-upload.sh.in + +CLEANFILES += $(PACKAGE_TARNAME).doxytag + + +.PHONY: doc \ + html \ + doxygen \ + install-doxygen-html \ + uninstall-doxygen-html + +# Rules. doc: html -html-local: Doxyfile - $(DOXYGEN) +html-local: doxygen -EXTRA_DIST = Doxyfile.in header.html footer.html \ - package.css doxygen.css tabs.css sf-upload.sh.in +doxygen: Doxyfile + $(DOXYGEN) "$<" -CLEANFILES = $(PACKAGE_TARNAME).doxytag +# Doxygen generation rule. +Doxyfile: $(srcdir)/Doxyfile.in + $(top_builddir)/config.status --file="$@":"$<" \ + && sed -i -e 's/^#.*//' -e '/^$$/d' "$@" +# Clean rule. clean-local: rm -rf html latex +# Install rules. install-data-local: install-doxygen-html uninstall-local: uninstall-doxygen-html install-doxygen-html: html-local - $(mkdir_p) "$(DESTDIR)$(htmldir)/html" - cp -rf html/* "$(DESTDIR)$(htmldir)/html" + $(mkdir_p) "$(DESTDIR)$(htmldir)" + cp -rf html "$(DESTDIR)$(htmldir)" $(INSTALL_DATA) $(PACKAGE_TARNAME).doxytag "$(DESTDIR)$(htmldir)/html" uninstall-doxygen-html: rm -rf "$(DESTDIR)$(htmldir)" + +# --- SourceForge upload script. +# sf-upload.sh generation rule. +sf-upload.sh: $(srcdir)/sf-upload.sh.in + $(top_builddir)/config.status --file="$@":"$<" && chmod u+x "$@" diff --git a/doc/sf-upload.sh.in b/doc/sf-upload.sh.in index eea3f07..3f11bc7 100644 --- a/doc/sf-upload.sh.in +++ b/doc/sf-upload.sh.in @@ -16,7 +16,7 @@ # # Then launch the script. It will prompt for your password # and upload the documentation in a @PACKAGE_TARNAME@ folder. - +set -e rsync=$(which rsync) @@ -31,9 +31,22 @@ if test "x$SF_USERNAME" = x; then exit 2 fi -echo "Uploading documentation to SourceForge server, please wait."; -$rsync -avP -e ssh @abs_builddir@/html/ \ - $SF_USERNAME,rob...@we...:htdocs/doc/core/HEAD/ +if test "x$VERSION" = x; then + echo "No version set, defaulting to ``HEAD''." + VERSION=HEAD +fi + +rsync_cmd="$rsync -avP -e ssh" +localdir="@abs_builddir@/html/" +remotedir="htdocs/doc/core/$VERSION" +rsync_loghost="$SF_USERNAME,rob...@we...:" + +echo "Fixing local rights."; +chmod 644 "$localdir/*" +echo "Uploading documentation to SourceForge server."; +$rsync_cmd "$localdir" "$rsync_loghost$remotedir" +#echo "Fixing documentation rights."; +#echo "cd \"$remotedir\"; chmod 644 *" | $rsync_cmd "$rsync_loghost$remotedir" ret="$?"; if test 0 -eq "$ret"; then echo "Done. Exiting"; ----------------------------------------------------------------------- Summary of changes: ChangeLog | 12 + roboptim-core.m4 => build-aux/doxygen.m4 | 52 ++-- build-aux/pkg-config.mk | 83 +++++ build-aux/pkg-config.pc.in | 11 +- roboptim-core.m4 => build-aux/roboptim-core.m4 | 0 configure.ac | 20 +- doc/Doxyfile.in | 398 ++++++++++++++++++------ doc/Makefile.am | 45 +++- doc/sf-upload.sh.in | 21 +- 9 files changed, 502 insertions(+), 140 deletions(-) copy roboptim-core.m4 => build-aux/doxygen.m4 (59%) create mode 100644 build-aux/pkg-config.mk copy roboptim-core.m4 => build-aux/roboptim-core.m4 (100%) hooks/post-receive -- roboptim |
From: Thomas M. <tho...@us...> - 2009-06-10 09:20:44
|
This is an automated email from the git hooks/post-receive script. It was generated because a ref change was pushed to the repository containing the project "roboptim". The branch, share has been updated via d6cbc53dbe2e353f7f064489559581863cb2c2f6 (commit) from d35e1a2ae0bee1ffd7ac650dbadf3ecb4a520468 (commit) Those revisions listed above that are new to this repository have not appeared on any other notification email; so we list those revisions in full, below. - Log ----------------------------------------------------------------- commit d6cbc53dbe2e353f7f064489559581863cb2c2f6 Author: Thomas Moulard <tho...@gm...> Date: Wed Jun 10 18:20:17 2009 +0900 Add roboptim-core.m4 file. * build-aux/roboptim-core.m4: New. Signed-off-by: Thomas Moulard <tho...@gm...> diff --git a/ChangeLog b/ChangeLog index 59836b1..a3acb2f 100644 --- a/ChangeLog +++ b/ChangeLog @@ -1,5 +1,10 @@ 2009-06-10 Thomas Moulard <tho...@gm...> + Add roboptim-core.m4 file. + * build-aux/roboptim-core.m4: New. + +2009-06-10 Thomas Moulard <tho...@gm...> + Add missing mkdir -p. * doc/Makefile.am: Here. diff --git a/build-aux/roboptim-core.m4 b/build-aux/roboptim-core.m4 new file mode 100644 index 0000000..b21cdc1 --- /dev/null +++ b/build-aux/roboptim-core.m4 @@ -0,0 +1,53 @@ +# -*-Autoconf-*- +# Copyright (C) 2009 by Thomas Moulard, FIXME. +# This file is part of the roboptim. +# +# roboptim is free software: you can redistribute it and/or modify +# it under the terms of the GNU General Public License as published by +# the Free Software Foundation, either version 3 of the License, or +# (at your option) any later version. +# +# Additional permission under section 7 of the GNU General Public +# License, version 3 ("GPLv3"): +# +# If you convey this file as part of a work that contains a +# configuration script generated by Autoconf, you may do so under +# terms of your choice. +# +# roboptim is distributed in the hope that it will be useful, +# but WITHOUT ANY WARRANTY; without even the implied warranty of +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +# GNU General Public License for more details. +# +# You should have received a copy of the GNU General Public License +# along with roboptim. If not, see <http://www.gnu.org/licenses/>. + +# serial 2 + +# ------ # +# README # +# ------ # + +# This m4 file can be used to check for the roboptim library. +# You can copy it into your software's aux dir and call the following +# macro to check for the library. +# +# ROBOPTIM_CORE_PKG_CONFIG: add a hard dependency against roboptim-core +# using pkg-config. + +m4_pattern_forbid([^ROBOPTIM_CORE]) + +# ROBOPTIM_CORE_PKG_CONFIG([REQUIRED_VERSION]) +# -------------------------------------------- +# Search for roboptim-core using pkg-config. +# REQUIRED_VERSION represent how to check the version. +# Example: ``roboptim-core >= 0.1'' +AC_DEFUN([ROBOPTIM_CORE_PKG_CONFIG], +[ +PKG_CHECK_MODULES([ROBOPTIMCORE], m4_default($1, roboptim-core)) + +ROBOPTIMCORE_DOCDIR=`$PKG_CONFIG roboptim-core --variable=docdir` +AC_SUBST([ROBOPTIMCORE_DOCDIR]) +AC_SUBST([ROBOPTIMCORE_CFLAGS]) +AC_SUBST([ROBOPTIMCORE_LIBS]) +]) # ROBOPTIM_CORE_PKG_CONFIG ----------------------------------------------------------------------- Summary of changes: ChangeLog | 5 +++ build-aux/{doxygen.m4 => roboptim-core.m4} | 52 +++++++++++---------------- 2 files changed, 26 insertions(+), 31 deletions(-) copy build-aux/{doxygen.m4 => roboptim-core.m4} (59%) hooks/post-receive -- roboptim |
From: Thomas M. <tho...@us...> - 2009-06-10 09:12:40
|
This is an automated email from the git hooks/post-receive script. It was generated because a ref change was pushed to the repository containing the project "roboptim". The branch, share has been updated via d35e1a2ae0bee1ffd7ac650dbadf3ecb4a520468 (commit) from 502477a0797dbc66ea59839cc5c7fc1e8416953d (commit) Those revisions listed above that are new to this repository have not appeared on any other notification email; so we list those revisions in full, below. - Log ----------------------------------------------------------------- commit d35e1a2ae0bee1ffd7ac650dbadf3ecb4a520468 Author: Thomas Moulard <tho...@gm...> Date: Wed Jun 10 18:12:02 2009 +0900 Add missing mkdir -p. * doc/Makefile.am: Here. Signed-off-by: Thomas Moulard <tho...@gm...> diff --git a/ChangeLog b/ChangeLog index 3601430..59836b1 100644 --- a/ChangeLog +++ b/ChangeLog @@ -1,5 +1,10 @@ 2009-06-10 Thomas Moulard <tho...@gm...> + Add missing mkdir -p. + * doc/Makefile.am: Here. + +2009-06-10 Thomas Moulard <tho...@gm...> + Add new Doxygen rules. * build-aux/doxygen.m4: New. * doc/Doxyfile.in: Update. diff --git a/doc/Makefile.am b/doc/Makefile.am index d8beceb..8b8ae75 100644 --- a/doc/Makefile.am +++ b/doc/Makefile.am @@ -41,6 +41,7 @@ install-data-local: install-doxygen-html uninstall-local: uninstall-doxygen-html install-doxygen-html: html-local + $(mkdir_p) "$(DESTDIR)$(htmldir)" cp -rf html "$(DESTDIR)$(htmldir)" $(INSTALL_DATA) $(PACKAGE_TARNAME).doxytag "$(DESTDIR)$(htmldir)/html" ----------------------------------------------------------------------- Summary of changes: ChangeLog | 5 +++++ doc/Makefile.am | 1 + 2 files changed, 6 insertions(+), 0 deletions(-) hooks/post-receive -- roboptim |
From: Thomas M. <tho...@us...> - 2009-06-10 08:51:40
|
This is an automated email from the git hooks/post-receive script. It was generated because a ref change was pushed to the repository containing the project "roboptim". The branch, share has been updated via 502477a0797dbc66ea59839cc5c7fc1e8416953d (commit) via b5a36f0c7bba89d62970f7775f9a7c4fa824ac44 (commit) from 5402b1ee761314175319ea9580cd3fc33b2ecba9 (commit) Those revisions listed above that are new to this repository have not appeared on any other notification email; so we list those revisions in full, below. - Log ----------------------------------------------------------------- commit 502477a0797dbc66ea59839cc5c7fc1e8416953d Author: Thomas Moulard <tho...@gm...> Date: Wed Jun 10 17:51:11 2009 +0900 Add new Doxygen rules. * build-aux/doxygen.m4: New. * doc/Doxyfile.in: Update. * doc/Makefile.am: Make rules more robust. * doc/Makefile.in: New. * doc/sf-upload.sh.in: Fix permissions problems. Signed-off-by: Thomas Moulard <tho...@gm...> diff --git a/ChangeLog b/ChangeLog index 7725d6b..3601430 100644 --- a/ChangeLog +++ b/ChangeLog @@ -1,5 +1,14 @@ 2009-06-10 Thomas Moulard <tho...@gm...> + Add new Doxygen rules. + * build-aux/doxygen.m4: New. + * doc/Doxyfile.in: Update. + * doc/Makefile.am: Make rules more robust. + * doc/Makefile.in: New. + * doc/sf-upload.sh.in: Fix permissions problems. + +2009-06-10 Thomas Moulard <tho...@gm...> + Add pkg-config rules. * build-aux/pkg-config.mk: New. * build-aux/pkg-config.pc.in: Use Autoconf new diff --git a/build-aux/doxygen.m4 b/build-aux/doxygen.m4 new file mode 100644 index 0000000..eefbf3f --- /dev/null +++ b/build-aux/doxygen.m4 @@ -0,0 +1,63 @@ +# -*-Autoconf-*- +# Copyright (C) 2009 by Thomas Moulard, FIXME. +# This file is part of the roboptim. +# +# roboptim is free software: you can redistribute it and/or modify +# it under the terms of the GNU General Public License as published by +# the Free Software Foundation, either version 3 of the License, or +# (at your option) any later version. +# +# Additional permission under section 7 of the GNU General Public +# License, version 3 ("GPLv3"): +# +# If you convey this file as part of a work that contains a +# configuration script generated by Autoconf, you may do so under +# terms of your choice. +# +# roboptim is distributed in the hope that it will be useful, +# but WITHOUT ANY WARRANTY; without even the implied warranty of +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +# GNU General Public License for more details. +# +# You should have received a copy of the GNU General Public License +# along with roboptim. If not, see <http://www.gnu.org/licenses/>. + +# serial 1 + +# ------ # +# README # +# ------ # + +# This m4 file can be used to search for Doxygen and its dependencies. + +m4_pattern_forbid([^JRL]) + +# JRL_PROG_DOXYGEN([REQUIRED_VERSION]) +# -------------------------------------------- +# Search for Doxygen and related tools (perl and dot). +AC_DEFUN([JRL_PROG_DOXYGEN], +[# Search for Doxygen and its related tools. +# Search for Doxygen. +AC_ARG_VAR([DOXYGEN], [the Doxygen documentation generation program]) +AC_CHECK_PROGS([DOXYGEN], [doxygen]) + + +# Search for Perl. +AC_ARG_VAR([PERL], [the perl interpreter]) +AC_CHECK_PROGS([PERL], [perl]) + +if test x"$PERL" = x; then + AC_MSG_FAILURE([Perl not found.]) +fi + + +# Search for Dot. +AC_ARG_VAR([DOT], [the dot graphic tool]) +AC_CHECK_PROGS([DOT], [dot]) + +if test x"$DOT" = x; then + AC_SUBST([HAVE_DOT], [NO]) +else + AC_SUBST([HAVE_DOT], [YES]) +fi +]) # JRL_PROG_DOXYGEN diff --git a/doc/Doxyfile.in b/doc/Doxyfile.in index f764f10..fd90e82 100644 --- a/doc/Doxyfile.in +++ b/doc/Doxyfile.in @@ -1,4 +1,4 @@ -# Doxyfile 1.5.4 +# Doxyfile 1.5.8 # This file describes the settings to be used by the documentation system # doxygen (www.doxygen.org) for a project @@ -14,11 +14,11 @@ # Project related configuration options #--------------------------------------------------------------------------- -# This tag specifies the encoding used for all characters in the config file that -# follow. The default is UTF-8 which is also the encoding used for all text before -# the first occurrence of this tag. Doxygen uses libiconv (or the iconv built into -# libc) for the transcoding. See http://www.gnu.org/software/libiconv for the list of -# possible encodings. +# This tag specifies the encoding used for all characters in the config file +# that follow. The default is UTF-8 which is also the encoding used for all +# text before the first occurrence of this tag. Doxygen uses libiconv (or the +# iconv built into libc) for the transcoding. See +# http://www.gnu.org/software/libiconv for the list of possible encodings. DOXYFILE_ENCODING = UTF-8 @@ -54,10 +54,11 @@ CREATE_SUBDIRS = NO # information to generate all constant output in the proper language. # The default language is English, other supported languages are: # Afrikaans, Arabic, Brazilian, Catalan, Chinese, Chinese-Traditional, -# Croatian, Czech, Danish, Dutch, Finnish, French, German, Greek, Hungarian, -# Italian, Japanese, Japanese-en (Japanese with English messages), Korean, -# Korean-en, Lithuanian, Norwegian, Polish, Portuguese, Romanian, Russian, -# Serbian, Slovak, Slovene, Spanish, Swedish, and Ukrainian. +# Croatian, Czech, Danish, Dutch, Farsi, Finnish, French, German, Greek, +# Hungarian, Italian, Japanese, Japanese-en (Japanese with English messages), +# Korean, Korean-en, Lithuanian, Norwegian, Macedonian, Persian, Polish, +# Portuguese, Romanian, Russian, Serbian, Serbian-Cyrilic, Slovak, Slovene, +# Spanish, Swedish, and Ukrainian. OUTPUT_LANGUAGE = English @@ -154,13 +155,6 @@ QT_AUTOBRIEF = NO MULTILINE_CPP_IS_BRIEF = NO -# If the DETAILS_AT_TOP tag is set to YES then Doxygen -# will output the detailed description near the top, like JavaDoc. -# If set to NO, the detailed description appears after the member -# documentation. - -DETAILS_AT_TOP = NO - # If the INHERIT_DOCS tag is set to YES (the default) then an undocumented # member inherits the documentation from any documented member that it # re-implements. @@ -195,14 +189,37 @@ ALIASES = OPTIMIZE_OUTPUT_FOR_C = NO # Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java -# sources only. Doxygen will then generate output that is more tailored for Java. -# For instance, namespaces will be presented as packages, qualified scopes -# will look different, etc. +# sources only. Doxygen will then generate output that is more tailored for +# Java. For instance, namespaces will be presented as packages, qualified +# scopes will look different, etc. OPTIMIZE_OUTPUT_JAVA = NO -# If you use STL classes (i.e. std::string, std::vector, etc.) but do not want to -# include (a tag file for) the STL sources as input, then you should +# Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran +# sources only. Doxygen will then generate output that is more tailored for +# Fortran. + +OPTIMIZE_FOR_FORTRAN = NO + +# Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL +# sources. Doxygen will then generate output that is tailored for +# VHDL. + +OPTIMIZE_OUTPUT_VHDL = NO + +# Doxygen selects the parser to use depending on the extension of the files it parses. +# With this tag you can assign which parser to use for a given extension. +# Doxygen has a built-in mapping, but you can override or extend it using this tag. +# The format is ext=language, where ext is a file extension, and language is one of +# the parsers supported by doxygen: IDL, Java, Javascript, C#, C, C++, D, PHP, +# Objective-C, Python, Fortran, VHDL, C, C++. For instance to make doxygen treat +# .inc files as Fortran files (default is PHP), and .f files as C (default is Fortran), +# use: inc=Fortran f=C + +EXTENSION_MAPPING = + +# If you use STL classes (i.e. std::string, std::vector, etc.) but do not want +# to include (a tag file for) the STL sources as input, then you should # set this tag to YES in order to let doxygen match functions declarations and # definitions whose arguments contain STL classes (e.g. func(std::string); v.s. # func(std::string) {}). This also make the inheritance and collaboration @@ -221,6 +238,15 @@ CPP_CLI_SUPPORT = NO SIP_SUPPORT = NO +# For Microsoft's IDL there are propget and propput attributes to indicate getter +# and setter methods for a property. Setting this option to YES (the default) +# will make doxygen to replace the get and set methods by a property in the +# documentation. This will only work if the methods are indeed getting or +# setting a simple type. If this is not the case, or you want to show the +# methods anyway, you should set this option to NO. + +IDL_PROPERTY_SUPPORT = YES + # If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC # tag is set to YES, then doxygen will reuse the documentation of the first # member in the group (if any) for the other members of the group. By default @@ -236,16 +262,32 @@ DISTRIBUTE_GROUP_DOC = NO SUBGROUPING = YES -# When TYPEDEF_HIDES_STRUCT is enabled, a typedef of a struct (or union) is -# documented as struct with the name of the typedef. So +# When TYPEDEF_HIDES_STRUCT is enabled, a typedef of a struct, union, or enum +# is documented as struct, union, or enum with the name of the typedef. So # typedef struct TypeS {} TypeT, will appear in the documentation as a struct # with name TypeT. When disabled the typedef will appear as a member of a file, # namespace, or class. And the struct will be named TypeS. This can typically -# be useful for C code where the coding convention is that all structs are -# typedef'ed and only the typedef is referenced never the struct's name. +# be useful for C code in case the coding convention dictates that all compound +# types are typedef'ed and only the typedef is referenced, never the tag name. TYPEDEF_HIDES_STRUCT = NO +# The SYMBOL_CACHE_SIZE determines the size of the internal cache use to +# determine which symbols to keep in memory and which to flush to disk. +# When the cache is full, less often used symbols will be written to disk. +# For small to medium size projects (<1000 input files) the default value is +# probably good enough. For larger projects a too small cache size can cause +# doxygen to be busy swapping symbols to and from disk most of the time +# causing a significant performance penality. +# If the system has enough physical memory increasing the cache will improve the +# performance by keeping more symbols in memory. Note that the value works on +# a logarithmic scale so increasing the size by one will rougly double the +# memory usage. The cache size is given by this formula: +# 2^(16+SYMBOL_CACHE_SIZE). The valid range is 0..9, the default is 0, +# corresponding to a cache size of 2^16 = 65536 symbols + +SYMBOL_CACHE_SIZE = 0 + #--------------------------------------------------------------------------- # Build related configuration options #--------------------------------------------------------------------------- @@ -280,10 +322,11 @@ EXTRACT_LOCAL_CLASSES = YES EXTRACT_LOCAL_METHODS = NO -# If this flag is set to YES, the members of anonymous namespaces will be extracted -# and appear in the documentation as a namespace called 'anonymous_namespace{file}', -# where file will be replaced with the base name of the file that contains the anonymous -# namespace. By default anonymous namespace are hidden. +# If this flag is set to YES, the members of anonymous namespaces will be +# extracted and appear in the documentation as a namespace called +# 'anonymous_namespace{file}', where file will be replaced with the base +# name of the file that contains the anonymous namespace. By default +# anonymous namespace are hidden. EXTRACT_ANON_NSPACES = NO @@ -362,6 +405,12 @@ SORT_MEMBER_DOCS = YES SORT_BRIEF_DOCS = NO +# If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the +# hierarchy of group names into alphabetical order. If set to NO (the default) +# the group names will appear in their defined order. + +SORT_GROUP_NAMES = NO + # If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be # sorted by fully-qualified names, including namespaces. If set to # NO (the default), the class list will be sorted only by class name, @@ -423,9 +472,22 @@ SHOW_USED_FILES = NO SHOW_DIRECTORIES = NO +# Set the SHOW_FILES tag to NO to disable the generation of the Files page. +# This will remove the Files entry from the Quick Index and from the +# Folder Tree View (if specified). The default is YES. + +SHOW_FILES = YES + +# Set the SHOW_NAMESPACES tag to NO to disable the generation of the +# Namespaces page. +# This will remove the Namespaces entry from the Quick Index +# and from the Folder Tree View (if specified). The default is YES. + +SHOW_NAMESPACES = YES + # The FILE_VERSION_FILTER tag can be used to specify a program or script that -# doxygen should invoke to get the current version for each file (typically from the -# version control system). Doxygen will invoke the program by executing (via +# doxygen should invoke to get the current version for each file (typically from +# the version control system). Doxygen will invoke the program by executing (via # popen()) the command <command> <input-file>, where <command> is the value of # the FILE_VERSION_FILTER tag, and <input-file> is the name of an input file # provided by doxygen. Whatever the program writes to standard output @@ -433,6 +495,15 @@ SHOW_DIRECTORIES = NO FILE_VERSION_FILTER = +# The LAYOUT_FILE tag can be used to specify a layout file which will be parsed by +# doxygen. The layout file controls the global structure of the generated output files +# in an output format independent way. The create the layout file that represents +# doxygen's defaults, run doxygen with the -l option. You can optionally specify a +# file name after the option, if omitted DoxygenLayout.xml will be used as the name +# of the layout file. + +LAYOUT_FILE = + #--------------------------------------------------------------------------- # configuration options related to warning and progress messages #--------------------------------------------------------------------------- @@ -493,12 +564,14 @@ WARN_LOGFILE = # directories like "/usr/src/myproject". Separate the files or directories # with spaces. -INPUT = @top_srcdir@/include @top_srcdir@/src +INPUT = @abs_top_srcdir@/include \ + @abs_top_srcdir@/src -# This tag can be used to specify the character encoding of the source files that -# doxygen parses. Internally doxygen uses the UTF-8 encoding, which is also the default -# input encoding. Doxygen uses libiconv (or the iconv built into libc) for the transcoding. -# See http://www.gnu.org/software/libiconv for the list of possible encodings. +# This tag can be used to specify the character encoding of the source files +# that doxygen parses. Internally doxygen uses the UTF-8 encoding, which is +# also the default input encoding. Doxygen uses libiconv (or the iconv built +# into libc) for the transcoding. See http://www.gnu.org/software/libiconv for +# the list of possible encodings. INPUT_ENCODING = UTF-8 @@ -509,7 +582,10 @@ INPUT_ENCODING = UTF-8 # *.c *.cc *.cxx *.cpp *.c++ *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh *.hxx # *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm *.py *.f90 -FILE_PATTERNS = *.cc *.hh *.hxx *.ice +FILE_PATTERNS = *.cc \ + *.hh \ + *.hxx \ + *.ice # The RECURSIVE tag can be used to turn specify whether or not subdirectories # should be searched for input files as well. Possible values are YES and NO. @@ -521,9 +597,9 @@ RECURSIVE = YES # excluded from the INPUT source files. This way you can easily exclude a # subdirectory from a directory tree whose root is specified with the INPUT tag. -EXCLUDE = @top_builddir@/packages \ - @top_builddir@/doc \ - @top_builddir@/@PACKAGE_TARNAME@-@PACKAGE_VERSION@ +EXCLUDE = @abs_top_builddir@/packages \ + @abs_top_builddir@/doc \ + @abs_top_builddir@/@PACKAGE_TARNAME@-@PACKAGE_VERSION@ # The EXCLUDE_SYMLINKS tag can be used select whether or not files or # directories that are symbolic links (a Unix filesystem feature) are excluded @@ -540,9 +616,10 @@ EXCLUDE_SYMLINKS = NO EXCLUDE_PATTERNS = # The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names -# (namespaces, classes, functions, etc.) that should be excluded from the output. -# The symbol name can be a fully qualified name, a word, or if the wildcard * is used, -# a substring. Examples: ANamespace, AClass, AClass::ANamespace, ANamespace::*Test +# (namespaces, classes, functions, etc.) that should be excluded from the +# output. The symbol name can be a fully qualified name, a word, or if the +# wildcard * is used, a substring. Examples: ANamespace, AClass, +# AClass::ANamespace, ANamespace::*Test EXCLUDE_SYMBOLS = roboptim::detail @@ -550,7 +627,7 @@ EXCLUDE_SYMBOLS = roboptim::detail # directories that contain example code fragments that are included (see # the \include command). -EXAMPLE_PATH = @top_srcdir@/tests +EXAMPLE_PATH = @abs_top_srcdir@/tests # If the value of the EXAMPLE_PATH tag contains directories, you can use the # EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp @@ -570,21 +647,24 @@ EXAMPLE_RECURSIVE = NO # directories that contain image that are included in the documentation (see # the \image command). -IMAGE_PATH = +IMAGE_PATH = @abs_top_srcdir@/doc # The INPUT_FILTER tag can be used to specify a program that doxygen should # invoke to filter for each input file. Doxygen will invoke the filter program # by executing (via popen()) the command <filter> <input-file>, where <filter> # is the value of the INPUT_FILTER tag, and <input-file> is the name of an # input file. Doxygen will then use the output that the filter program writes -# to standard output. If FILTER_PATTERNS is specified, this tag will be +# to standard output. +# If FILTER_PATTERNS is specified, this tag will be # ignored. INPUT_FILTER = # The FILTER_PATTERNS tag can be used to specify filters on a per file pattern -# basis. Doxygen will compare the file name with each pattern and apply the -# filter if there is a match. The filters are a list of the form: +# basis. +# Doxygen will compare the file name with each pattern and apply the +# filter if there is a match. +# The filters are a list of the form: # pattern=filter (like *.cpp=my_cpp_filter). See INPUT_FILTER for further # info on how filters are used. If FILTER_PATTERNS is empty, INPUT_FILTER # is applied to all files. @@ -604,9 +684,7 @@ FILTER_SOURCE_FILES = NO # If the SOURCE_BROWSER tag is set to YES then a list of source files will # be generated. Documented entities will be cross-referenced with these sources. # Note: To get rid of all source code in the generated output, make sure also -# VERBATIM_HEADERS is set to NO. If you have enabled CALL_GRAPH or CALLER_GRAPH -# then you must also enable this option. If you don't then doxygen will produce -# a warning and turn it on anyway +# VERBATIM_HEADERS is set to NO. SOURCE_BROWSER = NO @@ -621,13 +699,13 @@ INLINE_SOURCES = NO STRIP_CODE_COMMENTS = YES -# If the REFERENCED_BY_RELATION tag is set to YES (the default) +# If the REFERENCED_BY_RELATION tag is set to YES # then for each documented function all documented # functions referencing it will be listed. REFERENCED_BY_RELATION = YES -# If the REFERENCES_RELATION tag is set to YES (the default) +# If the REFERENCES_RELATION tag is set to YES # then for each documented function all documented entities # called/used by that function will be listed. @@ -636,7 +714,8 @@ REFERENCES_RELATION = YES # If the REFERENCES_LINK_SOURCE tag is set to YES (the default) # and SOURCE_BROWSER tag is set to YES, then the hyperlinks from # functions in REFERENCES_RELATION and REFERENCED_BY_RELATION lists will -# link to the source code. Otherwise they will link to the documentstion. +# link to the source code. +# Otherwise they will link to the documentation. REFERENCES_LINK_SOURCE = YES @@ -702,13 +781,13 @@ HTML_FILE_EXTENSION = .html # each generated HTML page. If it is left blank doxygen will generate a # standard header. -HTML_HEADER = @top_srcdir@/doc/header.html +HTML_HEADER = @abs_top_srcdir@/doc/header.html # The HTML_FOOTER tag can be used to specify a personal HTML footer for # each generated HTML page. If it is left blank doxygen will generate a # standard footer. -HTML_FOOTER = @top_srcdir@/doc/footer.html +HTML_FOOTER = @abs_top_srcdir@/doc/footer.html # The HTML_STYLESHEET tag can be used to specify a user-defined cascading # style sheet that is used by each HTML page. It can be used to @@ -717,7 +796,7 @@ HTML_FOOTER = @top_srcdir@/doc/footer.html # the style sheet file to the HTML output directory, so don't put your own # stylesheet in the HTML output directory as well, or it will be erased! -HTML_STYLESHEET = @top_srcdir@/doc/package.css +HTML_STYLESHEET = @abs_top_srcdir@/doc/package.css # If the HTML_ALIGN_MEMBERS tag is set to YES, the members of classes, # files or namespaces will be aligned in HTML using tables. If set to @@ -725,13 +804,6 @@ HTML_STYLESHEET = @top_srcdir@/doc/package.css HTML_ALIGN_MEMBERS = YES -# If the GENERATE_HTMLHELP tag is set to YES, additional index files -# will be generated that can be used as input for tools like the -# Microsoft HTML help workshop to generate a compressed HTML help file (.chm) -# of the generated HTML documentation. - -GENERATE_HTMLHELP = NO - # If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML # documentation will contain sections that can be hidden and shown after the # page has loaded. For this to work a browser that supports @@ -740,6 +812,39 @@ GENERATE_HTMLHELP = NO HTML_DYNAMIC_SECTIONS = YES +# If the GENERATE_DOCSET tag is set to YES, additional index files +# will be generated that can be used as input for Apple's Xcode 3 +# integrated development environment, introduced with OSX 10.5 (Leopard). +# To create a documentation set, doxygen will generate a Makefile in the +# HTML output directory. Running make will produce the docset in that +# directory and running "make install" will install the docset in +# ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find +# it at startup. +# See http://developer.apple.com/tools/creatingdocsetswithdoxygen.html for more information. + +GENERATE_DOCSET = NO + +# When GENERATE_DOCSET tag is set to YES, this tag determines the name of the +# feed. A documentation feed provides an umbrella under which multiple +# documentation sets from a single provider (such as a company or product suite) +# can be grouped. + +DOCSET_FEEDNAME = "Doxygen generated docs" + +# When GENERATE_DOCSET tag is set to YES, this tag specifies a string that +# should uniquely identify the documentation set bundle. This should be a +# reverse domain-name style string, e.g. com.mycompany.MyDocSet. Doxygen +# will append .docset to the name. + +DOCSET_BUNDLE_ID = org.doxygen.Project + +# If the GENERATE_HTMLHELP tag is set to YES, additional index files +# will be generated that can be used as input for tools like the +# Microsoft HTML help workshop to generate a compiled HTML help file (.chm) +# of the generated HTML documentation. + +GENERATE_HTMLHELP = NO + # If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can # be used to specify the file name of the resulting .chm file. You # can add a path in front of the file if the result should not be @@ -760,6 +865,12 @@ HHC_LOCATION = GENERATE_CHI = NO +# If the GENERATE_HTMLHELP tag is set to YES, the CHM_INDEX_ENCODING +# is used to encode HtmlHelp index (hhk), content (hhc) and project file +# content. + +CHM_INDEX_ENCODING = + # If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag # controls whether a binary table of contents is generated (YES) or a # normal table of contents (NO) in the .chm file. @@ -771,6 +882,55 @@ BINARY_TOC = NO TOC_EXPAND = NO +# If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and QHP_VIRTUAL_FOLDER +# are set, an additional index file will be generated that can be used as input for +# Qt's qhelpgenerator to generate a Qt Compressed Help (.qch) of the generated +# HTML documentation. + +GENERATE_QHP = NO + +# If the QHG_LOCATION tag is specified, the QCH_FILE tag can +# be used to specify the file name of the resulting .qch file. +# The path specified is relative to the HTML output folder. + +QCH_FILE = + +# The QHP_NAMESPACE tag specifies the namespace to use when generating +# Qt Help Project output. For more information please see +# http://doc.trolltech.com/qthelpproject.html#namespace + +QHP_NAMESPACE = + +# The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating +# Qt Help Project output. For more information please see +# http://doc.trolltech.com/qthelpproject.html#virtual-folders + +QHP_VIRTUAL_FOLDER = doc + +# If QHP_CUST_FILTER_NAME is set, it specifies the name of a custom filter to add. +# For more information please see +# http://doc.trolltech.com/qthelpproject.html#custom-filters + +QHP_CUST_FILTER_NAME = + +# The QHP_CUST_FILT_ATTRS tag specifies the list of the attributes of the custom filter to add.For more information please see +# <a href="http://doc.trolltech.com/qthelpproject.html#custom-filters">Qt Help Project / Custom Filters</a>. + +QHP_CUST_FILTER_ATTRS = + +# The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this project's +# filter section matches. +# <a href="http://doc.trolltech.com/qthelpproject.html#filter-attributes">Qt Help Project / Filter Attributes</a>. + +QHP_SECT_FILTER_ATTRS = + +# If the GENERATE_QHP tag is set to YES, the QHG_LOCATION tag can +# be used to specify the location of Qt's qhelpgenerator. +# If non-empty doxygen will try to run qhelpgenerator on the generated +# .qhp file. + +QHG_LOCATION = + # The DISABLE_INDEX tag can be used to turn on/off the condensed index at # top of each HTML page. The value NO (the default) enables the index and # the value YES disables it. @@ -782,12 +942,20 @@ DISABLE_INDEX = NO ENUM_VALUES_PER_LINE = 4 -# If the GENERATE_TREEVIEW tag is set to YES, a side panel will be -# generated containing a tree-like index structure (just like the one that +# The GENERATE_TREEVIEW tag is used to specify whether a tree-like index +# structure should be generated to display hierarchical information. +# If the tag value is set to FRAME, a side panel will be generated +# containing a tree-like index structure (just like the one that # is generated for HTML Help). For this to work a browser that supports # JavaScript, DHTML, CSS and frames is required (for instance Mozilla 1.0+, # Netscape 6.0+, Internet explorer 5.0+, or Konqueror). Windows users are -# probably better off using the HTML help feature. +# probably better off using the HTML help feature. Other possible values +# for this tag are: HIERARCHIES, which will generate the Groups, Directories, +# and Class Hierarchy pages using a tree view instead of an ordered list; +# ALL, which combines the behavior of FRAME and HIERARCHIES; and NONE, which +# disables this behavior completely. For backwards compatibility with previous +# releases of Doxygen, the values YES and NO are equivalent to FRAME and NONE +# respectively. GENERATE_TREEVIEW = YES @@ -797,6 +965,14 @@ GENERATE_TREEVIEW = YES TREEVIEW_WIDTH = 250 +# Use this tag to change the font size of Latex formulas included +# as images in the HTML documentation. The default is 10. Note that +# when you change the font size after a successful doxygen run you need +# to manually remove any form_*.png images from the HTML output directory +# to force them to be regenerated. + +FORMULA_FONTSIZE = 10 + #--------------------------------------------------------------------------- # configuration options related to the LaTeX output #--------------------------------------------------------------------------- @@ -1009,8 +1185,10 @@ GENERATE_PERLMOD = NO PERLMOD_LATEX = NO # If the PERLMOD_PRETTY tag is set to YES the Perl module output will be -# nicely formatted so it can be parsed by a human reader. This is useful -# if you want to understand what is going on. On the other hand, if this +# nicely formatted so it can be parsed by a human reader. +# This is useful +# if you want to understand what is going on. +# On the other hand, if this # tag is set to NO the size of the Perl module output will be much smaller # and Perl will parse it just the same. @@ -1097,9 +1275,11 @@ SKIP_FUNCTION_MACROS = YES # Optionally an initial location of the external documentation # can be added for each tagfile. The format of a tag file without # this location is as follows: -# TAGFILES = file1 file2 ... +# +# TAGFILES = file1 file2 ... # Adding location for the tag files is done as follows: -# TAGFILES = file1=loc1 "file2 = loc2" ... +# +# TAGFILES = file1=loc1 "file2 = loc2" ... # where "loc1" and "loc2" can be relative or absolute paths or # URLs. If a location is present for each tag, the installdox tool # does not have to be run to correct the links. @@ -1130,7 +1310,7 @@ EXTERNAL_GROUPS = YES # The PERL_PATH should be the absolute path and name of the perl script # interpreter (i.e. the result of `which perl'). -PERL_PATH = /usr/bin/perl +PERL_PATH = @PERL@ #--------------------------------------------------------------------------- # Configuration options related to the dot tool @@ -1146,10 +1326,11 @@ PERL_PATH = /usr/bin/perl CLASS_DIAGRAMS = YES # You can define message sequence charts within doxygen comments using the \msc -# command. Doxygen will then run the mscgen tool (see http://www.mcternan.me.uk/mscgen/) to -# produce the chart and insert it in the documentation. The MSCGEN_PATH tag allows you to -# specify the directory where the mscgen tool resides. If left empty the tool is assumed to -# be found in the default search path. +# command. Doxygen will then run the mscgen tool (see +# http://www.mcternan.me.uk/mscgen/) to produce the chart and insert it in the +# documentation. The MSCGEN_PATH tag allows you to specify the directory where +# the mscgen tool resides. If left empty the tool is assumed to be found in the +# default search path. MSCGEN_PATH = @@ -1164,7 +1345,30 @@ HIDE_UNDOC_RELATIONS = YES # toolkit from AT&T and Lucent Bell Labs. The other options in this section # have no effect if this option is set to NO (the default) -HAVE_DOT = YES +HAVE_DOT = @HAVE_DOT@ + +# By default doxygen will write a font called FreeSans.ttf to the output +# directory and reference it in all dot files that doxygen generates. This +# font does not include all possible unicode characters however, so when you need +# these (or just want a differently looking font) you can specify the font name +# using DOT_FONTNAME. You need need to make sure dot is able to find the font, +# which can be done by putting it in a standard location or by setting the +# DOTFONTPATH environment variable or by setting DOT_FONTPATH to the directory +# containing the font. + +DOT_FONTNAME = FreeSans + +# The DOT_FONTSIZE tag can be used to set the size of the font of dot graphs. +# The default size is 10pt. + +DOT_FONTSIZE = 10 + +# By default doxygen will tell dot to use the output directory to look for the +# FreeSans.ttf font (which doxygen will put there itself). If you specify a +# different font using DOT_FONTNAME you can set the path where dot +# can find it using this tag. + +DOT_FONTPATH = # If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen # will generate a graph for each documented class showing the direct and @@ -1210,19 +1414,19 @@ INCLUDE_GRAPH = YES INCLUDED_BY_GRAPH = YES -# If the CALL_GRAPH, SOURCE_BROWSER and HAVE_DOT tags are set to YES then doxygen will -# generate a call dependency graph for every global function or class method. -# Note that enabling this option will significantly increase the time of a run. -# So in most cases it will be better to enable call graphs for selected -# functions only using the \callgraph command. +# If the CALL_GRAPH and HAVE_DOT options are set to YES then +# doxygen will generate a call dependency graph for every global function +# or class method. Note that enabling this option will significantly increase +# the time of a run. So in most cases it will be better to enable call graphs +# for selected functions only using the \callgraph command. CALL_GRAPH = NO -# If the CALLER_GRAPH, SOURCE_BROWSER and HAVE_DOT tags are set to YES then doxygen will -# generate a caller dependency graph for every global function or class method. -# Note that enabling this option will significantly increase the time of a run. -# So in most cases it will be better to enable caller graphs for selected -# functions only using the \callergraph command. +# If the CALLER_GRAPH and HAVE_DOT tags are set to YES then +# doxygen will generate a caller dependency graph for every global function +# or class method. Note that enabling this option will significantly increase +# the time of a run. So in most cases it will be better to enable caller +# graphs for selected functions only using the \callergraph command. CALLER_GRAPH = NO @@ -1255,12 +1459,12 @@ DOT_PATH = DOTFILE_DIRS = -# The MAX_DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of +# The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of # nodes that will be shown in the graph. If the number of nodes in a graph # becomes larger than this value, doxygen will truncate the graph, which is -# visualized by representing a node as a red box. Note that doxygen if the number -# of direct children of the root node in a graph is already larger than -# MAX_DOT_GRAPH_NOTES then the graph will not be shown at all. Also note +# visualized by representing a node as a red box. Note that doxygen if the +# number of direct children of the root node in a graph is already larger than +# DOT_GRAPH_MAX_NODES then the graph will not be shown at all. Also note # that the size of a graph can be further restricted by MAX_DOT_GRAPH_DEPTH. DOT_GRAPH_MAX_NODES = 50 @@ -1276,10 +1480,10 @@ DOT_GRAPH_MAX_NODES = 50 MAX_DOT_GRAPH_DEPTH = 0 # Set the DOT_TRANSPARENT tag to YES to generate images with a transparent -# background. This is disabled by default, which results in a white background. -# Warning: Depending on the platform used, enabling this option may lead to -# badly anti-aliased labels on the edges of a graph (i.e. they become hard to -# read). +# background. This is disabled by default, because dot on Windows does not +# seem to support this out of the box. Warning: Depending on the platform used, +# enabling this option may lead to badly anti-aliased labels on the edges of +# a graph (i.e. they become hard to read). DOT_TRANSPARENT = YES @@ -1303,7 +1507,7 @@ GENERATE_LEGEND = YES DOT_CLEANUP = YES #--------------------------------------------------------------------------- -# Configuration::additions related to the search engine +# Options related to the search engine #--------------------------------------------------------------------------- # The SEARCHENGINE tag specifies whether or not a search engine should be diff --git a/doc/Makefile.am b/doc/Makefile.am index c5139b7..d8beceb 100644 --- a/doc/Makefile.am +++ b/doc/Makefile.am @@ -1,25 +1,53 @@ -.PHONY: doc html install-doxygen-html uninstall-doxygen-html +include $(top_srcdir)/build-aux/init.mk +# Variables. +EXTRA_DIST += \ + Doxyfile.in \ + header.html \ + footer.html \ + package.css \ + doxygen.css \ + tabs.css \ + sf-upload.sh.in + +CLEANFILES += $(PACKAGE_TARNAME).doxytag + + +.PHONY: doc \ + html \ + doxygen \ + install-doxygen-html \ + uninstall-doxygen-html + +# Rules. doc: html -html-local: Doxyfile - $(DOXYGEN) +html-local: doxygen -EXTRA_DIST = Doxyfile.in header.html footer.html \ - package.css doxygen.css tabs.css sf-upload.sh.in +doxygen: Doxyfile + $(DOXYGEN) "$<" -CLEANFILES = $(PACKAGE_TARNAME).doxytag +# Doxygen generation rule. +Doxyfile: $(srcdir)/Doxyfile.in + $(top_builddir)/config.status --file="$@":"$<" \ + && sed -i -e 's/^#.*//' -e '/^$$/d' "$@" +# Clean rule. clean-local: rm -rf html latex +# Install rules. install-data-local: install-doxygen-html uninstall-local: uninstall-doxygen-html install-doxygen-html: html-local - $(mkdir_p) "$(DESTDIR)$(htmldir)/html" - cp -rf html/* "$(DESTDIR)$(htmldir)/html" + cp -rf html "$(DESTDIR)$(htmldir)" $(INSTALL_DATA) $(PACKAGE_TARNAME).doxytag "$(DESTDIR)$(htmldir)/html" uninstall-doxygen-html: rm -rf "$(DESTDIR)$(htmldir)" + +# --- SourceForge upload script. +# sf-upload.sh generation rule. +sf-upload.sh: $(srcdir)/sf-upload.sh.in + $(top_builddir)/config.status --file="$@":"$<" && chmod u+x "$@" diff --git a/doc/Makefile.in b/doc/Makefile.in new file mode 100644 index 0000000..81e96d6 --- /dev/null +++ b/doc/Makefile.in @@ -0,0 +1,420 @@ +# Makefile.in generated by automake 1.10.2 from Makefile.am. +# @configure_input@ + +# Copyright (C) 1994, 1995, 1996, 1997, 1998, 1999, 2000, 2001, 2002, +# 2003, 2004, 2005, 2006, 2007, 2008 Free Software Foundation, Inc. +# This Makefile.in is free software; the Free Software Foundation +# gives unlimited permission to copy and/or distribute it, +# with or without modifications, as long as this notice is preserved. + +# This program is distributed in the hope that it will be useful, +# but WITHOUT ANY WARRANTY, to the extent permitted by law; without +# even the implied warranty of MERCHANTABILITY or FITNESS FOR A +# PARTICULAR PURPOSE. + +@SET_MAKE@ + +# Get rid of the annoying Automake behavior which forces `+=' +# to be used after `=' +VPATH = @srcdir@ +pkgdatadir = $(datadir)/@PACKAGE@ +pkglibdir = $(libdir)/@PACKAGE@ +pkgincludedir = $(includedir)/@PACKAGE@ +am__cd = CDPATH="$${ZSH_VERSION+.}$(PATH_SEPARATOR)" && cd +install_sh_DATA = $(install_sh) -c -m 644 +install_sh_PROGRAM = $(install_sh) -c +install_sh_SCRIPT = $(install_sh) -c +INSTALL_HEADER = $(INSTALL_DATA) +transform = $(program_transform_name) +NORMAL_INSTALL = : +PRE_INSTALL = : +POST_INSTALL = : +NORMAL_UNINSTALL = : +PRE_UNINSTALL = : +POST_UNINSTALL = : +build_triplet = @build@ +host_triplet = @host@ +DIST_COMMON = $(srcdir)/Makefile.am $(srcdir)/Makefile.in \ + $(top_srcdir)/build-aux/init.mk +subdir = doc +ACLOCAL_M4 = $(top_srcdir)/aclocal.m4 +am__aclocal_m4_deps = $(top_srcdir)/build-aux/boost.m4 \ + $(top_srcdir)/build-aux/doxygen.m4 \ + $(top_srcdir)/build-aux/libtool.m4 \ + $(top_srcdir)/build-aux/ltoptions.m4 \ + $(top_srcdir)/build-aux/ltsugar.m4 \ + $(top_srcdir)/build-aux/ltversion.m4 \ + $(top_srcdir)/build-aux/lt~obsolete.m4 \ + $(top_srcdir)/build-aux/warning.m4 $(top_srcdir)/configure.ac +am__configure_deps = $(am__aclocal_m4_deps) $(CONFIGURE_DEPENDENCIES) \ + $(ACLOCAL_M4) +mkinstalldirs = $(install_sh) -d +CONFIG_HEADER = $(top_builddir)/config.h +CONFIG_CLEAN_FILES = +SOURCES = +DIST_SOURCES = +DISTFILES = $(DIST_COMMON) $(DIST_SOURCES) $(TEXINFOS) $(EXTRA_DIST) +ACLOCAL = @ACLOCAL@ +AMTAR = @AMTAR@ +AR = @AR@ +AUTOCONF = @AUTOCONF@ +AUTOHEADER = @AUTOHEADER@ +AUTOM4TE = @AUTOM4TE@ +AUTOMAKE = @AUTOMAKE@ +AWK = @AWK@ +BOOST_CPPFLAGS = @BOOST_CPPFLAGS@ +BOOST_ROOT = @BOOST_ROOT@ +CC = @CC@ +CCDEPMODE = @CCDEPMODE@ +CFLAGS = @CFLAGS@ +CPP = @CPP@ +CPPFLAGS = @CPPFLAGS@ +CXX = @CXX@ +CXXCPP = @CXXCPP@ +CXXDEPMODE = @CXXDEPMODE@ +CXXFLAGS = @CXXFLAGS@ +CYGPATH_W = @CYGPATH_W@ +DEFS = @DEFS@ +DEPDIR = @DEPDIR@ +DISTCHECK_CONFIGURE_FLAGS = @DISTCHECK_CONFIGURE_FLAGS@ +DOT = @DOT@ +DOXYGEN = @DOXYGEN@ +DSYMUTIL = @DSYMUTIL@ +DUMPBIN = @DUMPBIN@ +ECHO_C = @ECHO_C@ +ECHO_N = @ECHO_N@ +ECHO_T = @ECHO_T@ +EGREP = @EGREP@ +EXEEXT = @EXEEXT@ +FGREP = @FGREP@ +GREP = @GREP@ +HAVE_DOT = @HAVE_DOT@ +INSTALL = @INSTALL@ +INSTALL_DATA = @INSTALL_DATA@ +INSTALL_PROGRAM = @INSTALL_PROGRAM@ +INSTALL_SCRIPT = @INSTALL_SCRIPT@ +INSTALL_STRIP_PROGRAM = @INSTALL_STRIP_PROGRAM@ +LD = @LD@ +LDFLAGS = @LDFLAGS@ +LIBOBJS = @LIBOBJS@ +LIBS = @LIBS@ +LIBTOOL = @LIBTOOL@ +LIPO = @LIPO@ +LN_S = @LN_S@ +LTLIBOBJS = @LTLIBOBJS@ +MAKEINFO = @MAKEINFO@ +MKDIR_P = @MKDIR_P@ +NM = @NM@ +NMEDIT = @NMEDIT@ +OBJDUMP = @OBJDUMP@ +OBJEXT = @OBJEXT@ +OTOOL = @OTOOL@ +OTOOL64 = @OTOOL64@ +PACKAGE = @PACKAGE@ +PACKAGE_BUGREPORT = @PACKAGE_BUGREPORT@ +PACKAGE_NAME = @PACKAGE_NAME@ +PACKAGE_STRING = @PACKAGE_STRING@ +PACKAGE_TARNAME = @PACKAGE_TARNAME@ +PACKAGE_VERSION = @PACKAGE_VERSION@ +PATH_SEPARATOR = @PATH_SEPARATOR@ +PERL = @PERL@ +PKGCONFIG_CFLAGS = @PKGCONFIG_CFLAGS@ +PKGCONFIG_CONFLICTS = @PKGCONFIG_CONFLICTS@ +PKGCONFIG_DESCRIPTION = @PKGCONFIG_DESCRIPTION@ +PKGCONFIG_LIBS = @PKGCONFIG_LIBS@ +PKGCONFIG_REQUIRES = @PKGCONFIG_REQUIRES@ +RANLIB = @RANLIB@ +SED = @SED@ +SET_MAKE = @SET_MAKE@ +SHELL = @SHELL@ +STRIP = @STRIP@ +VERSION = @VERSION@ +WARNING_CXXFLAGS = @WARNING_CXXFLAGS@ +abs_builddir = @abs_builddir@ +abs_srcdir = @abs_srcdir@ +abs_top_builddir = @abs_top_builddir@ +abs_top_srcdir = @abs_top_srcdir@ +ac_ct_CC = @ac_ct_CC@ +ac_ct_CXX = @ac_ct_CXX@ +ac_ct_DUMPBIN = @ac_ct_DUMPBIN@ +am__include = @am__include@ +am__leading_dot = @am__leading_dot@ +am__quote = @am__quote@ +am__tar = @am__tar@ +am__untar = @am__untar@ +bindir = @bindir@ +build = @build@ +build_alias = @build_alias@ +build_cpu = @build_cpu@ +build_os = @build_os@ +build_vendor = @build_vendor@ +builddir = @builddir@ +datadir = @datadir@ +datarootdir = @datarootdir@ +docdir = @docdir@ +dvidir = @dvidir@ +exec_prefix = @exec_prefix@ +host = @host@ +host_alias = @host_alias@ +host_cpu = @host_cpu@ +host_os = @host_os@ +host_vendor = @host_vendor@ +htmldir = @htmldir@ +includedir = @includedir@ +infodir = @infodir@ +install_sh = @install_sh@ +libdir = @libdir@ +libexecdir = @libexecdir@ +localedir = @localedir@ +localstatedir = @localstatedir@ +lt_ECHO = @lt_ECHO@ +mandir = @mandir@ +mkdir_p = @mkdir_p@ +oldincludedir = @oldincludedir@ +pdfdir = @pdfdir@ +prefix = @prefix@ +program_transform_name = @program_transform_name@ +psdir = @psdir@ +sbindir = @sbindir@ +sharedstatedir = @sharedstatedir@ +srcdir = @srcdir@ +sysconfdir = @sysconfdir@ +target_alias = @target_alias@ +top_build_prefix = @top_build_prefix@ +top_builddir = @top_builddir@ +top_srcdir = @top_srcdir@ + +# Add top_builddir to AM_CPPFLAGS in order to find config.h +# automatically. + +# Force generated files to be searched *before* source files. + +# ...then search in distributed headers. + +# Add boost include dir +AM_CPPFLAGS = -I$(top_builddir) -I$(top_builddir)/src \ + -I$(top_srcdir)/src -I$(top_srcdir)/include $(BOOST_CPPFLAGS) +AM_CXXFLAGS = +AM_LDFLAGS = +CLEANFILES = $(PACKAGE_TARNAME).doxytag +DISTCLEANFILES = + +# Variables. +EXTRA_DIST = Doxyfile.in header.html footer.html package.css \ + doxygen.css tabs.css sf-upload.sh.in +SUFFIXES = +all: all-am + +.SUFFIXES: +.SUFFIXES: +$(srcdir)/Makefile.in: $(srcdir)/Makefile.am $(top_srcdir)/build-aux/init.mk $(am__configure_deps) + @for dep in $?; do \ + case '$(am__configure_deps)' in \ + *$$dep*) \ + ( cd $(top_builddir) && $(MAKE) $(AM_MAKEFLAGS) am--refresh ) \ + && { if test -f $@; then exit 0; else break; fi; }; \ + exit 1;; \ + esac; \ + done; \ + echo ' cd $(top_srcdir) && $(AUTOMAKE) --gnu doc/Makefile'; \ + cd $(top_srcdir) && \ + $(AUTOMAKE) --gnu doc/Makefile +.PRECIOUS: Makefile +Makefile: $(srcdir)/Makefile.in $(top_builddir)/config.status + @case '$?' in \ + *config.status*) \ + cd $(top_builddir) && $(MAKE) $(AM_MAKEFLAGS) am--refresh;; \ + *) \ + echo ' cd $(top_builddir) && $(SHELL) ./config.status $(subdir)/$@ $(am__depfiles_maybe)'; \ + cd $(top_builddir) && $(SHELL) ./config.status $(subdir)/$@ $(am__depfiles_maybe);; \ + esac; + +$(top_builddir)/config.status: $(top_srcdir)/configure $(CONFIG_STATUS_DEPENDENCIES) + cd $(top_builddir) && $(MAKE) $(AM_MAKEFLAGS) am--refresh + +$(top_srcdir)/configure: $(am__configure_deps) + cd $(top_builddir) && $(MAKE) $(AM_MAKEFLAGS) am--refresh +$(ACLOCAL_M4): $(am__aclocal_m4_deps) + cd $(top_builddir) && $(MAKE) $(AM_MAKEFLAGS) am--refresh + +mostlyclean-libtool: + -rm -f *.lo + +clean-libtool: + -rm -rf .libs _libs +tags: TAGS +TAGS: + +ctags: CTAGS +CTAGS: + + +distdir: $(DISTFILES) + @srcdirstrip=`echo "$(srcdir)" | sed 's/[].[^$$\\*]/\\\\&/g'`; \ + topsrcdirstrip=`echo "$(top_srcdir)" | sed 's/[].[^$$\\*]/\\\\&/g'`; \ + list='$(DISTFILES)'; \ + dist_files=`for file in $$list; do echo $$file; done | \ + sed -e "s|^$$srcdirstrip/||;t" \ + -e "s|^$$topsrcdirstrip/|$(top_builddir)/|;t"`; \ + case $$dist_files in \ + */*) $(MKDIR_P) `echo "$$dist_files" | \ + sed '/\//!d;s|^|$(distdir)/|;s,/[^/]*$$,,' | \ + sort -u` ;; \ + esac; \ + for file in $$dist_files; do \ + if test -f $$file || test -d $$file; then d=.; else d=$(srcdir); fi; \ + if test -d $$d/$$file; then \ + dir=`echo "/$$file" | sed -e 's,/[^/]*$$,,'`; \ + if test -d $(srcdir)/$$file && test $$d != $(srcdir); then \ + cp -pR $(srcdir)/$$file $(distdir)$$dir || exit 1; \ + fi; \ + cp -pR $$d/$$file $(distdir)$$dir || exit 1; \ + else \ + test -f $(distdir)/$$file \ + || cp -p $$d/$$file $(distdir)/$$file \ + || exit 1; \ + fi; \ + done +check-am: all-am +check: check-am +all-am: Makefile +installdirs: +install: install-am +install-exec: install-exec-am +install-data: install-data-am +uninstall: uninstall-am + +install-am: all-am + @$(MAKE) $(AM_MAKEFLAGS) install-exec-am install-data-am + +installcheck: installcheck-am +install-strip: + $(MAKE) $(AM_MAKEFLAGS) INSTALL_PROGRAM="$(INSTALL_STRIP_PROGRAM)" \ + install_sh_PROGRAM="$(INSTALL_STRIP_PROGRAM)" INSTALL_STRIP_FLAG=-s \ + `test -z '$(STRIP)' || \ + echo "INSTALL_PROGRAM_ENV=STRIPPROG='$(STRIP)'"` install +mostlyclean-generic: + +clean-generic: + -test -z "$(CLEANFILES)" || rm -f $(CLEANFILES) + +distclean-generic: + -test -z "$(CONFIG_CLEAN_FILES)" || rm -f $(CONFIG_CLEAN_FILES) + -test -z "$(DISTCLEANFILES)" || rm -f $(DISTCLEANFILES) + +maintainer-clean-generic: + @echo "This command is intended for maintainers to use" + @echo "it deletes files that may require special tools to rebuild." +clean: clean-am + +clean-am: clean-generic clean-libtool clean-local mostlyclean-am + +distclean: distclean-am + -rm -f Makefile +distclean-am: clean-am distclean-generic + +dvi: dvi-am + +dvi-am: + +html: html-am + +html-am: html-local + +info: info-am + +info-am: + +install-data-am: install-data-local + +install-dvi: install-dvi-am + +install-exec-am: + +install-html: install-html-am + +install-info: install-info-am + +install-man: + +install-pdf: install-pdf-am + +install-ps: install-ps-am + +installcheck-am: + +maintainer-clean: maintainer-clean-am + -rm -f Makefile +maintainer-clean-am: distclean-am maintainer-clean-generic + +mostlyclean: mostlyclean-am + +mostlyclean-am: mostlyclean-generic mostlyclean-libtool + +pdf: pdf-am + +pdf-am: + +ps: ps-am + +ps-am: + +uninstall-am: uninstall-local + +.MAKE: install-am install-strip + +.PHONY: all all-am check check-am clean clean-generic clean-libtool \ + clean-local distclean distclean-generic distclean-libtool \ + distdir dvi dvi-am html html-am html-local info info-am \ + install install-am install-data install-data-am \ + install-data-local install-dvi install-dvi-am install-exec \ + install-exec-am install-html install-html-am install-info \ + install-info-am install-man install-pdf install-pdf-am \ + install-ps install-ps-am install-strip installcheck \ + installcheck-am installdirs maintainer-clean \ + maintainer-clean-generic mostlyclean mostlyclean-generic \ + mostlyclean-libtool pdf pdf-am ps ps-am uninstall uninstall-am \ + uninstall-local + + +.PHONY: doc \ + html \ + doxygen \ + install-doxygen-html \ + uninstall-doxygen-html + +# Rules. +doc: html + +html-local: doxygen + +doxygen: Doxyfile + $(DOXYGEN) "$<" + +# Doxygen generation rule. +Doxyfile: $(srcdir)/Doxyfile.in + $(top_builddir)/config.status --file="$@":"$<" \ + && sed -i -e 's/^#.*//' -e '/^$$/d' "$@" + +# Clean rule. +clean-local: + rm -rf html latex + +# Install rules. +install-data-local: install-doxygen-html +uninstall-local: uninstall-doxygen-html + +install-doxygen-html: html-local + cp -rf html "$(DESTDIR)$(htmldir)" + $(INSTALL_DATA) $(PACKAGE_TARNAME).doxytag "$(DESTDIR)$(htmldir)/html" + +uninstall-doxygen-html: + rm -rf "$(DESTDIR)$(htmldir)" + +# --- SourceForge upload script. +# sf-upload.sh generation rule. +sf-upload.sh: $(srcdir)/sf-upload.sh.in + $(top_builddir)/config.status --file="$@":"$<" && chmod u+x "$@" +# Tell versions [3.59,3.63) of GNU make to not export all variables. +# Otherwise a system limit (for SysV at least) may be exceeded. +.NOEXPORT: diff --git a/doc/sf-upload.sh.in b/doc/sf-upload.sh.in index eea3f07..3f11bc7 100644 --- a/doc/sf-upload.sh.in +++ b/doc/sf-upload.sh.in @@ -16,7 +16,7 @@ # # Then launch the script. It will prompt for your password # and upload the documentation in a @PACKAGE_TARNAME@ folder. - +set -e rsync=$(which rsync) @@ -31,9 +31,22 @@ if test "x$SF_USERNAME" = x; then exit 2 fi -echo "Uploading documentation to SourceForge server, please wait."; -$rsync -avP -e ssh @abs_builddir@/html/ \ - $SF_USERNAME,rob...@we...:htdocs/doc/core/HEAD/ +if test "x$VERSION" = x; then + echo "No version set, defaulting to ``HEAD''." + VERSION=HEAD +fi + +rsync_cmd="$rsync -avP -e ssh" +localdir="@abs_builddir@/html/" +remotedir="htdocs/doc/core/$VERSION" +rsync_loghost="$SF_USERNAME,rob...@we...:" + +echo "Fixing local rights."; +chmod 644 "$localdir/*" +echo "Uploading documentation to SourceForge server."; +$rsync_cmd "$localdir" "$rsync_loghost$remotedir" +#echo "Fixing documentation rights."; +#echo "cd \"$remotedir\"; chmod 644 *" | $rsync_cmd "$rsync_loghost$remotedir" ret="$?"; if test 0 -eq "$ret"; then echo "Done. Exiting"; commit b5a36f0c7bba89d62970f7775f9a7c4fa824ac44 Author: Thomas Moulard <tho...@gm...> Date: Wed Jun 10 17:50:29 2009 +0900 Add pkg-config rules. * build-aux/pkg-config.mk: New. * build-aux/pkg-config.pc.in: Use Autoconf new macros. Signed-off-by: Thomas Moulard <tho...@gm...> diff --git a/ChangeLog b/ChangeLog index e69de29..7725d6b 100644 --- a/ChangeLog +++ b/ChangeLog @@ -0,0 +1,7 @@ +2009-06-10 Thomas Moulard <tho...@gm...> + + Add pkg-config rules. + * build-aux/pkg-config.mk: New. + * build-aux/pkg-config.pc.in: Use Autoconf new + macros. + diff --git a/build-aux/pkg-config.mk b/build-aux/pkg-config.mk new file mode 100644 index 0000000..5dc23aa --- /dev/null +++ b/build-aux/pkg-config.mk @@ -0,0 +1,83 @@ +# -*-Automake-*- +# Copyright (C) 2009 by Thomas Moulard, AIST, CNRS, INRIA. +# This file is part of the roboptim. +# +# roboptim is free software: you can redistribute it and/or modify +# it under the terms of the GNU General Public License as published by +# the Free Software Foundation, either version 3 of the License, or +# (at your option) any later version. +# +# Additional permission under section 7 of the GNU General Public +# License, version 3 ("GPLv3"): +# +# If you convey this file as part of a work that contains a +# configuration script generated by Autoconf, you may do so under +# terms of your choice. +# +# roboptim is distributed in the hope that it will be useful, +# but WITHOUT ANY WARRANTY; without even the implied warranty of +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +# GNU General Public License for more details. +# +# You should have received a copy of the GNU General Public License +# along with roboptim. If not, see <http://www.gnu.org/licenses/>. + +# -------# +# README # +# -------# + +# This file contains pkg-config generation rules for Automake. +# +# This file assumes that: +# +# - you include *before* this file init.mk or make sure that any global +# variable can be used with the += syntax. +# - there is no other rule using install-data-local and uninstall-data-local. +# +# The generate pkg-config files can be customized using three Autoconf +# variables: +# - PKGCONFIG_REQUIRES: package dependencies, +# - PKGCONFIG_LIBS: package LDFLAGS, +# - PKGCONFIG_CFLAGS: package CFLAGS/CPPFLAGS/CXXFLAGS. + + +# Variables +pkg_config_file = '@PACKAGE_TARNAME@.pc' +pkgdir = "$(DESTDIR)$(libdir)/pkgconfig/" + +edit = $(SED) -e "s|@prefix\@|$(prefix)|" \ + -e 's,@exec_prefix\@,$(exec_prefix),g' \ + -e 's,@libdir\@,$(libdir),g' \ + -e 's,@includedir\@,$(includedir),g' \ + -e 's,@datarootdir\@,$(datarootdir),g' \ + -e 's,@PACKAGE\@,$(PACKAGE),g' \ + -e 's,@PACKAGE_TARNAME\@,$(PACKAGE_TARNAME),g' \ + -e 's,@VERSION\@,$(PACKAGE_VERSION),g' + +EXTRA_DIST += build-aux/pkg-config.pc.in +CLEANFILES += $(PKG_CONFIG_FILE) + +# pkg-config generation. +@PACKAGE_TARNAME@.pc: $(srcdir)/build-aux/pkg-config.pc.in + $(top_builddir)/config.status \ + --file="$@":"$(srcdir)/build-aux/pkg-config.pc.in" + +# Install, uninstall rules. +install-data-local: install-pkg-config +uninstall-local: uninstall-pkg-config + +install-pkg-config: $(PACKAGE_TARNAME).pc + $(mkdir_p) $(PKG_DIR) + $(install_sh_DATA) "$(PKG_CONFIG_FILE)" $(PKG_DIR) + +uninstall-pkg-config: + -rm -f "$(PKG_DIR)$(PKG_CONFIG_FILE)" + +# Check that the pkg-config file is generated. +check-local: @PACKAGE_TARNAME@.pc + @if ! test -f $(pkg_config_file); then \ + echo 'pkg-config file missing: failing...'; \ + return 1; \ + else \ + echo 'pkg-config file has been generated: ok.'; \ + fi diff --git a/build-aux/pkg-config.pc.in b/build-aux/pkg-config.pc.in index 667ab3a..0670c39 100644 --- a/build-aux/pkg-config.pc.in +++ b/build-aux/pkg-config.pc.in @@ -6,8 +6,11 @@ datarootdir=@datarootdir@ docdir=@datarootdir@/doc/@PACKAGE_TARNAME@ Name: @PACKAGE@ -Description: +Description: @PKGCONFIG_DESCRIPTION@ +URL: http://roboptim.sourceforge.net/ Version: @VERSION@ -Requires: -Libs: -L${libdir} -lroboptim-core -Cflags: -I${includedir} +Requires: @PKGCONFIG_REQUIRES@ +Conflicts: @PKGCONFIG_CONFLICTS@ +Libs: -L${libdir} @PKGCONFIG_LIBS@ +Libs.private: +Cflags: -I${includedir} @PKGCONFIG_CFLAGS@ ----------------------------------------------------------------------- Summary of changes: ChangeLog | 16 ++ build-aux/doxygen.m4 | 63 +++++++ build-aux/pkg-config.mk | 83 +++++++++ build-aux/pkg-config.pc.in | 11 +- doc/Doxyfile.in | 398 +++++++++++++++++++++++++++++++---------- doc/Makefile.am | 44 ++++- doc/Makefile.in | 420 ++++++++++++++++++++++++++++++++++++++++++++ doc/sf-upload.sh.in | 21 ++- 8 files changed, 943 insertions(+), 113 deletions(-) create mode 100644 build-aux/doxygen.m4 create mode 100644 build-aux/pkg-config.mk create mode 100644 doc/Makefile.in hooks/post-receive -- roboptim |
From: Thomas M. <tho...@us...> - 2009-06-10 01:50:52
|
This is an automated email from the git hooks/post-receive script. It was generated because a ref change was pushed to the repository containing the project "roboptim". The branch, web has been updated via e896d72a9e05e6dc727ac766d453ec8d88cc1377 (commit) from 430f093228ab3e8058a212886f7c9836175004f3 (commit) Those revisions listed above that are new to this repository have not appeared on any other notification email; so we list those revisions in full, below. - Log ----------------------------------------------------------------- commit e896d72a9e05e6dc727ac766d453ec8d88cc1377 Author: Thomas Moulard <tho...@gm...> Date: Wed Jun 10 10:48:48 2009 +0900 Add link to commit mailing-list and Git web broser. * htdocs/index.html: Here. Signed-off-by: Thomas Moulard <tho...@gm...> diff --git a/ChangeLog b/ChangeLog index fd058dc..3d6585a 100644 --- a/ChangeLog +++ b/ChangeLog @@ -1,3 +1,8 @@ +2009-06-10 Thomas Moulard <tho...@gm...> + + Add link to commit mailing-list and Git web broser. + * htdocs/index.html: Here. + 2009-05-04 Thomas Moulard <tho...@gm...> Fix link to roboptim-trajectory documentation (v0.2.1). diff --git a/htdocs/index.html b/htdocs/index.html index 8b91b2e..eb2fdbd 100644 --- a/htdocs/index.html +++ b/htdocs/index.html @@ -112,13 +112,19 @@ </div> - <h2><a name="download"></a>Download</h2> + <h2><a name="download"></a>Downloading RobOptim</h2> <p> The releases are available on the <a href="https://sourceforge.net/project/showfiles.php?group_id=259573">SourceForge space</a> for download. </p> + <p> + You can also retrieve the latest development version on + the <a href="https://sourceforge.net/scm/?type=git&group_id=259573">Git + repository</a>. + </p> + <h2><a name="mailinglist"></a>Mailing-lists</h2> <dl> @@ -133,6 +139,11 @@ <dd>User mailing-list (high volume, please use this mailing-list for communication)</dd> <dt> + <a href="https://lists.sourceforge.net/mailman/listinfo/roboptim-commit">roboptim-commit</a> + </dt> + <dd>Commit mailing-list (high volume)</dd> + + <dt> <a href="https://lists.sourceforge.net/mailman/listinfo/roboptim-devel">roboptim-devel</a> </dt> <dd>Developer only mailing-list (private)</dd> @@ -143,6 +154,11 @@ <h3>SourceForge</h3> <ul> <li><a href="https://sourceforge.net/projects/roboptim">SourceForge space</a></li> + <li> + <a href="https://sourceforge.net/scm/?type=git&group_id=259573">Git</a> + (<a href="http://roboptim.git.sourceforge.net/git/gitweb.cgi?p=roboptim">browse + repository</a>) + </li> <li><a href="http://apps.sourceforge.net/trac/roboptim/report">Tickets</a> (<a href="http://apps.sourceforge.net/trac/roboptim/report/1">active</a>)</li> <li><a href="http://apps.sourceforge.net/trac/roboptim/wiki">Wiki</a></li> ----------------------------------------------------------------------- Summary of changes: ChangeLog | 5 +++++ htdocs/index.html | 18 +++++++++++++++++- 2 files changed, 22 insertions(+), 1 deletions(-) hooks/post-receive -- roboptim |