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

linux下c++编程的好文章

EXCLUDE_SYMLINKS       =3D NO

# If the value of the INPUT tag contains directories, you can use the=20
# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to =
exclude=20
# certain files from those directories. Note that the wildcards are =
matched=20
# against the file with absolute path, so to exclude all test =
directories=20
# for example use the pattern */test/*

EXCLUDE_PATTERNS       =3D=20

# The EXAMPLE_PATH tag can be used to specify one or more files or=20
# directories that contain example code fragments that are included (see =

# the \include command).

EXAMPLE_PATH           =3D=20

# If the value of the EXAMPLE_PATH tag contains directories, you can use =
the=20
# EXAMPLE_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 all files are included.

EXAMPLE_PATTERNS       =3D=20

# 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=20
# commands irrespective of the value of the RECURSIVE tag.=20
# Possible values are YES and NO. If left blank NO is used.

EXAMPLE_RECURSIVE      =3D NO

# The IMAGE_PATH tag can be used to specify one or more files or=20
# directories that contain image that are included in the documentation =
(see=20
# the \image command).

IMAGE_PATH             =3D=20

# The INPUT_FILTER tag can be used to specify a program that doxygen =
should=20
# invoke to filter for each input file. Doxygen will invoke the filter =
program=20
# by executing (via popen()) the command <FILTER> <INPUT-FILE>, where =
<FILTER>=20
# is the value of the INPUT_FILTER tag, and <INPUT-FILE> is the name of =
an=20
# input file. Doxygen will then use the output that the filter program =
writes=20
# to standard output.  If FILTER_PATTERNS is specified, this tag will be =

# ignored.

INPUT_FILTER           =3D=20

# The FILTER_PATTERNS tag can be used to specify filters on a per file =
pattern=20
# basis.  Doxygen will compare the file name with each pattern and apply =
the=20
# filter if there is a match.  The filters are a list of the form:=20
# pattern=3Dfilter (like *.cpp=3Dmy_cpp_filter). See INPUT_FILTER for =
further=20
# info on how filters are used. If FILTER_PATTERNS is empty, =
INPUT_FILTER=20
# is applied to all files.

FILTER_PATTERNS        =3D=20

# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set =
using=20
# INPUT_FILTER) will be used to filter the input files when producing =
source=20
# files to browse (i.e. when SOURCE_BROWSER is set to YES).

FILTER_SOURCE_FILES    =3D NO

#------------------------------------------------------------------------=
---
# configuration options related to source browsing
#------------------------------------------------------------------------=
---

# If the SOURCE_BROWSER tag is set to YES then a list of source files =
will=20
# be generated. Documented entities will be cross-referenced with these =
sources.=20
# Note: To get rid of all source code in the generated output, make sure =
also=20
# VERBATIM_HEADERS is set to NO.

SOURCE_BROWSER         =3D NO

# Setting the INLINE_SOURCES tag to YES will include the body=20
# of functions and classes directly in the documentation.

INLINE_SOURCES         =3D NO

# Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct =

# doxygen to hide any special comment blocks from generated source code=20
# fragments. Normal C and C++ comments will always remain visible.

STRIP_CODE_COMMENTS    =3D YES

# If the REFERENCED_BY_RELATION tag is set to YES (the default)=20
# then for each documented function all documented=20
# functions referencing it will be listed.

REFERENCED_BY_RELATION =3D YES

# If the REFERENCES_RELATION tag is set to YES (the default)=20
# then for each documented function all documented entities=20
# called/used by that function will be listed.

REFERENCES_RELATION    =3D YES

# If the USE_HTAGS tag is set to YES then the references to source code=20
# will point to the HTML generated by the htags(1) tool instead of =
doxygen=20
# built-in source browser. The htags tool is part of GNU's global source =

# tagging system (see http://www.gnu.org/software/global/global.html). =
You=20
# will need version 4.8.6 or higher.

USE_HTAGS              =3D NO

# If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen=20
# will generate a verbatim copy of the header file for each class for=20
# which an include is specified. Set to NO to disable this.

VERBATIM_HEADERS       =3D YES

#------------------------------------------------------------------------=
---
# configuration options related to the alphabetical class index
#------------------------------------------------------------------------=
---

# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index=20
# of all compounds will be generated. Enable this if the project=20
# contains a lot of classes, structs, unions or interfaces.

ALPHABETICAL_INDEX     =3D NO

# If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then=20
# the COLS_IN_ALPHA_INDEX tag can be used to specify the number of =
columns=20
# in which this list will be split (can be a number in the range =
[1..20])

COLS_IN_ALPHA_INDEX    =3D 5

# In case all classes in a project start with a common prefix, all=20
# classes will be put under the same header in the alphabetical index.=20
# The IGNORE_PREFIX tag can be used to specify one or more prefixes that =

# should be ignored while generating the index headers.

IGNORE_PREFIX          =3D=20

#------------------------------------------------------------------------=
---
# configuration options related to the HTML output
#------------------------------------------------------------------------=
---

# If the GENERATE_HTML tag is set to YES (the default) Doxygen will=20
# generate HTML output.

GENERATE_HTML          =3D YES

# The HTML_OUTPUT tag is used to specify where the HTML docs will be =
put.=20
# If a relative path is entered the value of OUTPUT_DIRECTORY will be=20
# put in front of it. If left blank `html' will be used as the default =
path.

HTML_OUTPUT            =3D html

# The HTML_FILE_EXTENSION tag can be used to specify the file extension =
for=20
# each generated HTML page (for example: .htm,.php,.asp). If it is left =
blank=20
# doxygen will generate files with .html extension.

HTML_FILE_EXTENSION    =3D .html

