Date: Sun, 10 Aug 2014 07:16:23 +0000 (UTC) From: Kurt Jaeger <pi@FreeBSD.org> To: ports-committers@freebsd.org, svn-ports-all@freebsd.org, svn-ports-head@freebsd.org Subject: svn commit: r364505 - in head/devel: . libosmocore libosmocore/files Message-ID: <53e71c48.2062.63d02076@svn.freebsd.org>
next in thread | raw e-mail | index | archive | help
Author: pi Date: Sun Aug 10 07:16:23 2014 New Revision: 364505 URL: http://svnweb.freebsd.org/changeset/ports/364505 QAT: https://qat.redports.org/buildarchive/r364505/ Log: New port: devel/libosmocore libosmocore is a library with various utility functions that were originally developed as part of the OpenBSC project, but which are of a more generic nature and thus useful to (at least) other programs that we develop in the sphere of Free Software / Open Source mobile communications. WWW: http://bb.osmocom.org/trac/wiki/libosmocore PR: 191877 Submitted by: koue@chaosophia.net Added: head/devel/libosmocore/ head/devel/libosmocore/Makefile (contents, props changed) head/devel/libosmocore/distinfo (contents, props changed) head/devel/libosmocore/files/ head/devel/libosmocore/files/patch-Doxyfile.codec.in (contents, props changed) head/devel/libosmocore/files/patch-Doxyfile.core.in (contents, props changed) head/devel/libosmocore/files/patch-Doxyfile.gsm.in (contents, props changed) head/devel/libosmocore/files/patch-Doxyfile.vty.in (contents, props changed) head/devel/libosmocore/pkg-descr (contents, props changed) head/devel/libosmocore/pkg-plist (contents, props changed) Modified: head/devel/Makefile Modified: head/devel/Makefile ============================================================================== --- head/devel/Makefile Sun Aug 10 06:21:53 2014 (r364504) +++ head/devel/Makefile Sun Aug 10 07:16:23 2014 (r364505) @@ -1082,6 +1082,7 @@ SUBDIR += libopkele SUBDIR += liborcus SUBDIR += libosinfo + SUBDIR += libosmocore SUBDIR += libowfat SUBDIR += libpafe SUBDIR += libpafe-ruby Added: head/devel/libosmocore/Makefile ============================================================================== --- /dev/null 00:00:00 1970 (empty, because file is newly added) +++ head/devel/libosmocore/Makefile Sun Aug 10 07:16:23 2014 (r364505) @@ -0,0 +1,38 @@ +# $FreeBSD$ + +PORTNAME= libosmocore +PORTVERSION= 0.6.6 +CATEGORIES= devel +MASTER_SITES= http://chaosophia.net/downloads/osmocom/${PORTNAME}/ \ + http://ns1.chaosophia.net/downloads/osmocom/${PORTNAME}/ + +MAINTAINER= koue@chaosophia.net +COMMENT= Common library for all Osmocom projects + +LICENSE= GPLv2 +LICENSE_FILE= ${WRKSRC}/COPYING + +USE_AUTOTOOLS= aclocal autoconf automake libtoolize autoheader +AUTOMAKE_ARGS= --gnu --add-missing --copy + +USES= gmake libtool +LDFLAGS+= -lexecinfo +USE_LDCONFIG= yes +INSTALL_TARGET= install-strip + +BUILD_DEPENDS+= doxygen:${PORTSDIR}/devel/doxygen \ + dot:${PORTSDIR}/graphics/graphviz + +post-patch: + ${REINPLACE_CMD} -e 's|pkgconfigdir.*|pkgconfigdir = ${PREFIX}/libdata/pkgconfig|g' \ + ${WRKSRC}/Makefile.am + ${ECHO_CMD} ${PORTVERSION} > ${WRKSRC}/.tarball-version + +post-install: + ${MKDIR} ${STAGEDIR}${DOCSDIR} +.for i in codec core gsm vty + ${FIND} ${WRKSRC}/doc/${i}/html -not -type d | ${SED} \ + 's,^${WRKSRC}/doc/${i}/html,${DOCSDIR_REL}/${i}/html,' >> ${TMPPLIST} +.endfor + +.include <bsd.port.mk> Added: head/devel/libosmocore/distinfo ============================================================================== --- /dev/null 00:00:00 1970 (empty, because file is newly added) +++ head/devel/libosmocore/distinfo Sun Aug 10 07:16:23 2014 (r364505) @@ -0,0 +1,2 @@ +SHA256 (libosmocore-0.6.6.tar.gz) = c76397a19a80ebd37c779247cab987187e4986eabb5cc017d8313d53def51946 +SIZE (libosmocore-0.6.6.tar.gz) = 507745 Added: head/devel/libosmocore/files/patch-Doxyfile.codec.in ============================================================================== --- /dev/null 00:00:00 1970 (empty, because file is newly added) +++ head/devel/libosmocore/files/patch-Doxyfile.codec.in Sun Aug 10 07:16:23 2014 (r364505) @@ -0,0 +1,3199 @@ +--- ./Doxyfile.codec.in.orig 2014-03-31 15:40:46.000000000 +0200 ++++ ./Doxyfile.codec.in 2014-08-10 08:28:34.000000000 +0200 +@@ -1,109 +1,129 @@ +-# Doxyfile 1.7.4 ++# Doxyfile 1.8.7 + + # This file describes the settings to be used by the documentation system + # doxygen (www.doxygen.org) for a project. + # +-# All text after a hash (#) is considered a comment and will be ignored. ++# All text after a double hash (##) is considered a comment and is placed in ++# front of the TAG it is preceding. ++# ++# All text after a single hash (#) is considered a comment and will be ignored. + # The format is: +-# TAG = value [value, ...] +-# For lists items can also be appended using: +-# TAG += value [value, ...] +-# Values that contain spaces should be placed between quotes (" "). ++# TAG = value [value, ...] ++# For lists, items can also be appended using: ++# TAG += value [value, ...] ++# Values that contain spaces should be placed between quotes (\" \"). + + #--------------------------------------------------------------------------- + # 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. ++# 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. ++# The default value is: UTF-8. + + DOXYFILE_ENCODING = UTF-8 + +-# The PROJECT_NAME tag is a single word (or a sequence of words surrounded +-# by quotes) that should identify the project. ++# The PROJECT_NAME tag is a single word (or a sequence of words surrounded by ++# double-quotes, unless you are using Doxywizard) that should identify the ++# project for which the documentation is generated. This name is used in the ++# title of most generated pages and in a few other places. ++# The default value is: My Project. + + PROJECT_NAME = libosmocodec + +-# The PROJECT_NUMBER tag can be used to enter a project or revision number. +-# This could be handy for archiving the generated documentation or +-# if some version control system is used. ++# The PROJECT_NUMBER tag can be used to enter a project or revision number. This ++# could be handy for archiving the generated documentation or if some version ++# control system is used. + + PROJECT_NUMBER = @VERSION@ + + # Using the PROJECT_BRIEF tag one can provide an optional one line description +-# for a project that appears at the top of each page and should give viewer +-# a quick idea about the purpose of the project. Keep the description short. ++# for a project that appears at the top of each page and should give viewer a ++# quick idea about the purpose of the project. Keep the description short. + + PROJECT_BRIEF = "Osmocom codec library" + +-# With the PROJECT_LOGO tag one can specify an logo or icon that is +-# included in the documentation. The maximum height of the logo should not +-# exceed 55 pixels and the maximum width should not exceed 200 pixels. +-# Doxygen will copy the logo to the output directory. ++# With the PROJECT_LOGO tag one can specify an logo or icon that is included in ++# the documentation. The maximum height of the logo should not exceed 55 pixels ++# and the maximum width should not exceed 200 pixels. Doxygen will copy the logo ++# to the output directory. + + PROJECT_LOGO = + +-# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) +-# base path where the generated documentation will be put. +-# If a relative path is entered, it will be relative to the location +-# where doxygen was started. If left blank the current directory will be used. ++# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) path ++# into which the generated documentation will be written. If a relative path is ++# entered, it will be relative to the location where doxygen was started. If ++# left blank the current directory will be used. + + OUTPUT_DIRECTORY = doc/codec + +-# If the CREATE_SUBDIRS tag is set to YES, then doxygen will create +-# 4096 sub-directories (in 2 levels) under the output directory of each output +-# format and will distribute the generated files over these directories. +-# Enabling this option can be useful when feeding doxygen a huge amount of +-# source files, where putting all generated files in the same directory would +-# otherwise cause performance problems for the file system. ++# If the CREATE_SUBDIRS tag is set to YES, then doxygen will create 4096 sub- ++# directories (in 2 levels) under the output directory of each output format and ++# will distribute the generated files over these directories. Enabling this ++# option can be useful when feeding doxygen a huge amount of source files, where ++# putting all generated files in the same directory would otherwise causes ++# performance problems for the file system. ++# The default value is: NO. + + CREATE_SUBDIRS = NO + ++# If the ALLOW_UNICODE_NAMES tag is set to YES, doxygen will allow non-ASCII ++# characters to appear in the names of generated files. If set to NO, non-ASCII ++# characters will be escaped, for example _xE3_x81_x84 will be used for Unicode ++# U+3044. ++# The default value is: NO. ++ ++ALLOW_UNICODE_NAMES = NO ++ + # The OUTPUT_LANGUAGE tag is used to specify the language in which all + # documentation generated by doxygen is written. Doxygen will use this + # 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, Esperanto, 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-Cyrillic, Slovak, +-# Slovene, Spanish, Swedish, Ukrainian, and Vietnamese. ++# Possible values are: Afrikaans, Arabic, Armenian, Brazilian, Catalan, Chinese, ++# Chinese-Traditional, Croatian, Czech, Danish, Dutch, English (United States), ++# Esperanto, Farsi (Persian), Finnish, French, German, Greek, Hungarian, ++# Indonesian, Italian, Japanese, Japanese-en (Japanese with English messages), ++# Korean, Korean-en (Korean with English messages), Latvian, Lithuanian, ++# Macedonian, Norwegian, Persian (Farsi), Polish, Portuguese, Romanian, Russian, ++# Serbian, Serbian-Cyrillic, Slovak, Slovene, Spanish, Swedish, Turkish, ++# Ukrainian and Vietnamese. ++# The default value is: English. + + OUTPUT_LANGUAGE = English + +-# If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will +-# include brief member descriptions after the members that are listed in +-# the file and class documentation (similar to JavaDoc). +-# Set to NO to disable this. ++# If the BRIEF_MEMBER_DESC tag is set to YES doxygen will include brief member ++# descriptions after the members that are listed in the file and class ++# documentation (similar to Javadoc). Set to NO to disable this. ++# The default value is: YES. + + 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 ++# If the REPEAT_BRIEF tag is set to YES 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. ++# The default value is: YES. + + REPEAT_BRIEF = YES + +-# This tag implements a quasi-intelligent brief description abbreviator +-# that is used to form the text in various listings. Each string +-# in this list, if found as the leading text of the brief description, will be +-# stripped from the text and the result after processing the whole list, is +-# used as the annotated text. Otherwise, the brief description is used as-is. +-# If left blank, the following values are used ("$name" is automatically +-# replaced with the name of the entity): "The $name class" "The $name widget" +-# "The $name file" "is" "provides" "specifies" "contains" +-# "represents" "a" "an" "the" ++# This tag implements a quasi-intelligent brief description abbreviator that is ++# used to form the text in various listings. Each string in this list, if found ++# as the leading text of the brief description, will be stripped from the text ++# and the result, after processing the whole list, is used as the annotated ++# text. Otherwise, the brief description is used as-is. If left blank, the ++# following values are used ($name is automatically replaced with the name of ++# the entity):The $name class, The $name widget, The $name file, is, provides, ++# specifies, contains, represents, a, an and the. + + ABBREVIATE_BRIEF = + + # If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then +-# Doxygen will generate a detailed section even if there is only a brief ++# doxygen will generate a detailed section even if there is only a brief + # description. ++# The default value is: NO. + + ALWAYS_DETAILED_SEC = NO + +@@ -111,153 +131,207 @@ + # inherited members of a class in the documentation of that class as if those + # members were ordinary class members. Constructors, destructors and assignment + # operators of the base classes will not be shown. ++# The default value is: NO. + + INLINE_INHERITED_MEMB = NO + +-# If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full +-# path before files name in the file list and in the header files. If set +-# to NO the shortest path that makes the file name unique will be used. ++# If the FULL_PATH_NAMES tag is set to YES doxygen will prepend the full path ++# before files name in the file list and in the header files. If set to NO the ++# shortest path that makes the file name unique will be used ++# The default value is: YES. + + FULL_PATH_NAMES = YES + +-# If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag +-# can be used to strip a user-defined part of the path. Stripping is +-# only done if one of the specified strings matches the left-hand part of +-# the path. The tag can be used to show relative paths in the file list. +-# If left blank the directory from which doxygen is run is used as the +-# path to strip. ++# The STRIP_FROM_PATH tag can be used to strip a user-defined part of the path. ++# Stripping is only done if one of the specified strings matches the left-hand ++# part of the path. The tag can be used to show relative paths in the file list. ++# If left blank the directory from which doxygen is run is used as the path to ++# strip. ++# ++# Note that you can specify absolute paths here, but also relative paths, which ++# will be relative from the directory where doxygen is started. ++# This tag requires that the tag FULL_PATH_NAMES is set to YES. + + STRIP_FROM_PATH = + +-# The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of +-# the path mentioned in the documentation of a class, which tells +-# the reader which header file to include in order to use a class. +-# If left blank only the name of the header file containing the class +-# definition is used. Otherwise one should specify the include paths that +-# are normally passed to the compiler using the -I flag. ++# The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of the ++# path mentioned in the documentation of a class, which tells the reader which ++# header file to include in order to use a class. If left blank only the name of ++# the header file containing the class definition is used. Otherwise one should ++# specify the list of include paths that are normally passed to the compiler ++# using the -I flag. + + STRIP_FROM_INC_PATH = + +-# If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter +-# (but less readable) file names. This can be useful if your file system +-# doesn't support long names like on DOS, Mac, or CD-ROM. ++# If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter (but ++# less readable) file names. This can be useful is your file systems doesn't ++# support long names like on DOS, Mac, or CD-ROM. ++# The default value is: NO. + + SHORT_NAMES = NO + +-# If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen +-# will interpret the first line (until the first dot) of a JavaDoc-style +-# comment as the brief description. If set to NO, the JavaDoc +-# comments will behave just like regular Qt-style comments +-# (thus requiring an explicit @brief command for a brief description.) ++# If the JAVADOC_AUTOBRIEF tag is set to YES then doxygen will interpret the ++# first line (until the first dot) of a Javadoc-style comment as the brief ++# description. If set to NO, the Javadoc-style will behave just like regular Qt- ++# style comments (thus requiring an explicit @brief command for a brief ++# description.) ++# The default value is: NO. + + JAVADOC_AUTOBRIEF = NO + +-# If the QT_AUTOBRIEF tag is set to YES then Doxygen will +-# interpret the first line (until the first dot) of a Qt-style +-# comment as the brief description. If set to NO, the comments +-# will behave just like regular Qt-style comments (thus requiring +-# an explicit \brief command for a brief description.) ++# If the QT_AUTOBRIEF tag is set to YES then doxygen will interpret the first ++# line (until the first dot) of a Qt-style comment as the brief description. If ++# set to NO, the Qt-style will behave just like regular Qt-style comments (thus ++# requiring an explicit \brief command for a brief description.) ++# The default value is: NO. + + QT_AUTOBRIEF = NO + +-# The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make Doxygen +-# treat a multi-line C++ special comment block (i.e. a block of //! or /// +-# comments) as a brief description. This used to be the default behaviour. +-# The new default is to treat a multi-line C++ comment block as a detailed +-# description. Set this tag to YES if you prefer the old behaviour instead. ++# The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make doxygen treat a ++# multi-line C++ special comment block (i.e. a block of //! or /// comments) as ++# a brief description. This used to be the default behavior. The new default is ++# to treat a multi-line C++ comment block as a detailed description. Set this ++# tag to YES if you prefer the old behavior instead. ++# ++# Note that setting this tag to YES also means that rational rose comments are ++# not recognized any more. ++# The default value is: NO. + + MULTILINE_CPP_IS_BRIEF = 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. ++# If the INHERIT_DOCS tag is set to YES then an undocumented member inherits the ++# documentation from any documented member that it re-implements. ++# The default value is: YES. + + INHERIT_DOCS = YES + +-# If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce +-# a new page for each member. If set to NO, the documentation of a member will +-# be part of the file/class/namespace that contains it. ++# If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce a ++# new page for each member. If set to NO, the documentation of a member will be ++# part of the file/class/namespace that contains it. ++# The default value is: NO. + + SEPARATE_MEMBER_PAGES = NO + +-# The TAB_SIZE tag can be used to set the number of spaces in a tab. +-# Doxygen uses this value to replace tabs by spaces in code fragments. ++# The TAB_SIZE tag can be used to set the number of spaces in a tab. Doxygen ++# uses this value to replace tabs by spaces in code fragments. ++# Minimum value: 1, maximum value: 16, default value: 4. + + TAB_SIZE = 8 + +-# This tag can be used to specify a number of aliases that acts +-# as commands in the documentation. An alias has the form "name=value". +-# For example adding "sideeffect=\par Side Effects:\n" will allow you to +-# put the command \sideeffect (or @sideeffect) in the documentation, which +-# will result in a user-defined paragraph with heading "Side Effects:". +-# You can put \n's in the value part of an alias to insert newlines. ++# This tag can be used to specify a number of aliases that act as commands in ++# the documentation. An alias has the form: ++# name=value ++# For example adding ++# "sideeffect=@par Side Effects:\n" ++# will allow you to put the command \sideeffect (or @sideeffect) in the ++# documentation, which will result in a user-defined paragraph with heading ++# "Side Effects:". You can put \n's in the value part of an alias to insert ++# newlines. + + ALIASES = + +-# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C +-# sources only. Doxygen will then generate output that is more tailored for C. +-# For instance, some of the names that are used will be different. The list +-# of all members will be omitted, etc. ++# This tag can be used to specify a number of word-keyword mappings (TCL only). ++# A mapping has the form "name=value". For example adding "class=itcl::class" ++# will allow you to use the command class in the itcl::class meaning. ++ ++TCL_SUBST = ++ ++# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources ++# only. Doxygen will then generate output that is more tailored for C. For ++# instance, some of the names that are used will be different. The list of all ++# members will be omitted, etc. ++# The default value is: NO. + + OPTIMIZE_OUTPUT_FOR_C = YES + +-# 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 or ++# Python sources only. Doxygen will then generate output that is more tailored ++# for that language. For instance, namespaces will be presented as packages, ++# qualified scopes will look different, etc. ++# The default value is: NO. + + OPTIMIZE_OUTPUT_JAVA = NO + + # 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. ++# sources. Doxygen will then generate output that is tailored for Fortran. ++# The default value is: NO. + + 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. ++# sources. Doxygen will then generate output that is tailored for VHDL. ++# The default value is: NO. + + 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, CSharp, 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. Note that for custom extensions +-# you also need to set FILE_PATTERNS otherwise the files are not read by doxygen. ++# 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 (fixed format Fortran: ++# FortranFixed, free formatted Fortran: FortranFree, unknown formatted Fortran: ++# Fortran. In the later case the parser tries to guess whether the code is fixed ++# or free formatted code, this is the default for Fortran type files), VHDL. 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. ++# ++# Note For files without extension you can use no_extension as a placeholder. ++# ++# Note that for custom extensions you also need to set FILE_PATTERNS otherwise ++# the files are not read by doxygen. + + EXTENSION_MAPPING = + ++# If the MARKDOWN_SUPPORT tag is enabled then doxygen pre-processes all comments ++# according to the Markdown format, which allows for more readable ++# documentation. See http://daringfireball.net/projects/markdown/ for details. ++# The output of markdown processing is further processed by doxygen, so you can ++# mix doxygen, HTML, and XML commands with Markdown formatting. Disable only in ++# case of backward compatibilities issues. ++# The default value is: YES. ++ ++MARKDOWN_SUPPORT = YES ++ ++# When enabled doxygen tries to link words that correspond to documented ++# classes, or namespaces to their corresponding documentation. Such a link can ++# be prevented in individual cases by by putting a % sign in front of the word ++# or globally by setting AUTOLINK_SUPPORT to NO. ++# The default value is: YES. ++ ++AUTOLINK_SUPPORT = YES ++ + # 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 makes the inheritance and collaboration ++# 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); ++# versus func(std::string) {}). This also make the inheritance and collaboration + # diagrams that involve STL classes more complete and accurate. ++# The default value is: NO. + + BUILTIN_STL_SUPPORT = NO + + # If you use Microsoft's C++/CLI language, you should set this option to YES to + # enable parsing support. ++# The default value is: NO. + + CPP_CLI_SUPPORT = NO + +-# Set the SIP_SUPPORT tag to YES if your project consists of sip sources only. +-# Doxygen will parse them like normal C++ but will assume all classes use public +-# instead of private inheritance when no explicit protection keyword is present. ++# Set the SIP_SUPPORT tag to YES if your project consists of sip (see: ++# http://www.riverbankcomputing.co.uk/software/sip/intro) sources only. Doxygen ++# will parse them like normal C++ but will assume all classes use public instead ++# of private inheritance when no explicit protection keyword is present. ++# The default value is: 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 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. ++# For Microsoft's IDL there are propget and propput attributes to indicate ++# getter and setter methods for a property. Setting this option to YES 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. ++# The default value is: YES. + + IDL_PROPERTY_SUPPORT = YES + +@@ -265,394 +339,472 @@ + # 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 + # all members of a group must be documented explicitly. ++# The default value is: NO. + + DISTRIBUTE_GROUP_DOC = NO + +-# Set the SUBGROUPING tag to YES (the default) to allow class member groups of +-# the same type (for instance a group of public functions) to be put as a +-# subgroup of that type (e.g. under the Public Functions section). Set it to +-# NO to prevent subgrouping. Alternatively, this can be done per class using +-# the \nosubgrouping command. ++# Set the SUBGROUPING tag to YES to allow class member groups of the same type ++# (for instance a group of public functions) to be put as a subgroup of that ++# type (e.g. under the Public Functions section). Set it to NO to prevent ++# subgrouping. Alternatively, this can be done per class using the ++# \nosubgrouping command. ++# The default value is: YES. + + SUBGROUPING = YES + +-# When the INLINE_GROUPED_CLASSES tag is set to YES, classes, structs and +-# unions are shown inside the group in which they are included (e.g. using +-# @ingroup) instead of on a separate page (for HTML and Man pages) or +-# section (for LaTeX and RTF). ++# When the INLINE_GROUPED_CLASSES tag is set to YES, classes, structs and unions ++# are shown inside the group in which they are included (e.g. using \ingroup) ++# instead of on a separate page (for HTML and Man pages) or section (for LaTeX ++# and RTF). ++# ++# Note that this feature does not work in combination with ++# SEPARATE_MEMBER_PAGES. ++# The default value is: NO. + + INLINE_GROUPED_CLASSES = NO + +-# 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 ++# When the INLINE_SIMPLE_STRUCTS tag is set to YES, structs, classes, and unions ++# with only public data fields or simple typedef fields will be shown inline in ++# the documentation of the scope in which they are defined (i.e. file, ++# namespace, or group documentation), provided this scope is documented. If set ++# to NO, structs, classes, and unions are shown on a separate page (for HTML and ++# Man pages) or section (for LaTeX and RTF). ++# The default value is: NO. ++ ++INLINE_SIMPLE_STRUCTS = NO ++ ++# When TYPEDEF_HIDES_STRUCT tag 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 in case the coding convention dictates that all compound ++# namespace, or class. And the struct will be named TypeS. This can typically 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. ++# The default value is: NO. + + 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 penalty. +-# 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 roughly 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 ++# The size of the symbol lookup cache can be set using LOOKUP_CACHE_SIZE. This ++# cache is used to resolve symbols given their name and scope. Since this can be ++# an expensive process and often the same symbol appears multiple times in the ++# code, doxygen keeps a cache of pre-resolved symbols. If the cache is too small ++# doxygen will become slower. If the cache is too large, memory is wasted. The ++# cache size is given by this formula: 2^(16+LOOKUP_CACHE_SIZE). The valid range ++# is 0..9, the default is 0, corresponding to a cache size of 2^16=65536 ++# symbols. At the end of a run doxygen will report the cache usage and suggest ++# the optimal cache size from a speed point of view. ++# Minimum value: 0, maximum value: 9, default value: 0. + +-SYMBOL_CACHE_SIZE = 0 ++LOOKUP_CACHE_SIZE = 0 + + #--------------------------------------------------------------------------- + # Build related configuration options + #--------------------------------------------------------------------------- + + # If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in +-# documentation are documented, even if no documentation was available. +-# Private class members and static file members will be hidden unless +-# the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES ++# documentation are documented, even if no documentation was available. Private ++# class members and static file members will be hidden unless the ++# EXTRACT_PRIVATE respectively EXTRACT_STATIC tags are set to YES. ++# Note: This will also disable the warnings about undocumented members that are ++# normally produced when WARNINGS is set to YES. ++# The default value is: NO. + + EXTRACT_ALL = NO + +-# If the EXTRACT_PRIVATE tag is set to YES all private members of a class +-# will be included in the documentation. ++# If the EXTRACT_PRIVATE tag is set to YES all private members of a class will ++# be included in the documentation. ++# The default value is: NO. + + EXTRACT_PRIVATE = NO + +-# If the EXTRACT_STATIC tag is set to YES all static members of a file +-# will be included in the documentation. ++# If the EXTRACT_PACKAGE tag is set to YES all members with package or internal ++# scope will be included in the documentation. ++# The default value is: NO. ++ ++EXTRACT_PACKAGE = NO ++ ++# If the EXTRACT_STATIC tag is set to YES all static members of a file will be ++# included in the documentation. ++# The default value is: NO. + + EXTRACT_STATIC = YES + +-# If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs) +-# defined locally in source files will be included in the documentation. +-# If set to NO only classes defined in header files are included. ++# If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs) defined ++# locally in source files will be included in the documentation. If set to NO ++# only classes defined in header files are included. Does not have any effect ++# for Java sources. ++# The default value is: YES. + + EXTRACT_LOCAL_CLASSES = YES + +-# This flag is only useful for Objective-C code. When set to YES local +-# methods, which are defined in the implementation section but not in +-# the interface are included in the documentation. +-# If set to NO (the default) only methods in the interface are included. ++# This flag is only useful for Objective-C code. When set to YES local methods, ++# which are defined in the implementation section but not in the interface are ++# included in the documentation. If set to NO only methods in the interface are ++# included. ++# The default value is: NO. + + 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 namespaces are hidden. ++# '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. ++# The default value is: NO. + + EXTRACT_ANON_NSPACES = NO + +-# If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all +-# undocumented members of documented classes, files or namespaces. +-# If set to NO (the default) these members will be included in the +-# various overviews, but no documentation section is generated. +-# This option has no effect if EXTRACT_ALL is enabled. ++# If the HIDE_UNDOC_MEMBERS tag is set to YES, doxygen will hide all ++# undocumented members inside documented classes or files. If set to NO these ++# members will be included in the various overviews, but no documentation ++# section is generated. This option has no effect if EXTRACT_ALL is enabled. ++# The default value is: NO. + + HIDE_UNDOC_MEMBERS = NO + +-# If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all +-# undocumented classes that are normally visible in the class hierarchy. +-# If set to NO (the default) these classes will be included in the various +-# overviews. This option has no effect if EXTRACT_ALL is enabled. ++# If the HIDE_UNDOC_CLASSES tag is set to YES, doxygen will hide all ++# undocumented classes that are normally visible in the class hierarchy. If set ++# to NO these classes will be included in the various overviews. This option has ++# no effect if EXTRACT_ALL is enabled. ++# The default value is: NO. + + HIDE_UNDOC_CLASSES = NO + +-# If the HIDE_FRIEND_COMPOUNDS tag is set to YES, Doxygen will hide all +-# friend (class|struct|union) declarations. +-# If set to NO (the default) these declarations will be included in the +-# documentation. ++# If the HIDE_FRIEND_COMPOUNDS tag is set to YES, doxygen will hide all friend ++# (class|struct|union) declarations. If set to NO these declarations will be ++# included in the documentation. ++# The default value is: NO. + + HIDE_FRIEND_COMPOUNDS = NO + +-# If the HIDE_IN_BODY_DOCS tag is set to YES, Doxygen will hide any +-# documentation blocks found inside the body of a function. +-# If set to NO (the default) these blocks will be appended to the +-# function's detailed documentation block. ++# If the HIDE_IN_BODY_DOCS tag is set to YES, doxygen will hide any ++# documentation blocks found inside the body of a function. If set to NO these ++# blocks will be appended to the function's detailed documentation block. ++# The default value is: NO. + + HIDE_IN_BODY_DOCS = NO + +-# The INTERNAL_DOCS tag determines if documentation +-# that is typed after a \internal command is included. If the tag is set +-# to NO (the default) then the documentation will be excluded. +-# Set it to YES to include the internal documentation. ++# The INTERNAL_DOCS tag determines if documentation that is typed after a ++# \internal command is included. If the tag is set to NO then the documentation ++# will be excluded. Set it to YES to include the internal documentation. ++# The default value is: NO. + + INTERNAL_DOCS = NO + +-# If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate +-# file names in lower-case letters. If set to YES upper-case letters are also ++# If the CASE_SENSE_NAMES tag is set to NO then doxygen will only generate file ++# names in lower-case letters. If set to YES upper-case letters are also + # allowed. This is useful if you have classes or files whose names only differ + # in case and if your file system supports case sensitive file names. Windows + # and Mac users are advised to set this option to NO. ++# The default value is: system dependent. + + CASE_SENSE_NAMES = YES + +-# If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen +-# will show members with their full class and namespace scopes in the +-# documentation. If set to YES the scope will be hidden. ++# If the HIDE_SCOPE_NAMES tag is set to NO then doxygen will show members with ++# their full class and namespace scopes in the documentation. If set to YES the ++# scope will be hidden. ++# The default value is: NO. + + HIDE_SCOPE_NAMES = NO + +-# If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen +-# will put a list of the files that are included by a file in the documentation +-# of that file. ++# If the SHOW_INCLUDE_FILES tag is set to YES then doxygen will put a list of ++# the files that are included by a file in the documentation of that file. ++# The default value is: YES. + + SHOW_INCLUDE_FILES = YES + +-# If the FORCE_LOCAL_INCLUDES tag is set to YES then Doxygen +-# will list include files with double quotes in the documentation +-# rather than with sharp brackets. ++# If the SHOW_GROUPED_MEMB_INC tag is set to YES then Doxygen will add for each ++# grouped member an include statement to the documentation, telling the reader ++# which file to include in order to use the member. ++# The default value is: NO. ++ ++SHOW_GROUPED_MEMB_INC = NO ++ ++# If the FORCE_LOCAL_INCLUDES tag is set to YES then doxygen will list include ++# files with double quotes in the documentation rather than with sharp brackets. ++# The default value is: NO. + + FORCE_LOCAL_INCLUDES = NO + +-# If the INLINE_INFO tag is set to YES (the default) then a tag [inline] +-# is inserted in the documentation for inline members. ++# If the INLINE_INFO tag is set to YES then a tag [inline] is inserted in the ++# documentation for inline members. ++# The default value is: YES. + + INLINE_INFO = YES + +-# If the SORT_MEMBER_DOCS tag is set to YES (the default) then doxygen +-# will sort the (detailed) documentation of file and class members +-# alphabetically by member name. If set to NO the members will appear in +-# declaration order. ++# If the SORT_MEMBER_DOCS tag is set to YES then doxygen will sort the ++# (detailed) documentation of file and class members alphabetically by member ++# name. If set to NO the members will appear in declaration order. ++# The default value is: YES. + + SORT_MEMBER_DOCS = YES + +-# If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the +-# brief documentation of file, namespace and class members alphabetically +-# by member name. If set to NO (the default) the members will appear in +-# declaration order. ++# If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the brief ++# descriptions of file, namespace and class members alphabetically by member ++# name. If set to NO the members will appear in declaration order. Note that ++# this will also influence the order of the classes in the class list. ++# The default value is: NO. + + SORT_BRIEF_DOCS = NO + +-# If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen +-# will sort the (brief and detailed) documentation of class members so that +-# constructors and destructors are listed first. If set to NO (the default) +-# the constructors will appear in the respective orders defined by +-# SORT_MEMBER_DOCS and SORT_BRIEF_DOCS. +-# This tag will be ignored for brief docs if SORT_BRIEF_DOCS is set to NO +-# and ignored for detailed docs if SORT_MEMBER_DOCS is set to NO. ++# If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen will sort the ++# (brief and detailed) documentation of class members so that constructors and ++# destructors are listed first. If set to NO the constructors will appear in the ++# respective orders defined by SORT_BRIEF_DOCS and SORT_MEMBER_DOCS. ++# Note: If SORT_BRIEF_DOCS is set to NO this option is ignored for sorting brief ++# member documentation. ++# Note: If SORT_MEMBER_DOCS is set to NO this option is ignored for sorting ++# detailed member documentation. ++# The default value is: NO. + + SORT_MEMBERS_CTORS_1ST = 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. ++# 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 group names will ++# appear in their defined order. ++# The default value is: NO. + + 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, +-# not including the namespace part. ++# 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 class list will ++# be sorted only by class name, not including the namespace part. + # Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES. +-# Note: This option applies only to the class list, not to the +-# alphabetical list. ++# Note: This option applies only to the class list, not to the alphabetical ++# list. ++# The default value is: NO. + + SORT_BY_SCOPE_NAME = NO + +-# If the STRICT_PROTO_MATCHING option is enabled and doxygen fails to +-# do proper type resolution of all parameters of a function it will reject a +-# match between the prototype and the implementation of a member function even +-# if there is only one candidate or it is obvious which candidate to choose +-# by doing a simple string match. By disabling STRICT_PROTO_MATCHING doxygen +-# will still accept a match between prototype and implementation in such cases. ++# If the STRICT_PROTO_MATCHING option is enabled and doxygen fails to do proper ++# type resolution of all parameters of a function it will reject a match between ++# the prototype and the implementation of a member function even if there is ++# only one candidate or it is obvious which candidate to choose by doing a ++# simple string match. By disabling STRICT_PROTO_MATCHING doxygen will still ++# accept a match between prototype and implementation in such cases. ++# The default value is: NO. + + STRICT_PROTO_MATCHING = NO + +-# The GENERATE_TODOLIST tag can be used to enable (YES) or +-# disable (NO) the todo list. This list is created by putting \todo +-# commands in the documentation. ++# The GENERATE_TODOLIST tag can be used to enable ( YES) or disable ( NO) the ++# todo list. This list is created by putting \todo commands in the ++# documentation. ++# The default value is: YES. + + GENERATE_TODOLIST = YES + +-# The GENERATE_TESTLIST tag can be used to enable (YES) or +-# disable (NO) the test list. This list is created by putting \test +-# commands in the documentation. ++# The GENERATE_TESTLIST tag can be used to enable ( YES) or disable ( NO) the ++# test list. This list is created by putting \test commands in the ++# documentation. ++# The default value is: YES. + + GENERATE_TESTLIST = YES + +-# The GENERATE_BUGLIST tag can be used to enable (YES) or +-# disable (NO) the bug list. This list is created by putting \bug +-# commands in the documentation. ++# The GENERATE_BUGLIST tag can be used to enable ( YES) or disable ( NO) the bug ++# list. This list is created by putting \bug commands in the documentation. ++# The default value is: YES. + + GENERATE_BUGLIST = YES + +-# The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or +-# disable (NO) the deprecated list. This list is created by putting +-# \deprecated commands in the documentation. ++# The GENERATE_DEPRECATEDLIST tag can be used to enable ( YES) or disable ( NO) ++# the deprecated list. This list is created by putting \deprecated commands in ++# the documentation. ++# The default value is: YES. + + GENERATE_DEPRECATEDLIST= YES + +-# The ENABLED_SECTIONS tag can be used to enable conditional +-# documentation sections, marked by \if sectionname ... \endif. ++# The ENABLED_SECTIONS tag can be used to enable conditional documentation ++# sections, marked by \if <section_label> ... \endif and \cond <section_label> ++# ... \endcond blocks. + + ENABLED_SECTIONS = + +-# The MAX_INITIALIZER_LINES tag determines the maximum number of lines +-# the initial value of a variable or macro consists of for it to appear in +-# the documentation. If the initializer consists of more lines than specified +-# here it will be hidden. Use a value of 0 to hide initializers completely. +-# The appearance of the initializer of individual variables and macros in the +-# documentation can be controlled using \showinitializer or \hideinitializer +-# command in the documentation regardless of this setting. ++# The MAX_INITIALIZER_LINES tag determines the maximum number of lines that the ++# initial value of a variable or macro / define can have for it to appear in the ++# documentation. If the initializer consists of more lines than specified here ++# it will be hidden. Use a value of 0 to hide initializers completely. The ++# appearance of the value of individual variables and macros / defines can be ++# controlled using \showinitializer or \hideinitializer command in the ++# documentation regardless of this setting. ++# Minimum value: 0, maximum value: 10000, default value: 30. + + MAX_INITIALIZER_LINES = 30 + +-# Set the SHOW_USED_FILES tag to NO to disable the list of files generated +-# at the bottom of the documentation of classes and structs. If set to YES the +-# list will mention the files that were used to generate the documentation. ++# Set the SHOW_USED_FILES tag to NO to disable the list of files generated at ++# the bottom of the documentation of classes and structs. If set to YES the list ++# will mention the files that were used to generate the documentation. ++# The default value is: YES. + + 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. +- +-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. ++# 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 value 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. ++# 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 value 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 +-# 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 *** DIFF OUTPUT TRUNCATED AT 1000 LINES ***
Want to link to this message? Use this URL: <https://mail-archive.FreeBSD.org/cgi/mid.cgi?53e71c48.2062.63d02076>