107 lines
4.8 KiB
Plaintext
107 lines
4.8 KiB
Plaintext
|
# Doxyfile 1.8.6
|
||
|
|
|
||
|
|
# This file describes the settings to be used by the documentation system
|
||
|
|
# doxygen (www.doxygen.org) for a project.
|
||
|
|
#
|
||
|
|
# All text after a double hash (##) is considered a comment and is placed in
|
||
|
|
# front of the TAG it is preceding.
|
||
|
|
#
|
||
|
|
# All text after a single hash (#) is considered a comment and will be ignored.
|
||
|
|
# The format is:
|
||
|
|
# TAG = value [value, ...]
|
||
|
|
# For lists, items can also be appended using:
|
||
|
|
# TAG += value [value, ...]
|
||
|
|
# Values that contain spaces should be placed between quotes (\" \").
|
||
|
|
|
||
|
|
#---------------------------------------------------------------------------
|
||
|
|
# Project related configuration options
|
||
|
|
#---------------------------------------------------------------------------
|
||
|
|
|
||
|
|
# This tag specifies the encoding used for all characters in the config file
|
||
|
|
# that follow. The default is UTF-8 which is also the encoding used for all text
|
||
|
|
# before the first occurrence of this tag. Doxygen uses libiconv (or the iconv
|
||
|
|
# built into libc) for the transcoding. See http://www.gnu.org/software/libiconv
|
||
|
|
# for the list of possible encodings.
|
||
|
|
# The default value is: UTF-8.
|
||
|
|
|
||
|
|
DOXYFILE_ENCODING = UTF-8
|
||
|
|
|
||
|
|
# The PROJECT_NAME tag is a single word (or a sequence of words surrounded by
|
||
|
|
# double-quotes, unless you are using Doxywizard) that should identify the
|
||
|
|
# project for which the documentation is generated. This name is used in the
|
||
|
|
# title of most generated pages and in a few other places.
|
||
|
|
# The default value is: My Project.
|
||
|
|
|
||
|
|
PROJECT_NAME = "@CMAKE_PROJECT_NAME@"
|
||
|
|
|
||
|
|
# 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 =
|
||
|
|
|
||
|
|
# Using the PROJECT_BRIEF tag one can provide an optional one line description
|
||
|
|
# for a project that appears at the top of each page and should give viewer a
|
||
|
|
# quick idea about the purpose of the project. Keep the description short.
|
||
|
|
|
||
|
|
PROJECT_BRIEF = "A Fast, Flexible Static Timing Analysis (STA) Engine for Digital Circuits"
|
||
|
|
|
||
|
|
# 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. The tag can be used to show relative paths in the file list.
|
||
|
|
# If left blank the directory from which doxygen is run is used as the path to
|
||
|
|
# strip.
|
||
|
|
#
|
||
|
|
# Note that you can specify absolute paths here, but also relative paths, which
|
||
|
|
# will be relative from the directory where doxygen is started.
|
||
|
|
# This tag requires that the tag FULL_PATH_NAMES is set to YES.
|
||
|
|
|
||
|
|
STRIP_FROM_PATH = @PROJECT_SOURCE_DIR@ @PROJECT_BINARY_DIR@
|
||
|
|
|
||
|
|
#---------------------------------------------------------------------------
|
||
|
|
# Configuration options related to the input files
|
||
|
|
#---------------------------------------------------------------------------
|
||
|
|
|
||
|
|
# The INPUT tag is used to specify the files and/or directories that contain
|
||
|
|
# documented source files. You may enter file names like myfile.cpp or
|
||
|
|
# directories like /usr/src/myproject. Separate the files or directories with
|
||
|
|
# spaces.
|
||
|
|
# Note: If this tag is empty the current directory is searched.
|
||
|
|
|
||
|
|
INPUT = @PROJECT_SOURCE_DIR@/src/libtatum @PROJECT_SOURCE_DIR@/README.md
|
||
|
|
|
||
|
|
# If the value of the INPUT tag contains directories, you can use the
|
||
|
|
# FILE_PATTERNS tag to specify one or more wildcard patterns (like *.cpp and
|
||
|
|
# *.h) to filter out the source-files in the directories. If left blank the
|
||
|
|
# following patterns are tested:*.c, *.cc, *.cxx, *.cpp, *.c++, *.java, *.ii,
|
||
|
|
# *.ixx, *.ipp, *.i++, *.inl, *.idl, *.ddl, *.odl, *.h, *.hh, *.hxx, *.hpp,
|
||
|
|
# *.h++, *.cs, *.d, *.php, *.php4, *.php5, *.phtml, *.inc, *.m, *.markdown,
|
||
|
|
# *.md, *.mm, *.dox, *.py, *.f90, *.f, *.for, *.tcl, *.vhd, *.vhdl, *.ucf,
|
||
|
|
# *.qsf, *.as and *.js.
|
||
|
|
|
||
|
|
FILE_PATTERNS = *.h *.hpp *.c *.cpp *.tpp *.inl
|
||
|
|
|
||
|
|
# The RECURSIVE tag can be used to specify whether or not subdirectories should
|
||
|
|
# be searched for input files as well.
|
||
|
|
# The default value is: NO.
|
||
|
|
|
||
|
|
RECURSIVE = YES
|
||
|
|
|
||
|
|
# If the USE_MDFILE_AS_MAINPAGE tag refers to the name of a markdown file that
|
||
|
|
# is part of the input, its contents will be placed on the main page
|
||
|
|
# (index.html). This can be useful if you have a project on for instance GitHub
|
||
|
|
# and want to reuse the introduction page also for the doxygen output.
|
||
|
|
|
||
|
|
USE_MDFILE_AS_MAINPAGE = README.md
|
||
|
|
|
||
|
|
# Enable the USE_MATHJAX option to render LaTeX formulas using MathJax (see
|
||
|
|
# http://www.mathjax.org) which uses client side Javascript for the rendering
|
||
|
|
# instead of using prerendered bitmaps. Use this if you do not have LaTeX
|
||
|
|
# installed or if you want to formulas look prettier in the HTML output. When
|
||
|
|
# enabled you may also need to install MathJax separately and configure the path
|
||
|
|
# to it using the MATHJAX_RELPATH option.
|
||
|
|
# The default value is: NO.
|
||
|
|
# This tag requires that the tag GENERATE_HTML is set to YES.
|
||
|
|
|
||
|
|
USE_MATHJAX = YES
|