linux tutorial c++ coding style, standards and practices.mht

linux下c++编程的好文章

# explicit @brief command for a brief description.

<B>JAVADOC_AUTOBRIEF      =3D YES</B>

# The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make Doxygen=20
# treat a multi-line C++ special comment block (i.e. a block of //! or =
///=20
# comments) as a brief description. This used to be the default =
behaviour.=20
# The new default is to treat a multi-line C++ comment block as a =
detailed=20
# description. Set this tag to YES if you prefer the old behaviour =
instead.

MULTILINE_CPP_IS_BRIEF =3D NO

# If the DETAILS_AT_TOP tag is set to YES then Doxygen=20
# will output the detailed description near the top, like JavaDoc.
# If set to NO, the detailed description appears after the member=20
# documentation.

DETAILS_AT_TOP         =3D NO

# If the INHERIT_DOCS tag is set to YES (the default) then an =
undocumented=20
# member inherits the documentation from any documented member that it=20
# re-implements.

INHERIT_DOCS           =3D YES

# If member grouping is used in the documentation and the =
DISTRIBUTE_GROUP_DOC=20
# tag is set to YES, then doxygen will reuse the documentation of the =
first=20
# member in the group (if any) for the other members of the group. By =
default=20
# all members of a group must be documented explicitly.

DISTRIBUTE_GROUP_DOC   =3D NO

# If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will =
produce=20
# a new page for each member. If set to NO, the documentation of a =
member will=20
# be part of the file/class/namespace that contains it.

SEPARATE_MEMBER_PAGES  =3D NO

# The TAB_SIZE tag can be used to set the number of spaces in a tab.=20
# Doxygen uses this value to replace tabs by spaces in code fragments.

TAB_SIZE               =3D 8

# This tag can be used to specify a number of aliases that acts=20
# as commands in the documentation. An alias has the form =
"name=3Dvalue".=20
# For example adding "sideeffect=3D\par Side Effects:\n" will allow you =
to=20
# put the command \sideeffect (or @sideeffect) in the documentation, =
which=20
# will result in a user-defined paragraph with heading "Side Effects:".=20
# You can put \n's in the value part of an alias to insert newlines.

ALIASES                =3D=20

# 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.=20
# For instance, some of the names that are used will be different. The =
list=20
# of all members will be omitted, etc.

OPTIMIZE_OUTPUT_FOR_C  =3D NO

# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of =
Java sources=20
# only. Doxygen will then generate output that is more tailored for =
Java.=20
# For instance, namespaces will be presented as packages, qualified =
scopes=20
# will look different, etc.

OPTIMIZE_OUTPUT_JAVA   =3D NO

# Set the SUBGROUPING tag to YES (the default) to allow class member =
groups of=20
# the same type (for instance a group of public functions) to be put as =
a=20
# subgroup of that type (e.g. under the Public Functions section). Set =
it to=20
# NO to prevent subgrouping. Alternatively, this can be done per class =
using=20
# the \nosubgrouping command.

SUBGROUPING            =3D YES

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

# If the EXTRACT_ALL tag is set to YES doxygen will assume all entities =
in=20
# documentation are documented, even if no documentation was available.=20
# Private class members and static file members will be hidden unless=20
# the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES

<B>EXTRACT_ALL            =3D YES</B>

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

EXTRACT_PRIVATE        =3D NO

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

EXTRACT_STATIC         =3D NO

# If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs)=20
# 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  =3D YES

# This flag is only useful for Objective-C code. When set to YES local=20
# methods, which are defined in the implementation section but not in=20
# the interface are included in the documentation.=20
# If set to NO (the default) only methods in the interface are included.

EXTRACT_LOCAL_METHODS  =3D NO

# If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all=20
# undocumented members of documented classes, files or namespaces.=20
# If set to NO (the default) these members will be included in the=20
# various overviews, but no documentation section is generated.=20
# This option has no effect if EXTRACT_ALL is enabled.

HIDE_UNDOC_MEMBERS     =3D NO

# If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all=20
# undocumented classes that are normally visible in the class hierarchy. =

# If set to NO (the default) these classes will be included in the =
various=20
# overviews. This option has no effect if EXTRACT_ALL is enabled.

HIDE_UNDOC_CLASSES     =3D NO

# If the HIDE_FRIEND_COMPOUNDS tag is set to YES, Doxygen will hide all=20
# friend (class|struct|union) declarations.=20
# If set to NO (the default) these declarations will be included in the=20
# documentation.

HIDE_FRIEND_COMPOUNDS  =3D NO

# If the HIDE_IN_BODY_DOCS tag is set to YES, Doxygen will hide any=20
# documentation blocks found inside the body of a function.=20
# If set to NO (the default) these blocks will be appended to the=20
# function's detailed documentation block.

HIDE_IN_BODY_DOCS      =3D NO

# The INTERNAL_DOCS tag determines if documentation=20
# that is typed after a \internal command is included. If the tag is set =

# to NO (the default) then the documentation will be excluded.=20
# Set it to YES to include the internal documentation.

INTERNAL_DOCS          =3D NO

# If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only =
generate=20
# file names in lower-case letters. If set to YES upper-case letters are =
also=20
# allowed. This is useful if you have classes or files whose names only =
differ=20
# in case and if your file system supports case sensitive file names. =
Windows=20
# and Mac users are advised to set this option to NO.

CASE_SENSE_NAMES       =3D YES

# If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen=20
# will show members with their full class and namespace scopes in the=20
# documentation. If set to YES the scope will be hidden.

