Doxyfile.java File Reference

Functions

namespace and class members
alphabetically by member name
If set to 		NO (the default) the members will appear inSORT_BRIEF_DOCS

Variables

 PROJECT_NAME
it will be relative to the location OUTPUT_DIRECTORY
it will be relative to the
location other supported
languages 		are
it will be relative to the
location other supported
languages 		Catalan
it will be relative to the
location other supported
languages 		Chinese
it will be relative to the
location other supported
languages Chinese 		Traditional
it will be relative to the
location other supported
languages Chinese 		Croatian
it will be relative to the
location other supported
languages Chinese 		Czech
it will be relative to the
location other supported
languages Chinese 		Danish
it will be relative to the
location other supported
languages Chinese 		Dutch
it will be relative to the
location other supported
languages Chinese 		OUTPUT_LANGUAGE
it will be relative to the
location other supported
languages Chinese 		USE_WINDOWS_ENCODING
it will be relative to the
location other supported
languages Chinese the 		REPEAT_BRIEF
it will be relative to the
location other supported
languages Chinese the if found
as the leading text of the
brief 		description
it will be relative to the
location other supported
languages Chinese the if found
as the leading text of the
brief will be 		ABBREVIATE_BRIEF
it will be relative to the
location other supported
languages Chinese the if found
as the leading text of the
brief will be doxygen will
show all inherited 		INLINE_INHERITED_MEMB
it will be relative to the
location other supported
languages Chinese the if found
as the leading text of the
brief will be doxygen will
show all inherited doxygen
will generate much shorter 		SHORT_NAMES
it will be relative to the
location other supported
languages Chinese the if found
as the leading text of the
brief will be doxygen will
show all inherited doxygen
will generate much shorter the
JavaDoc 		JAVADOC_AUTOBRIEF
it will be relative to the
location other supported
languages Chinese the if found
as the leading text of the
brief will be doxygen will
show all inherited doxygen
will generate much shorter the
JavaDoc like JavaDoc. 		DETAILS_AT_TOP
it will be relative to the
location other supported
languages Chinese the if found
as the leading text of the
brief will be doxygen will
show all inherited doxygen
will generate much shorter the
JavaDoc like JavaDoc.then
doxygen will reuse the
documentation of the first 		DISTRIBUTE_GROUP_DOC
it will be relative to the
location other supported
languages Chinese the if found
as the leading text of the
brief will be doxygen will
show all inherited doxygen
will generate much shorter the
JavaDoc like JavaDoc.then
doxygen will reuse the
documentation of the first
which 		ALIASES
it will be relative to the
location other supported
languages Chinese the if found
as the leading text of the
brief will be doxygen will
show all inherited doxygen
will generate much shorter the
JavaDoc like JavaDoc.then
doxygen will reuse the
documentation of the first
which some of the names that
are used will be different.The
list 		OPTIMIZE_OUTPUT_FOR_C
it will be relative to the
location other supported
languages Chinese the if found
as the leading text of the
brief will be doxygen will
show all inherited doxygen
will generate much shorter the
JavaDoc like JavaDoc.then
doxygen will reuse the
documentation of the first
which some of the names that
are used will be different.The
list namespaces will be
presented as 		packages
it will be relative to the
location other supported
languages Chinese the if found
as the leading text of the
brief will be doxygen will
show all inherited doxygen
will generate much shorter the
JavaDoc like JavaDoc.then
doxygen will reuse the
documentation of the first
which some of the names that
are used will be different.The
list namespaces will be
presented as qualified scopes 		OPTIMIZE_OUTPUT_JAVA
it will be relative to the
location other supported
languages Chinese the if found
as the leading text of the
brief will be doxygen will
show all inherited doxygen
will generate much shorter the
JavaDoc like JavaDoc.then
doxygen will reuse the
documentation of the first
which some of the names that
are used will be different.The
list namespaces will be
presented as qualified scopes
this can be done per class
using the nosubgrouping
command 		SUBGROUPING
it will be relative to the
location other supported
languages Chinese the if found
as the leading text of the
brief will be doxygen will
show all inherited doxygen
will generate much shorter the
JavaDoc like JavaDoc.then
doxygen will reuse the
documentation of the first
which some of the names that
are used will be different.The
list namespaces will be
presented as qualified scopes
this can be done per class
using the nosubgrouping
command even if no
documentation was available. 		EXTRACT_ALL
it will be relative to the
location other supported
languages Chinese the if found
as the leading text of the
brief will be doxygen will
show all inherited doxygen
will generate much shorter the
JavaDoc like JavaDoc.then
doxygen will reuse the
documentation of the first
which some of the names that
are used will be different.The
list namespaces will be
presented as qualified scopes
this can be done per class
using the nosubgrouping
command even if no
documentation was
available.Doxygen will hide
all 		HIDE_UNDOC_MEMBERS
it will be relative to the
location other supported
languages Chinese the if found
as the leading text of the
brief will be doxygen will
show all inherited doxygen
will generate much shorter the
JavaDoc like JavaDoc.then
doxygen will reuse the
documentation of the first
which some of the names that
are used will be different.The
list namespaces will be
presented as qualified scopes
this can be done per class
using the nosubgrouping
command even if no
documentation was
available.Doxygen will hide
all Doxygen will hide all 		HIDE_UNDOC_CLASSES
it will be relative to the
location other supported
languages Chinese the if found
as the leading text of the
brief will be doxygen will
show all inherited doxygen
will generate much shorter the
JavaDoc like JavaDoc.then
doxygen will reuse the
documentation of the first
which some of the names that
are used will be different.The
list namespaces will be
presented as qualified scopes
this can be done per class
using the nosubgrouping
command even if no
documentation was
available.Doxygen will hide
all Doxygen will hide all
Doxygen will hide all 		HIDE_FRIEND_COMPOUNDS
it will be relative to the
location other supported
languages Chinese the if found
as the leading text of the
brief will be doxygen will
show all inherited doxygen
will generate much shorter the
JavaDoc like JavaDoc.then
doxygen will reuse the
documentation of the first
which some of the names that
are used will be different.The
list namespaces will be
presented as qualified scopes
this can be done per class
using the nosubgrouping
command even if no
documentation was
available.Doxygen will hide
all Doxygen will hide all
Doxygen will hide all Doxygen
will hide any 		HIDE_IN_BODY_DOCS

