Doxyfile

# Doxyfile 1.9.1

# This file describes the settings to be used by the documentation system
# doxygen (www.doxygen.org) for a project

# All text after a `#' in the configuration file is considered a comment and
# will be ignored

# The format is:
#   TAG = value [value, ...]

# All values after a tag are space or comma separated.

#---------------------------------------------------------------------------

# Project related configuration options

#---------------------------------------------------------------------------

# The PROJECT_NAME tag is a single word (or a sequence of words surrounded 
# by quotes) that should identify the project.

PROJECT_NAME           = "shmemvv"

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

# The PROJECT_BRIEF tag can be used to add a one line description of the project
PROJECT_BRIEF          = "A V&V suite for OpenSHMEM implementations."

# 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       = ./docs

# The GENERATE_HTML tag can be used to disable the HTML output.
# Possible values are YES and NO.

GENERATE_HTML          = YES

# The GENERATE_LATEX tag can be used to disable the generation of the LaTeX 
# files. 
# Possible values are YES and NO.

GENERATE_LATEX         = YES

# The GENERATE_RTF tag can be used to enable/disable RTF output
# (only useful when generated from LaTeX).
# Possible values are YES and NO.

GENERATE_RTF           = NO

# The GENERATE_MAN tag can be used to enable/disable the generation of the
# man pages. 
# Possible values are YES and NO.

GENERATE_MAN           = YES

# The GENERATE_XML tag can be used to enable/disable the generation of the
# XML output. 
# Possible values are YES and NO.

GENERATE_XML           = NO

# The GENERATE_DOCBOOK tag can be used to enable/disable the generation of 
# DocBook files.
# Possible values are YES and NO.

GENERATE_DOCBOOK       = NO

# The EXTRACT_ALL tag can be used to enable the extraction of all entities 
# from the source files (if defined).

EXTRACT_ALL            = YES

# The RECURSIVE tag can be used to specify whether or not subdirectories should
# be searched for input files as well.
# Possible values are YES and NO.

RECURSIVE              = YES

# The INPUT tag can be used to specify the files and/or directories that contain
# documented source files.

INPUT                  = src

# The FILE_PATTERNS tag can be used to specify one or more wildcard patterns 
# (like *.cpp and *.h) to filter out the source files in the directories.
# Note that if this tag is empty or omitted all files are included.

FILE_PATTERNS          = *.cpp *.h *.hpp

# The EXCLUDE_PATTERNS tag can be used to specify one or more wildcard patterns 
# to exclude certain files from being processed. 
# Note that the wildcard syntax is similar to the one used in FILE_PATTERNS.
# For example if you want to exclude all test directories you could specify:
# EXCLUDE_PATTERNS       = */test/*

EXCLUDE_PATTERNS       = *shmemvv.cpp

# The EXTRACT_PRIVATE and EXTRACT_STATIC tags can be used to specify whether
# the members (attributes and methods) of a class that are declared private 
# or static should be included in the documentation.
# Possible values are YES and NO.

EXTRACT_PRIVATE        = NO
EXTRACT_STATIC         = NO

# The GENERATE_TREEVIEW tag can be used to enable (YES) or disable (NO) the
# graphical tree view of the documentation.

GENERATE_TREEVIEW      = YES

# The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put.
# If a relative path is entered the value of OUTPUT_DIRECTORY will be
# put in front of it.
LATEX_OUTPUT           = latex

# The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be
# invoked. If left blank `latex' will be used as the default command name.
LATEX_CMD_NAME         = pdflatex

# The MAKEINDEX_CMD_NAME tag can be used to specify the command name to
# generate index for LaTeX.
MAKEINDEX_CMD_NAME     = makeindex

# If the COMPACT_LATEX tag is set to YES, doxygen generates more compact
# LaTeX documents. This may be useful for small projects and may help to
# save some trees in general.
COMPACT_LATEX          = NO

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

# The EXTRA_PACKAGES tag can be used to specify one or more LaTeX package names
# that should be included in the LaTeX output.
EXTRA_PACKAGES         = # [T1, inputenc, fontenc, longtable, ulem, textcomp, babel]

# The PDF_HYPERLINKS tag can be used to specify whether or not to 
# include hyperlinks inside the generated PDF document. 
# Possible values are YES and NO.
PDF_HYPERLINKS         = YES

# The USE_PDFLATEX tag can be used to specify whether or not to generate PDF 
# output directly using pdflatex(1). 
# If set to NO, the generated LaTeX files should be processed with 
# latex and dvips to obtain DVI and PostScript files. 
# Possible values are YES and NO.
USE_PDFLATEX           = YES

# The LATEX_BATCHMODE tag can be used to specify if LaTeX should be run in 
# batch mode or not. In batch mode, some errors will be reduced to warnings 
# and will not stop the document generation.
LATEX_BATCHMODE        = NO

# The LATEX_HIDE_INDICES tag can be used to hide page numbering in the
# table of contents. If set to YES, the number of each chapter will be
# hidden in the table of contents.
LATEX_HIDE_INDICES     = NO

# The LATEX_SOURCE_CODE tag can be used to enable source code in the PDF output.
LATEX_SOURCE_CODE      = YES

# The INLINE_SOURCES tag can be used to include the source code within 
# the documentation. 
INLINE_SOURCES         = YES

# The SOURCE_BROWSER tag can be used to enable/disable the 
# generation of a list of source files that are documented.
SOURCE_BROWSER         = YES

# The VERBATIM_HEADERS tag can be used to include verbatim copies of 
# the header files in the documentation.
VERBATIM_HEADERS       = YES

# The REFERENCES_RELATION tag can be used to enable/disable the 
# generation of the references relation. This allows you to list 
# which files and classes refer to which other files and classes.
REFERENCES_RELATION    = YES