HIDE_SCOPE_NAMES       =3D 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=20
# of that file.

SHOW_INCLUDE_FILES     =3D YES

# If the INLINE_INFO tag is set to YES (the default) then a tag [inline] =

# is inserted in the documentation for inline members.

INLINE_INFO            =3D YES

# If the SORT_MEMBER_DOCS tag is set to YES (the default) then doxygen=20
# will sort the (detailed) documentation of file and class members=20
# alphabetically by member name. If set to NO the members will appear in =

# declaration order.

SORT_MEMBER_DOCS       =3D YES

# If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the=20
# brief documentation of file, namespace and class members =
alphabetically=20
# by member name. If set to NO (the default) the members will appear in=20
# declaration order.

SORT_BRIEF_DOCS        =3D NO

# If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be=20
# sorted by fully-qualified names, including namespaces. If set to=20
# NO (the default), the class list will be sorted only by class name,=20
# not including the namespace part.=20
# 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=20
# alphabetical list.

SORT_BY_SCOPE_NAME     =3D NO

# The GENERATE_TODOLIST tag can be used to enable (YES) or=20
# disable (NO) the todo list. This list is created by putting \todo=20
# commands in the documentation.

GENERATE_TODOLIST      =3D YES

# The GENERATE_TESTLIST tag can be used to enable (YES) or=20
# disable (NO) the test list. This list is created by putting \test=20
# commands in the documentation.

GENERATE_TESTLIST      =3D YES

# The GENERATE_BUGLIST tag can be used to enable (YES) or=20
# disable (NO) the bug list. This list is created by putting \bug=20
# commands in the documentation.

GENERATE_BUGLIST       =3D YES

# The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or=20
# disable (NO) the deprecated list. This list is created by putting=20
# \deprecated commands in the documentation.

GENERATE_DEPRECATEDLIST=3D YES

# The ENABLED_SECTIONS tag can be used to enable conditional=20
# documentation sections, marked by \if sectionname ... \endif.

ENABLED_SECTIONS       =3D=20

# The MAX_INITIALIZER_LINES tag determines the maximum number of lines=20
# the initial value of a variable or define consists of for it to appear =
in=20
# the documentation. If the initializer consists of more lines than =
specified=20
# here it will be hidden. Use a value of 0 to hide initializers =
completely.=20
# The appearance of the initializer of individual variables and defines =
in the=20
# documentation can be controlled using \showinitializer or =
\hideinitializer=20
# command in the documentation regardless of this setting.

MAX_INITIALIZER_LINES  =3D 30

# Set the SHOW_USED_FILES tag to NO to disable the list of files =
generated=20
# at the bottom of the documentation of classes and structs. If set to =
YES the=20
# list will mention the files that were used to generate the =
documentation.

SHOW_USED_FILES        =3D YES

# If the sources in your project are distributed over multiple =
directories=20
# then setting the SHOW_DIRECTORIES tag to YES will show the directory =
hierarchy=20
# in the documentation. The default is YES.

SHOW_DIRECTORIES       =3D YES

# The FILE_VERSION_FILTER tag can be used to specify a program or script =
that=20
# doxygen should invoke to get the current version for each file =
(typically from the=20
# version control system). Doxygen will invoke the program by executing =
(via=20
# popen()) the command <COMMAND> <INPUT-FILE>, where <COMMAND> is the =
value of=20
# the FILE_VERSION_FILTER tag, and <INPUT-FILE> is the name of an input =
file=20
# provided by doxygen. Whatever the progam writes to standard output=20
# is used as the file version. See the manual for examples.

FILE_VERSION_FILTER    =3D=20

#------------------------------------------------------------------------=
---
# configuration options related to warning and progress messages
#------------------------------------------------------------------------=
---

# The QUIET tag can be used to turn on/off the messages that are =
generated=20
# by doxygen. Possible values are YES and NO. If left blank NO is used.

QUIET                  =3D NO
WARNINGS               =3D YES
WARN_IF_UNDOCUMENTED   =3D YES
WARN_IF_DOC_ERROR      =3D YES
WARN_NO_PARAMDOC       =3D NO
WARN_FORMAT            =3D "$file:$line: $text"
WARN_LOGFILE           =3D=20

#------------------------------------------------------------------------=
---
# configuration options related to the input files
#------------------------------------------------------------------------=
---

# The INPUT tag can be used to specify the files and/or directories that =
contain=20
# documented source files. You may enter file names like "myfile.cpp" or =

# directories like "/usr/src/myproject". Separate the files or =
directories=20
# with spaces.

INPUT                  =3D=20

# If the value of the INPUT tag contains directories, you can use the=20
# FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp=20
# and *.h) to filter out the source-files in the directories. If left=20
# blank the following patterns are tested:=20
# *.c *.cc *.cxx *.cpp *.c++ *.java *.ii *.ixx *.ipp *.i++ *.inl *.h =
*.hh *.hxx=20
# *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm

FILE_PATTERNS          =3D=20

# The RECURSIVE tag can be used to turn specify whether or not =
subdirectories=20
# should be searched for input files as well. Possible values are YES =
and NO.=20
# If left blank NO is used.

RECURSIVE              =3D NO

# The EXCLUDE tag can be used to specify files and/or directories that =
should=20
# excluded from the INPUT source files. This way you can easily exclude =
a=20
# subdirectory from a directory tree whose root is specified with the =
INPUT tag.

EXCLUDE                =3D=20

# The EXCLUDE_SYMLINKS tag can be used select whether or not files or=20
# directories that are symbolic links (a Unix filesystem feature) are =
excluded=20
# from the input.