[Olena-patches] milena 990: Clean up Doxygen's configuration and add support for Vcs.

https://svn.lrde.epita.fr/svn/oln/trunk/milena Index: ChangeLog from Roland Levillain &lt;roland(a)lrde.epita.fr&gt; Clean up Doxygen's configuration and add support for Vcs. * doc/Doxyfile.in: Wrap long lines. (INPUT_ENCODING): Set to ISO-8859-1. * test/: Rename as... * tests/: ...this. * vcs/milena.rb: New file. doc/Doxyfile.in | 119 ++++++++++++++++++++++++++++++-------------------------- vcs/milena.rb | 8 +-- 2 files changed, 68 insertions(+), 59 deletions(-) Index: vcs/milena.rb --- vcs/milena.rb (revision 0) +++ vcs/milena.rb (working copy) @@ -5,12 +5,12 @@ protocol_version '0.1' - def olena_commit! ( *args ) - common_commit!("990: <%= title %>", *args) do |subject| + def milena_commit! ( *args ) + common_commit!("milena 990: <%= title %>", *args) do |subject| mail!(:to => %w[olena-patches(a)lrde.epita.fr], :subject => subject) end end - alias_command :olnci, :olena_commit - default_commit :olena_commit + alias_command :mlnci, :milena_commit + default_commit :milena_commit end # class Vcs Index: doc/Doxyfile.in --- doc/Doxyfile.in (revision 989) +++ doc/Doxyfile.in (working copy) @@ -14,11 +14,12 @@ # 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 @@ -68,10 +69,11 @@ BRIEF_MEMBER_DESC = YES -# If the REPEAT_BRIEF tag is set to YES (the default) Doxygen will prepend -# the brief description of a member or function before the detailed description. -# Note: if both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the -# brief descriptions will be completely suppressed. +# If the REPEAT_BRIEF tag is set to YES (the default) Doxygen will +# prepend the brief description of a member or function before the +# detailed description. Note: if both HIDE_UNDOC_MEMBERS and +# BRIEF_MEMBER_DESC are set to NO, the brief descriptions will be +# completely suppressed. REPEAT_BRIEF = YES @@ -187,19 +189,20 @@ 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. +# 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. 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 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 -# diagrams that involve STL classes more complete and accurate. +# 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 diagrams that involve +# STL classes more complete and accurate. BUILTIN_STL_SUPPORT = YES @@ -387,19 +390,20 @@ SHOW_USED_FILES = YES -# If the sources in your project are distributed over multiple directories -# then setting the SHOW_DIRECTORIES tag to YES will show the directory hierarchy -# in the documentation. The default is NO. +# If the sources in your project are distributed over multiple +# directories then setting the SHOW_DIRECTORIES tag to YES will show +# the directory hierarchy in the documentation. The default is NO. SHOW_DIRECTORIES = 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 -# 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 -# is used as the file version. See the manual for examples. +# 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 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 is used as the file version. See the manual for examples. FILE_VERSION_FILTER = @@ -458,20 +462,22 @@ # configuration options related to the input files #--------------------------------------------------------------------------- -# The INPUT tag can be used to specify the files and/or directories that contain -# documented source files. You may enter file names like "myfile.cpp" or -# directories like "/usr/src/myproject". Separate the files or directories -# with spaces. +# The INPUT tag can be used to specify the files and/or directories +# that contain documented source files. You may enter file names like +# "myfile.cpp" or directories like "/usr/src/myproject". Separate the +# files or directories with spaces. INPUT = @top_srcdir@/milena \ @top_builddir@/milena -# 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 +INPUT_ENCODING = ISO-8859-1 # If the value of the INPUT tag contains directories, you can use the # FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp @@ -511,10 +517,11 @@ 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 +# 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 EXCLUDE_SYMBOLS = @@ -573,10 +580,10 @@ # configuration options related to source browsing #--------------------------------------------------------------------------- -# 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 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. SOURCE_BROWSER = NO @@ -1036,10 +1043,11 @@ PREDEFINED = -# If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then -# this tag can be used to specify a list of macro names that should be expanded. -# The macro definition that is found in the sources will be used. -# Use the PREDEFINED tag if you want to use a different macro definition. +# If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES +# then this tag can be used to specify a list of macro names that +# should be expanded. The macro definition that is found in the +# sources will be used. Use the PREDEFINED tag if you want to use a +# different macro definition. EXPAND_AS_DEFINED = @@ -1107,11 +1115,12 @@ 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. +# 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. MSCGEN_PATH =