qpc/doxygen/Doxyfile-DOC

395 lines
14 KiB
Plaintext
Raw Normal View History

2021-01-12 12:55:29 -05:00
# Doxyfile 1.9.0
2020-07-18 17:56:40 -04:00
2016-02-10 16:50:22 -05:00
#---------------------------------------------------------------------------
# Project related configuration options
#---------------------------------------------------------------------------
DOXYFILE_ENCODING = UTF-8
PROJECT_NAME = "QP/C"
2021-01-12 12:55:29 -05:00
PROJECT_NUMBER = "6.9.2"
2016-02-10 16:50:22 -05:00
PROJECT_BRIEF =
PROJECT_LOGO = images/header_logo_ql.png
OUTPUT_DIRECTORY =
CREATE_SUBDIRS = NO
ALLOW_UNICODE_NAMES = NO
OUTPUT_LANGUAGE = English
2020-07-18 17:56:40 -04:00
OUTPUT_TEXT_DIRECTION = None
2016-02-10 16:50:22 -05:00
BRIEF_MEMBER_DESC = YES
REPEAT_BRIEF = YES
ABBREVIATE_BRIEF =
ALWAYS_DETAILED_SEC = NO
INLINE_INHERITED_MEMB = NO
2019-01-16 19:33:33 -05:00
FULL_PATH_NAMES = NO
2016-02-10 16:50:22 -05:00
STRIP_FROM_PATH =
STRIP_FROM_INC_PATH =
SHORT_NAMES = NO
JAVADOC_AUTOBRIEF = NO
2020-07-18 17:56:40 -04:00
JAVADOC_BANNER = NO
2016-02-10 16:50:22 -05:00
QT_AUTOBRIEF = YES
MULTILINE_CPP_IS_BRIEF = YES
2021-01-12 12:55:29 -05:00
PYTHON_DOCSTRING = YES
2016-02-10 16:50:22 -05:00
INHERIT_DOCS = YES
SEPARATE_MEMBER_PAGES = NO
TAB_SIZE = 4
2020-07-18 17:56:40 -04:00
ALIASES = "next{1}=<hr><b>Next:</b> @ref \1</p>" \
"description=@par Description" \
"hint=@par Hint" \
"usage=@par Usage" \
2021-01-12 12:55:29 -05:00
"caption{1}=<div class=\"caption\" align=\"center\">\1</div>" \
2020-07-18 17:56:40 -04:00
"reqdef{2}=<div class= vmargin20></div>@anchor \1 <TABLE><TR ALIGN= left><TH NOWRAP>\1</TH><TH WIDTH= 100%>\2</TH></TR></TABLE>" \
"reqref{1}=@ref \1 \"\1\"" \
"termdef{2}=@anchor term_\1 @par \2" \
"termref{1}=@ref term_\1"
2016-02-10 16:50:22 -05:00
OPTIMIZE_OUTPUT_FOR_C = YES
OPTIMIZE_OUTPUT_JAVA = NO
OPTIMIZE_FOR_FORTRAN = NO
OPTIMIZE_OUTPUT_VHDL = NO
2020-07-18 17:56:40 -04:00
OPTIMIZE_OUTPUT_SLICE = NO
2017-08-29 15:59:44 -04:00
EXTENSION_MAPPING = lnt=Objective-C
2016-02-10 16:50:22 -05:00
MARKDOWN_SUPPORT = YES
2020-01-03 10:21:17 -05:00
TOC_INCLUDE_HEADINGS = 4
2016-02-10 16:50:22 -05:00
AUTOLINK_SUPPORT = YES
BUILTIN_STL_SUPPORT = NO
CPP_CLI_SUPPORT = NO
SIP_SUPPORT = NO
IDL_PROPERTY_SUPPORT = YES
DISTRIBUTE_GROUP_DOC = NO
GROUP_NESTED_COMPOUNDS = NO
SUBGROUPING = YES
INLINE_GROUPED_CLASSES = YES
INLINE_SIMPLE_STRUCTS = YES
TYPEDEF_HIDES_STRUCT = YES
LOOKUP_CACHE_SIZE = 0
2021-01-12 12:55:29 -05:00
NUM_PROC_THREADS = 1
2016-02-10 16:50:22 -05:00
#---------------------------------------------------------------------------
# Build related configuration options
#---------------------------------------------------------------------------
2018-06-25 16:56:47 -04:00
EXTRACT_ALL = YES
EXTRACT_PRIVATE = YES
2020-07-18 17:56:40 -04:00
EXTRACT_PRIV_VIRTUAL = NO
2018-06-25 16:56:47 -04:00
EXTRACT_PACKAGE = YES
2016-02-10 16:50:22 -05:00
EXTRACT_STATIC = YES
EXTRACT_LOCAL_CLASSES = YES
EXTRACT_LOCAL_METHODS = NO
EXTRACT_ANON_NSPACES = NO
2021-01-12 12:55:29 -05:00
RESOLVE_UNNAMED_PARAMS = YES
2016-02-10 16:50:22 -05:00
HIDE_UNDOC_MEMBERS = NO
HIDE_UNDOC_CLASSES = NO
HIDE_FRIEND_COMPOUNDS = NO
HIDE_IN_BODY_DOCS = NO
INTERNAL_DOCS = NO
CASE_SENSE_NAMES = NO
2017-08-29 15:59:44 -04:00
HIDE_SCOPE_NAMES = YES
2016-02-10 16:50:22 -05:00
HIDE_COMPOUND_REFERENCE= NO
SHOW_INCLUDE_FILES = YES
SHOW_GROUPED_MEMB_INC = NO
FORCE_LOCAL_INCLUDES = NO
INLINE_INFO = YES
2017-08-21 18:20:16 -04:00
SORT_MEMBER_DOCS = NO
2016-02-10 16:50:22 -05:00
SORT_BRIEF_DOCS = NO
SORT_MEMBERS_CTORS_1ST = NO
SORT_GROUP_NAMES = NO
SORT_BY_SCOPE_NAME = NO
STRICT_PROTO_MATCHING = NO
GENERATE_TODOLIST = YES
GENERATE_TESTLIST = YES
GENERATE_BUGLIST = YES
GENERATE_DEPRECATEDLIST= YES
ENABLED_SECTIONS =
MAX_INITIALIZER_LINES = 30
SHOW_USED_FILES = YES
SHOW_FILES = YES
SHOW_NAMESPACES = YES
FILE_VERSION_FILTER =
LAYOUT_FILE =
CITE_BIB_FILES =
#---------------------------------------------------------------------------
# Configuration options related to warning and progress messages
#---------------------------------------------------------------------------
QUIET = NO
WARNINGS = YES
WARN_IF_UNDOCUMENTED = YES
WARN_IF_DOC_ERROR = YES
WARN_NO_PARAMDOC = NO
2018-02-18 12:11:16 -05:00
WARN_AS_ERROR = NO
2016-02-10 16:50:22 -05:00
WARN_FORMAT = "$file:$line: $text"
WARN_LOGFILE =
#---------------------------------------------------------------------------
# Configuration options related to the input files
#---------------------------------------------------------------------------
2020-07-18 17:56:40 -04:00
INPUT = main.dox \
gs.dox \
struct.dox \
api.dox \
spec.dox \
srs.dox \
sas.dox \
sds.dox \
exa.dox \
exa_apps.dox \
exa_native.dox \
../../doxygen/exa_low-power.dox \
exa_rtos.dox \
exa_os.dox \
exa_qutest.dox \
exa_mware.dox \
ports.dox \
ports_native.dox \
../../doxygen/ports_arm-cm.dox \
ports_rtos.dox \
ports_os.dox \
history.dox \
macros.h \
metrics.dox \
modules.dox \
../include \
../src \
../ports/lint-plus \
../../doxygen/help.dox
2016-02-10 16:50:22 -05:00
INPUT_ENCODING = UTF-8
2020-07-18 17:56:40 -04:00
FILE_PATTERNS = *.dox \
*.h \
*.c \
*.cpp \
*.s \
*.asm \
*.lnt
2016-02-10 16:50:22 -05:00
RECURSIVE = YES
2020-07-18 17:56:40 -04:00
EXCLUDE = ../include/qs_dummy.h
2016-02-10 16:50:22 -05:00
EXCLUDE_SYMLINKS = NO
EXCLUDE_PATTERNS =
2017-10-13 17:15:48 -04:00
EXCLUDE_SYMBOLS = QP_IMPL
2020-07-18 17:56:40 -04:00
EXAMPLE_PATH = snippets \
../include \
../src \
../ports \
../examples
2018-02-18 12:11:16 -05:00
EXAMPLE_PATTERNS = *
2016-02-10 16:50:22 -05:00
EXAMPLE_RECURSIVE = NO
2020-07-18 17:56:40 -04:00
IMAGE_PATH = images \
../../doxygen/images
2016-02-10 16:50:22 -05:00
INPUT_FILTER =
FILTER_PATTERNS =
FILTER_SOURCE_FILES = NO
FILTER_SOURCE_PATTERNS =
USE_MDFILE_AS_MAINPAGE =
#---------------------------------------------------------------------------
# Configuration options related to source browsing
#---------------------------------------------------------------------------
SOURCE_BROWSER = YES
INLINE_SOURCES = NO
STRIP_CODE_COMMENTS = YES
REFERENCED_BY_RELATION = NO
REFERENCES_RELATION = NO
REFERENCES_LINK_SOURCE = YES
SOURCE_TOOLTIPS = YES
USE_HTAGS = NO
VERBATIM_HEADERS = YES
2018-02-18 12:11:16 -05:00
CLANG_ASSISTED_PARSING = NO
CLANG_OPTIONS =
2020-07-18 17:56:40 -04:00
CLANG_DATABASE_PATH =
2016-02-10 16:50:22 -05:00
#---------------------------------------------------------------------------
# Configuration options related to the alphabetical class index
#---------------------------------------------------------------------------
ALPHABETICAL_INDEX = YES
IGNORE_PREFIX =
#---------------------------------------------------------------------------
# Configuration options related to the HTML output
#---------------------------------------------------------------------------
GENERATE_HTML = YES
2019-12-31 15:55:08 -05:00
HTML_OUTPUT = ../html
2016-02-10 16:50:22 -05:00
HTML_FILE_EXTENSION = .html
2019-12-31 15:55:08 -05:00
HTML_HEADER = ../../doxygen/header.html
HTML_FOOTER = ../../doxygen/footer.html
2016-02-10 16:50:22 -05:00
HTML_STYLESHEET =
2019-12-31 15:55:08 -05:00
HTML_EXTRA_STYLESHEET = ../../doxygen/ql.css
2016-02-10 16:50:22 -05:00
HTML_EXTRA_FILES =
HTML_COLORSTYLE_HUE = 220
HTML_COLORSTYLE_SAT = 100
HTML_COLORSTYLE_GAMMA = 80
HTML_TIMESTAMP = NO
2020-07-18 17:56:40 -04:00
HTML_DYNAMIC_MENUS = YES
2016-02-10 16:50:22 -05:00
HTML_DYNAMIC_SECTIONS = NO
HTML_INDEX_NUM_ENTRIES = 100
GENERATE_DOCSET = NO
DOCSET_FEEDNAME = "Doxygen generated docs"
DOCSET_BUNDLE_ID = com.state-machine.doc
DOCSET_PUBLISHER_ID = com.state-machine.doc
2020-07-18 17:56:40 -04:00
DOCSET_PUBLISHER_NAME = QuantumLeaps
2016-02-10 16:50:22 -05:00
GENERATE_HTMLHELP = NO
2019-12-31 15:55:08 -05:00
CHM_FILE = ../qpc.chm
2016-02-10 16:50:22 -05:00
HHC_LOCATION =
GENERATE_CHI = NO
CHM_INDEX_ENCODING =
2018-02-12 18:53:40 -05:00
BINARY_TOC = YES
2016-02-10 16:50:22 -05:00
TOC_EXPAND = NO
GENERATE_QHP = NO
QCH_FILE =
QHP_NAMESPACE = com.state-machine.qp
QHP_VIRTUAL_FOLDER = doc
QHP_CUST_FILTER_NAME =
QHP_CUST_FILTER_ATTRS =
QHP_SECT_FILTER_ATTRS =
QHG_LOCATION =
GENERATE_ECLIPSEHELP = NO
ECLIPSE_DOC_ID = com.state-machine.qp
DISABLE_INDEX = YES
GENERATE_TREEVIEW = YES
ENUM_VALUES_PER_LINE = 4
TREEVIEW_WIDTH = 180
EXT_LINKS_IN_WINDOW = NO
2020-07-18 17:56:40 -04:00
HTML_FORMULA_FORMAT = png
2016-02-10 16:50:22 -05:00
FORMULA_FONTSIZE = 10
FORMULA_TRANSPARENT = YES
2020-07-18 17:56:40 -04:00
FORMULA_MACROFILE =
2016-02-10 16:50:22 -05:00
USE_MATHJAX = NO
MATHJAX_FORMAT = HTML-CSS
MATHJAX_RELPATH = http://cdn.mathjax.org/mathjax/latest
MATHJAX_EXTENSIONS =
MATHJAX_CODEFILE =
SEARCHENGINE = YES
SERVER_BASED_SEARCH = NO
EXTERNAL_SEARCH = NO
SEARCHENGINE_URL =
SEARCHDATA_FILE = searchdata.xml
EXTERNAL_SEARCH_ID =
EXTRA_SEARCH_MAPPINGS =
#---------------------------------------------------------------------------
# Configuration options related to the LaTeX output
#---------------------------------------------------------------------------
GENERATE_LATEX = NO
LATEX_OUTPUT = latex
LATEX_CMD_NAME = latex
MAKEINDEX_CMD_NAME = makeindex
2020-07-18 17:56:40 -04:00
LATEX_MAKEINDEX_CMD = makeindex
2016-02-10 16:50:22 -05:00
COMPACT_LATEX = NO
PAPER_TYPE = letter
EXTRA_PACKAGES =
LATEX_HEADER =
LATEX_FOOTER =
LATEX_EXTRA_STYLESHEET =
LATEX_EXTRA_FILES =
PDF_HYPERLINKS = YES
USE_PDFLATEX = YES
LATEX_BATCHMODE = NO
LATEX_HIDE_INDICES = NO
LATEX_SOURCE_CODE = NO
LATEX_BIB_STYLE = plain
2018-02-18 12:11:16 -05:00
LATEX_TIMESTAMP = NO
2020-07-18 17:56:40 -04:00
LATEX_EMOJI_DIRECTORY =
2016-02-10 16:50:22 -05:00
#---------------------------------------------------------------------------
# Configuration options related to the RTF output
#---------------------------------------------------------------------------
GENERATE_RTF = NO
RTF_OUTPUT = rtf
COMPACT_RTF = NO
RTF_HYPERLINKS = NO
RTF_STYLESHEET_FILE =
RTF_EXTENSIONS_FILE =
RTF_SOURCE_CODE = NO
#---------------------------------------------------------------------------
# Configuration options related to the man page output
#---------------------------------------------------------------------------
GENERATE_MAN = NO
MAN_OUTPUT = man
MAN_EXTENSION = .3
MAN_SUBDIR =
MAN_LINKS = NO
#---------------------------------------------------------------------------
# Configuration options related to the XML output
#---------------------------------------------------------------------------
GENERATE_XML = NO
XML_OUTPUT = xml
XML_PROGRAMLISTING = YES
2020-07-18 17:56:40 -04:00
XML_NS_MEMB_FILE_SCOPE = NO
2016-02-10 16:50:22 -05:00
#---------------------------------------------------------------------------
# Configuration options related to the DOCBOOK output
#---------------------------------------------------------------------------
GENERATE_DOCBOOK = NO
DOCBOOK_OUTPUT = docbook
DOCBOOK_PROGRAMLISTING = NO
#---------------------------------------------------------------------------
# Configuration options for the AutoGen Definitions output
#---------------------------------------------------------------------------
GENERATE_AUTOGEN_DEF = NO
#---------------------------------------------------------------------------
# Configuration options related to the Perl module output
#---------------------------------------------------------------------------
GENERATE_PERLMOD = NO
PERLMOD_LATEX = NO
PERLMOD_PRETTY = YES
PERLMOD_MAKEVAR_PREFIX =
#---------------------------------------------------------------------------
# Configuration options related to the preprocessor
#---------------------------------------------------------------------------
ENABLE_PREPROCESSING = YES
MACRO_EXPANSION = NO
EXPAND_ONLY_PREDEF = NO
SEARCH_INCLUDES = YES
INCLUDE_PATH =
INCLUDE_FILE_PATTERNS =
2020-07-18 17:56:40 -04:00
PREDEFINED = Q_SPY \
QP_IMPL \
Q_UTEST \
QK_ON_CONTEXT_SW \
QXK_ON_CONTEXT_SW \
QF_MAX_ACTIVE \
QF_MAX_TICK_RATE \
QF_MAX_EPOOL \
QF_EVENT_SIZ_SIZE \
QF_EQUEUE_CTR_SIZE \
QF_MPOOL_SIZ_SIZE \
QF_MPOOL_CTR_SIZE \
QF_TIMEEVT_CTR_SIZE \
2021-01-12 12:55:29 -05:00
QF_ACTIVE_STOP \
2020-07-18 17:56:40 -04:00
QS_TIME_SIZE
2016-02-10 16:50:22 -05:00
EXPAND_AS_DEFINED =
SKIP_FUNCTION_MACROS = YES
#---------------------------------------------------------------------------
# Configuration options related to external references
#---------------------------------------------------------------------------
TAGFILES =
GENERATE_TAGFILE =
ALLEXTERNALS = NO
EXTERNAL_GROUPS = YES
EXTERNAL_PAGES = YES
#---------------------------------------------------------------------------
# Configuration options related to the dot tool
#---------------------------------------------------------------------------
CLASS_DIAGRAMS = YES
DIA_PATH =
HIDE_UNDOC_RELATIONS = YES
2018-06-25 16:56:47 -04:00
HAVE_DOT = YES
2016-02-10 16:50:22 -05:00
DOT_NUM_THREADS = 0
DOT_FONTNAME = Helvetica
DOT_FONTSIZE = 10
DOT_FONTPATH =
CLASS_GRAPH = YES
COLLABORATION_GRAPH = YES
GROUP_GRAPHS = YES
UML_LOOK = YES
UML_LIMIT_NUM_FIELDS = 10
2021-01-12 12:55:29 -05:00
DOT_UML_DETAILS = NO
DOT_WRAP_THRESHOLD = 17
2016-02-10 16:50:22 -05:00
TEMPLATE_RELATIONS = NO
INCLUDE_GRAPH = YES
INCLUDED_BY_GRAPH = YES
CALL_GRAPH = NO
CALLER_GRAPH = NO
GRAPHICAL_HIERARCHY = YES
DIRECTORY_GRAPH = YES
DOT_IMAGE_FORMAT = png
INTERACTIVE_SVG = NO
2019-12-31 15:55:08 -05:00
DOT_PATH = C:/tools/graphviz/bin
2016-02-10 16:50:22 -05:00
DOTFILE_DIRS =
MSCFILE_DIRS =
DIAFILE_DIRS =
PLANTUML_JAR_PATH =
2018-02-18 12:11:16 -05:00
PLANTUML_CFG_FILE =
2016-02-10 16:50:22 -05:00
PLANTUML_INCLUDE_PATH =
DOT_GRAPH_MAX_NODES = 50
MAX_DOT_GRAPH_DEPTH = 0
DOT_TRANSPARENT = NO
DOT_MULTI_TARGETS = NO
GENERATE_LEGEND = YES
DOT_CLEANUP = YES