Function Documentation

namespace and class members alphabetically by member name If set to the class list will be sorted by fully qualified names including namespaces If set to NO ( the  default  ) 
Type Constraints

Variable Documentation

it will be relative to the location other supported languages Chinese the if found as the leading text of the brief will be ABBREVIATE_BRIEF
Initial value:
 

# 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 
# description.

ALWAYS_DETAILED_SEC    = NO

# If the INLINE_INHERITED_MEMB tag is set to YES
it will be relative to the location other supported languages Chinese the if found as the leading text of the brief will be doxygen will show all inherited doxygen will generate much shorter the JavaDoc like JavaDoc.then doxygen will reuse the documentation of the first which ALIASES
Initial value:
 

# 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
it will be relative to the location other supported languages are
it will be relative to the location other supported languages Catalan
it will be relative to the location other supported languages Chinese
it will be relative to the location other supported languages Chinese Croatian
it will be relative to the location other supported languages Chinese Czech
it will be relative to the location other supported languages Chinese Danish
it will be relative to the location other supported languages Chinese the if found as the leading text of the brief description

Referenced by alma::acs::lasercore::test::stress::category::CategorySubscriber::adddAlarmView(), com::cosylab::acs::laser::dao::xml::SourceDefinitionType::setDescription(), and com::cosylab::acs::laser::dao::xml::CategoryDefinitionType::setDescription().

it will be relative to the location other supported languages Chinese the if found as the leading text of the brief will be doxygen will show all inherited doxygen will generate much shorter the JavaDoc like JavaDoc. DETAILS_AT_TOP
Initial value:
 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.

INHERIT_DOCS           = YES

# If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC 
# tag is set to YES
it will be relative to the location other supported languages Chinese the if found as the leading text of the brief will be doxygen will show all inherited doxygen will generate much shorter the JavaDoc like JavaDoc.then doxygen will reuse the documentation of the first DISTRIBUTE_GROUP_DOC
Initial value:
 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.

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
it will be relative to the location other supported languages Chinese Dutch
it will be relative to the location other supported languages Chinese the if found as the leading text of the brief will be doxygen will show all inherited doxygen will generate much shorter the JavaDoc like JavaDoc.then doxygen will reuse the documentation of the first which some of the names that are used will be different.The list namespaces will be presented as qualified scopes this can be done per class using the nosubgrouping command even if no documentation was available. EXTRACT_ALL
Initial value:
 YES

# If the EXTRACT_PRIVATE tag is set to YES all private members of a class 
# will be included in the documentation.

EXTRACT_PRIVATE        = YES

# If the EXTRACT_STATIC tag is set to YES all static members of a file 
# will be included in the documentation.

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.

EXTRACT_LOCAL_CLASSES  = YES

# If the HIDE_UNDOC_MEMBERS tag is set to YES
it will be relative to the location other supported languages Chinese the if found as the leading text of the brief will be doxygen will show all inherited doxygen will generate much shorter the JavaDoc like JavaDoc.then doxygen will reuse the documentation of the first which some of the names that are used will be different.The list namespaces will be presented as qualified scopes this can be done per class using the nosubgrouping command even if no documentation was available.Doxygen will hide all Doxygen will hide all Doxygen will hide all HIDE_FRIEND_COMPOUNDS
Initial value:
 NO