# The HTML_HEADER tag can be used to specify a personal HTML header for=20
# each generated HTML page. If it is left blank doxygen will generate a=20
# standard header.

HTML_HEADER            =3D=20

# The HTML_FOOTER tag can be used to specify a personal HTML footer for=20
# each generated HTML page. If it is left blank doxygen will generate a=20
# standard footer.

HTML_FOOTER            =3D=20

# The HTML_STYLESHEET tag can be used to specify a user-defined =
cascading=20
# style sheet that is used by each HTML page. It can be used to=20
# fine-tune the look of the HTML output. If the tag is left blank =
doxygen=20
# will generate a default style sheet. Note that doxygen will try to =
copy=20
# the style sheet file to the HTML output directory, so don't put your =
own=20
# stylesheet in the HTML output directory as well, or it will be erased!

HTML_STYLESHEET        =3D=20

# If the HTML_ALIGN_MEMBERS tag is set to YES, the members of classes,=20
# files or namespaces will be aligned in HTML using tables. If set to=20
# NO a bullet list will be used.

HTML_ALIGN_MEMBERS     =3D YES

# If the GENERATE_HTMLHELP tag is set to YES, additional index files=20
# will be generated that can be used as input for tools like the=20
# Microsoft HTML help workshop to generate a compressed HTML help file =
(.chm)=20
# of the generated HTML documentation.

GENERATE_HTMLHELP      =3D NO

# If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can=20
# be used to specify the file name of the resulting .chm file. You=20
# can add a path in front of the file if the result should not be=20
# written to the html output directory.

CHM_FILE               =3D=20

# If the GENERATE_HTMLHELP tag is set to YES, the HHC_LOCATION tag can=20
# be used to specify the location (absolute path including file name) of =

# the HTML help compiler (hhc.exe). If non-empty doxygen will try to run =

# the HTML help compiler on the generated index.hhp.

HHC_LOCATION           =3D=20

# If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag=20
# controls if a separate .chi index file is generated (YES) or that=20
# it should be included in the master .chm file (NO).

GENERATE_CHI           =3D NO

# If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag=20
# controls whether a binary table of contents is generated (YES) or a=20
# normal table of contents (NO) in the .chm file.

BINARY_TOC             =3D NO

# The TOC_EXPAND flag can be set to YES to add extra items for group =
members=20
# to the contents of the HTML help documentation and to the tree view.

TOC_EXPAND             =3D NO

# The DISABLE_INDEX tag can be used to turn on/off the condensed index =
at=20
# top of each HTML page. The value NO (the default) enables the index =
and=20
# the value YES disables it.

DISABLE_INDEX          =3D NO

# This tag can be used to set the number of enum values (range [1..20])=20
# that doxygen will group on one line in the generated HTML =
documentation.

ENUM_VALUES_PER_LINE   =3D 4

# If the GENERATE_TREEVIEW tag is set to YES, a side panel will be
# generated containing a tree-like index structure (just like the one =
that=20
# is generated for HTML Help). For this to work a browser that supports=20
# JavaScript, DHTML, CSS and frames is required (for instance Mozilla =
1.0+,=20
# Netscape 6.0+, Internet explorer 5.0+, or Konqueror). Windows users =
are=20
# probably better off using the HTML help feature.

GENERATE_TREEVIEW      =3D NO

# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can =
be=20
# used to set the initial width (in pixels) of the frame in which the =
tree=20
# is shown.

TREEVIEW_WIDTH         =3D 250

#------------------------------------------------------------------------=
---
# configuration options related to the LaTeX output
#------------------------------------------------------------------------=
---

<B>GENERATE_LATEX         =3D NO</B>
LATEX_OUTPUT           =3D latex
LATEX_CMD_NAME         =3D latex
MAKEINDEX_CMD_NAME     =3D makeindex
COMPACT_LATEX          =3D NO

# The PAPER_TYPE tag can be used to set the paper type that is used=20
# by the printer. Possible values are: a4, a4wide, letter, legal and=20
# executive. If left blank a4wide will be used.

PAPER_TYPE             =3D a4wide

# The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX=20
# packages that should be included in the LaTeX output.

EXTRA_PACKAGES         =3D=20

# The LATEX_HEADER tag can be used to specify a personal LaTeX header =
for=20
# the generated latex document. The header should contain everything =
until=20
# the first chapter. If it is left blank doxygen will generate a=20
# standard header. Notice: only use this tag if you know what you are =
doing!

LATEX_HEADER           =3D=20

# If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated=20
# is prepared for conversion to pdf (using ps2pdf). The pdf file will=20
# contain links (just like the HTML output) instead of page references=20
# This makes the output suitable for online browsing using a pdf viewer.

PDF_HYPERLINKS         =3D NO

# If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead =
of=20
# plain latex in the generated Makefile. Set this option to YES to get a =

# higher quality PDF documentation.

USE_PDFLATEX           =3D NO

# If the LATEX_BATCHMODE tag is set to YES, doxygen will add the =
\\batchmode.=20
# command to the generated LaTeX files. This will instruct LaTeX to keep =

# running if errors occur, instead of asking the user for help.=20
# This option is also used when generating formulas in HTML.

LATEX_BATCHMODE        =3D NO

# If LATEX_HIDE_INDICES is set to YES then doxygen will not=20
# include the index chapters (such as File Index, Compound Index, etc.)=20
# in the output.

LATEX_HIDE_INDICES     =3D NO

#------------------------------------------------------------------------=
---
# configuration options related to the RTF output
#------------------------------------------------------------------------=
---

GENERATE_RTF           =3D NO
RTF_OUTPUT             =3D rtf
COMPACT_RTF            =3D NO