Doxyfile

# Doxyfile 1.9.7

# 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 (\" \").
#
# Note:
#
# Use doxygen to compare the used configuration file with the template
# configuration file:
# doxygen -x [configFile]
# Use doxygen to compare the used configuration file with the template
# configuration file without replacing the environment variables or CMake type
# replacement variables:
# doxygen -x_noenv [configFile]

DOXYFILE_ENCODING      = UTF-8

PROJECT_NAME           = "Bartleby"
PROJECT_NUMBER         = 0.1.0
PROJECT_BRIEF          = "A symbol renaming toolkit"
PROJECT_LOGO           =

OUTPUT_DIRECTORY       = doxygen-docs
OUTPUT_LANGUAGE        = English

BRIEF_MEMBER_DESC      = YES
REPEAT_BRIEF           = YES
ABBREVIATE_BRIEF       = "The $name class" \
                         "The $name widget" \
                         "The $name file" \
                         is \
                         provides \
                         specifies \
                         contains \
                         represents \
                         a \
                         an \
                         the

INHERIT_DOCS           = YES

TAB_SIZE               = 4

MARKDOWN_SUPPORT       = YES

MARKDOWN_ID_STYLE      = GITHUB

AUTOLINK_SUPPORT       = YES

QUIET                  = NO
WARNINGS               = YES
WARN_IF_UNDOCUMENTED   = YES
WARN_IF_DOC_ERROR      = YES
WARN_IF_INCOMPLETE_DOC = YES
WARN_AS_ERROR          = NO

INPUT                  = .
INPUT_ENCODING         = UTF-8
LAYOUT_FILE = ./docs/DoxygenLayout.xml

FILE_PATTERNS          = *.c \
                         *.cpp \
                         *.h \
                         *.hpp \
                         *.dox
EXTENSION_MAPPING      = bzl=python \
                         bazel=python
RECURSIVE              = YES
EXCLUDE                = README.md \
                         docs/rules.md \
                         bazel-bartleby \
                         bazel-bin \
                         bazel-out \
                         bazel-testlogs \
                         build
EXCLUDE_SYMLINKS       = YES
EXCLUDE_PATTERNS       =

EXAMPLE_PATH           = examples/
EXAMPLE_RECURSIVE      = YES

HTML_COLORSTYLE        = TOGGLE

GENERATE_DOCSET        = NO
GENERATE_HTMLHELP      = NO

SEARCHENGINE           = YES
SERVER_BASED_SEARCH    = NO

GENERATE_LATEX         = NO
GENERATE_RTF           = NO
GENERATE_MAN           = NO
GENERATE_XML           = NO
GENERATE_DOCBOOK       = NO
GENERATE_AUTOGEN_DEF   = NO
GENERATE_PERLMOD       = NO

ENABLE_PREPROCESSING   = YES

PYTHON_DOCSTRING       = NO
INLINE_SOURCES         = YES