# If the HIDE_IN_BODY_DOCS tag is set to YES
it will be relative to the location other supported languages Chinese the if found as the leading text of the brief will be doxygen will show all inherited doxygen will generate much shorter the JavaDoc like JavaDoc.then doxygen will reuse the documentation of the first which some of the names that are used will be different.The list namespaces will be presented as qualified scopes this can be done per class using the nosubgrouping command even if no documentation was available.Doxygen will hide all Doxygen will hide all Doxygen will hide all Doxygen will hide any HIDE_IN_BODY_DOCS
it will be relative to the location other supported languages Chinese the if found as the leading text of the brief will be doxygen will show all inherited doxygen will generate much shorter the JavaDoc like JavaDoc.then doxygen will reuse the documentation of the first which some of the names that are used will be different.The list namespaces will be presented as qualified scopes this can be done per class using the nosubgrouping command even if no documentation was available.Doxygen will hide all Doxygen will hide all HIDE_UNDOC_CLASSES
Initial value:
 NO

# If the HIDE_FRIEND_COMPOUNDS tag is set to YES
it will be relative to the location other supported languages Chinese the if found as the leading text of the brief will be doxygen will show all inherited doxygen will generate much shorter the JavaDoc like JavaDoc.then doxygen will reuse the documentation of the first which some of the names that are used will be different.The list namespaces will be presented as qualified scopes this can be done per class using the nosubgrouping command even if no documentation was available.Doxygen will hide all HIDE_UNDOC_MEMBERS
Initial value:
 NO

# If the HIDE_UNDOC_CLASSES tag is set to YES
it will be relative to the location other supported languages Chinese the if found as the leading text of the brief will be doxygen will show all inherited INLINE_INHERITED_MEMB
Initial value:
 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.

FULL_PATH_NAMES        = NO

# 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. It is allowed to use relative paths in the argument list. 
# If left blank the directory from which doxygen is run is used as the 
# path to strip.

STRIP_FROM_PATH        = 

# If the SHORT_NAMES tag is set to YES
it will be relative to the location other supported languages Chinese the if found as the leading text of the brief will be doxygen will show all inherited doxygen will generate much shorter the JavaDoc JAVADOC_AUTOBRIEF
Initial value:
 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 
# 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.

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
it will be relative to the location other supported languages Chinese the if found as the leading text of the brief will be doxygen will show all inherited doxygen will generate much shorter the JavaDoc like JavaDoc.then doxygen will reuse the documentation of the first which some of the names that are used will be different.The list OPTIMIZE_OUTPUT_FOR_C
Initial value:
 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
it will be relative to the location other supported languages Chinese the if found as the leading text of the brief will be doxygen will show all inherited doxygen will generate much shorter the JavaDoc like JavaDoc.then doxygen will reuse the documentation of the first which some of the names that are used will be different.The list namespaces will be presented as qualified scopes OPTIMIZE_OUTPUT_JAVA
Initial value:
 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
it will be relative to the location OUTPUT_DIRECTORY
Initial value:
 man

# 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
it will be relative to the location other supported languages Chinese OUTPUT_LANGUAGE
Initial value:
 English

# This tag can be used to specify the encoding used in the generated output. 
# The encoding is not always determined by the language that is chosen
it will be relative to the location other supported languages Chinese the if found as the leading text of the brief will be doxygen will show all inherited doxygen will generate much shorter the JavaDoc like JavaDoc.then doxygen will reuse the documentation of the first which some of the names that are used will be different.The list namespaces will be presented as packages
PROJECT_NAME
Initial value:
 "ACS Java API"

# 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         = "@(#) $Id: Doxyfile.java,v 1.6 2005/03/10 08:57:45 gchiozzi Exp $"

# 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 other supported languages Chinese the REPEAT_BRIEF
Initial value:
 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
it will be relative to the location other supported languages Chinese the if found as the leading text of the brief will be doxygen will show all inherited doxygen will generate much shorter SHORT_NAMES
Initial value:
 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
it will be relative to the location other supported languages Chinese the if found as the leading text of the brief will be doxygen will show all inherited doxygen will generate much shorter the JavaDoc like JavaDoc.then doxygen will reuse the documentation of the first which some of the names that are used will be different.The list namespaces will be presented as qualified scopes this can be done per class using the nosubgrouping command SUBGROUPING
Initial value:
 YES

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

# If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in 
# documentation are documented
it will be relative to the location other supported languages Chinese Traditional
it will be relative to the location other supported languages Chinese USE_WINDOWS_ENCODING
Initial value:
 NO

# 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.

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
Generated by  doxygen 1.6.2