libqb/docs/man.dox.in - actifio - Git at Google

 # Doxyfile 1.8.10

 @INCLUDE               = common.dox

 #---------------------------------------------------------------------------
 # Build related configuration options
 #---------------------------------------------------------------------------

 # 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      = NO

 # 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      = NO

 # 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       = NO

 # 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

 #---------------------------------------------------------------------------
 # Configuration options related to the input files
 #---------------------------------------------------------------------------

 # The EXAMPLE_PATH tag can be used to specify one or more files or directories
 # that contain example code fragments that are included (see the \include
 # command).

 #EXAMPLE_PATH           =

 # 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 and
 # *.h) to filter out the source-files in the directories. If left blank all
 # files are included.

 #EXAMPLE_PATTERNS       =

 # If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be
 # searched for input files to be used with the \include or \dontinclude commands
 # irrespective of the value of the RECURSIVE tag.
 # The default value is: NO.

 #EXAMPLE_RECURSIVE      = NO

 #---------------------------------------------------------------------------
 # Configuration options related to the man page output
 #---------------------------------------------------------------------------

 # If the GENERATE_MAN tag is set to YES, doxygen will generate man pages for
 # classes and files.
 # The default value is: NO.

 GENERATE_MAN           = YES

 # The MAN_OUTPUT tag is used to specify where the man pages will be put. If a
 # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
 # it. A directory man3 will be created inside the directory specified by
 # MAN_OUTPUT.
 # The default directory is: man.
 # This tag requires that the tag GENERATE_MAN is set to YES.

 MAN_OUTPUT             = .

 # The MAN_EXTENSION tag determines the extension that is added to the generated
 # man pages. In case the manual section does not start with a number, the number
 # 3 is prepended. The dot (.) at the beginning of the MAN_EXTENSION tag is
 # optional.
 # The default value is: .3.
 # This tag requires that the tag GENERATE_MAN is set to YES.

 #MAN_EXTENSION          = .3

 # The MAN_SUBDIR tag determines the name of the directory created within
 # MAN_OUTPUT in which the man pages are placed. If defaults to man followed by
 # MAN_EXTENSION with the initial . removed.
 # This tag requires that the tag GENERATE_MAN is set to YES.

 #MAN_SUBDIR             =

 # If the MAN_LINKS tag is set to YES and doxygen generates man output, then it
 # will generate one additional man file for each entity documented in the real
 # man page(s). These additional files only source the real man page, but without
 # them the man command would be unable to find the correct page.
 # The default value is: NO.
 # This tag requires that the tag GENERATE_MAN is set to YES.

 MAN_LINKS              = YES

 #---------------------------------------------------------------------------
 # Configuration options related to the preprocessor
 #---------------------------------------------------------------------------

 # If the ENABLE_PREPROCESSING tag is set to YES, doxygen will evaluate all
 # C-preprocessor directives found in the sources and include files.
 # The default value is: YES.

 #ENABLE_PREPROCESSING   = YES

 # If the MACRO_EXPANSION tag is set to YES, doxygen will expand all macro names
 # in the source code. If set to NO, only conditional compilation will be
 # performed. Macro expansion can be done in a controlled way by setting
 # EXPAND_ONLY_PREDEF to YES.
 # The default value is: NO.
 # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.

 #MACRO_EXPANSION        = NO

 # If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES then
 # the macro expansion is limited to the macros specified with the PREDEFINED and
 # EXPAND_AS_DEFINED tags.
 # The default value is: NO.
 # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.

 EXPAND_ONLY_PREDEF     = YES

 # If the SEARCH_INCLUDES tag is set to YES, the include files in the
 # INCLUDE_PATH will be searched if a #include is found.
 # The default value is: YES.
 # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.

 #SEARCH_INCLUDES        = YES

 # The INCLUDE_PATH tag can be used to specify one or more directories that
 # contain include files that are not input files but should be processed by the
 # preprocessor.
 # This tag requires that the tag SEARCH_INCLUDES is set to YES.

 INCLUDE_PATH           = @srcdir@/../include

 # You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard
 # patterns (like *.h and *.hpp) to filter out the header-files in the
 # directories. If left blank, the patterns specified with FILE_PATTERNS will be
 # used.
 # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.

 INCLUDE_FILE_PATTERNS  = *.h

 # The PREDEFINED tag can be used to specify one or more macro names that are
 # defined before the preprocessor is started (similar to the -D option of e.g.
 # gcc). The argument of the tag is a list of macros of the form: name or
 # name=definition (no spaces). If the definition and the "=" are omitted, "=1"
 # is assumed. To prevent a macro definition from being undefined via #undef or
 # recursively expanded use the := operator instead of the = operator.
 # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.

 #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 that overrules the
 # definition found in the source code.
 # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.

 #EXPAND_AS_DEFINED      =

 # If the SKIP_FUNCTION_MACROS tag is set to YES then doxygen's preprocessor will
 # remove all references to function-like macros that are alone on a line, have
 # an all uppercase name, and do not end with a semicolon. Such function macros
 # are typically used for boiler-plate code, and will confuse the parser if not
 # removed.
 # The default value is: YES.
 # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.

 SKIP_FUNCTION_MACROS   = NO

 #---------------------------------------------------------------------------
 # Configuration options related to the dot tool
 #---------------------------------------------------------------------------

 # If the CLASS_DIAGRAMS tag is set to YES, doxygen will generate a class diagram
 # (in HTML and LaTeX) for classes with base or super classes. Setting the tag to
 # NO turns the diagrams off. Note that this option also works with HAVE_DOT
 # disabled, but it is recommended to install and use dot, since it yields more
 # powerful graphs.
 # The default value is: YES.

 CLASS_DIAGRAMS         = NO

 # If set to YES the inheritance and collaboration graphs will hide inheritance
 # and usage relations if the target is undocumented or is not a class.
 # The default value is: YES.

 #HIDE_UNDOC_RELATIONS   = YES

 # If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is
 # available from the path. This tool is part of Graphviz (see:
 # http://www.graphviz.org/), a graph visualization 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 value is: NO.

 #HAVE_DOT               = NO

 # [DOT options stripped]
	# Doxyfile 1.8.10

	@INCLUDE = common.dox

	#---------------------------------------------------------------------------
	# Build related configuration options
	#---------------------------------------------------------------------------

	# 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 = NO

	# 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 = NO

	# 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 = NO

	# 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

	#---------------------------------------------------------------------------
	# Configuration options related to the input files
	#---------------------------------------------------------------------------

	# The EXAMPLE_PATH tag can be used to specify one or more files or directories
	# that contain example code fragments that are included (see the \include
	# command).

	#EXAMPLE_PATH =

	# 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 and
	# *.h) to filter out the source-files in the directories. If left blank all
	# files are included.

	#EXAMPLE_PATTERNS =

	# If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be
	# searched for input files to be used with the \include or \dontinclude commands
	# irrespective of the value of the RECURSIVE tag.
	# The default value is: NO.

	#EXAMPLE_RECURSIVE = NO

	#---------------------------------------------------------------------------
	# Configuration options related to the man page output
	#---------------------------------------------------------------------------

	# If the GENERATE_MAN tag is set to YES, doxygen will generate man pages for
	# classes and files.
	# The default value is: NO.

	GENERATE_MAN = YES

	# The MAN_OUTPUT tag is used to specify where the man pages will be put. If a
	# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
	# it. A directory man3 will be created inside the directory specified by
	# MAN_OUTPUT.
	# The default directory is: man.
	# This tag requires that the tag GENERATE_MAN is set to YES.

	MAN_OUTPUT = .

	# The MAN_EXTENSION tag determines the extension that is added to the generated
	# man pages. In case the manual section does not start with a number, the number
	# 3 is prepended. The dot (.) at the beginning of the MAN_EXTENSION tag is
	# optional.
	# The default value is: .3.
	# This tag requires that the tag GENERATE_MAN is set to YES.

	#MAN_EXTENSION = .3

	# The MAN_SUBDIR tag determines the name of the directory created within
	# MAN_OUTPUT in which the man pages are placed. If defaults to man followed by
	# MAN_EXTENSION with the initial . removed.
	# This tag requires that the tag GENERATE_MAN is set to YES.

	#MAN_SUBDIR =

	# If the MAN_LINKS tag is set to YES and doxygen generates man output, then it
	# will generate one additional man file for each entity documented in the real
	# man page(s). These additional files only source the real man page, but without
	# them the man command would be unable to find the correct page.
	# The default value is: NO.
	# This tag requires that the tag GENERATE_MAN is set to YES.

	MAN_LINKS = YES

	#---------------------------------------------------------------------------
	# Configuration options related to the preprocessor
	#---------------------------------------------------------------------------

	# If the ENABLE_PREPROCESSING tag is set to YES, doxygen will evaluate all
	# C-preprocessor directives found in the sources and include files.
	# The default value is: YES.

	#ENABLE_PREPROCESSING = YES

	# If the MACRO_EXPANSION tag is set to YES, doxygen will expand all macro names
	# in the source code. If set to NO, only conditional compilation will be
	# performed. Macro expansion can be done in a controlled way by setting
	# EXPAND_ONLY_PREDEF to YES.
	# The default value is: NO.
	# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.

	#MACRO_EXPANSION = NO

	# If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES then
	# the macro expansion is limited to the macros specified with the PREDEFINED and
	# EXPAND_AS_DEFINED tags.
	# The default value is: NO.
	# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.

	EXPAND_ONLY_PREDEF = YES

	# If the SEARCH_INCLUDES tag is set to YES, the include files in the
	# INCLUDE_PATH will be searched if a #include is found.
	# The default value is: YES.
	# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.

	#SEARCH_INCLUDES = YES

	# The INCLUDE_PATH tag can be used to specify one or more directories that
	# contain include files that are not input files but should be processed by the
	# preprocessor.
	# This tag requires that the tag SEARCH_INCLUDES is set to YES.

	INCLUDE_PATH = @srcdir@/../include

	# You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard
	# patterns (like .h and .hpp) to filter out the header-files in the
	# directories. If left blank, the patterns specified with FILE_PATTERNS will be
	# used.
	# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.

	INCLUDE_FILE_PATTERNS = *.h

	# The PREDEFINED tag can be used to specify one or more macro names that are
	# defined before the preprocessor is started (similar to the -D option of e.g.
	# gcc). The argument of the tag is a list of macros of the form: name or
	# name=definition (no spaces). If the definition and the "=" are omitted, "=1"
	# is assumed. To prevent a macro definition from being undefined via #undef or
	# recursively expanded use the := operator instead of the = operator.
	# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.

	#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 that overrules the
	# definition found in the source code.
	# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.

	#EXPAND_AS_DEFINED =

	# If the SKIP_FUNCTION_MACROS tag is set to YES then doxygen's preprocessor will
	# remove all references to function-like macros that are alone on a line, have
	# an all uppercase name, and do not end with a semicolon. Such function macros
	# are typically used for boiler-plate code, and will confuse the parser if not
	# removed.
	# The default value is: YES.
	# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.

	SKIP_FUNCTION_MACROS = NO

	#---------------------------------------------------------------------------
	# Configuration options related to the dot tool
	#---------------------------------------------------------------------------

	# If the CLASS_DIAGRAMS tag is set to YES, doxygen will generate a class diagram
	# (in HTML and LaTeX) for classes with base or super classes. Setting the tag to
	# NO turns the diagrams off. Note that this option also works with HAVE_DOT
	# disabled, but it is recommended to install and use dot, since it yields more
	# powerful graphs.
	# The default value is: YES.

	CLASS_DIAGRAMS = NO

	# If set to YES the inheritance and collaboration graphs will hide inheritance
	# and usage relations if the target is undocumented or is not a class.
	# The default value is: YES.

	#HIDE_UNDOC_RELATIONS = YES

	# If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is
	# available from the path. This tool is part of Graphviz (see:
	# http://www.graphviz.org/), a graph visualization 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 value is: NO.

	#HAVE_DOT = NO

	# [DOT options stripped]