# Doxyfile optimized for C++ / Qt / Qt Creator Help # Generated for DBC Framework #--------------------------------------------------------------------------- # Project #--------------------------------------------------------------------------- DOXYFILE_ENCODING = UTF-8 PROJECT_NAME = "DBC Framework" PROJECT_BRIEF = "DBC parsing and CAN signal decoding framework" PROJECT_NUMBER = OUTPUT_DIRECTORY = docs OUTPUT_LANGUAGE = English OUTPUT_TEXT_DIRECTION = None # Stable output: useful for git diffs HTML_TIMESTAMP = NO #--------------------------------------------------------------------------- # Input #--------------------------------------------------------------------------- INPUT = . README.md INPUT_ENCODING = UTF-8 RECURSIVE = YES FILE_PATTERNS = *.h \ *.hpp \ *.hh \ *.hxx \ *.cpp \ *.cc \ *.cxx \ *.c++ \ *.md EXCLUDE = .git \ build \ docs EXCLUDE_PATTERNS = */.git/* \ */build/* \ */build-*/* \ */docs/* \ */moc_* \ */ui_* \ */qrc_* \ */CMakeFiles/* \ */Testing/* EXCLUDE_SYMLINKS = YES #--------------------------------------------------------------------------- # General C++ / Qt parsing #--------------------------------------------------------------------------- OPTIMIZE_OUTPUT_FOR_C = NO OPTIMIZE_OUTPUT_JAVA = NO OPTIMIZE_FOR_FORTRAN = NO OPTIMIZE_OUTPUT_VHDL = NO BUILTIN_STL_SUPPORT = YES CPP_CLI_SUPPORT = NO SIP_SUPPORT = NO IDL_PROPERTY_SUPPORT = YES MARKDOWN_SUPPORT = YES AUTOLINK_SUPPORT = YES # Java-style comments are convenient in C++ projects: # /** # * @brief ... # */ JAVADOC_AUTOBRIEF = NO QT_AUTOBRIEF = YES MULTILINE_CPP_IS_BRIEF = NO #--------------------------------------------------------------------------- # Extraction policy #--------------------------------------------------------------------------- # Public/API-oriented documentation. # For internal documentation, change these to YES in a separate Doxyfile.internal. EXTRACT_ALL = NO EXTRACT_PRIVATE = NO EXTRACT_PRIV_VIRTUAL = NO EXTRACT_PACKAGE = NO EXTRACT_STATIC = NO EXTRACT_LOCAL_CLASSES = NO EXTRACT_LOCAL_METHODS = NO EXTRACT_ANON_NSPACES = NO INTERNAL_DOCS = NO HIDE_UNDOC_MEMBERS = NO HIDE_UNDOC_CLASSES = NO HIDE_FRIEND_COMPOUNDS = NO HIDE_IN_BODY_DOCS = NO #--------------------------------------------------------------------------- # Output organization #--------------------------------------------------------------------------- BRIEF_MEMBER_DESC = YES REPEAT_BRIEF = YES ALWAYS_DETAILED_SEC = NO INLINE_INHERITED_MEMB = YES FULL_PATH_NAMES = NO SHORT_NAMES = NO INHERIT_DOCS = YES SEPARATE_MEMBER_PAGES = NO TAB_SIZE = 4 # Keep API order close to header order. Usually nicer for hand-written C++ APIs. SORT_MEMBER_DOCS = NO SORT_BRIEF_DOCS = NO SORT_MEMBERS_CTORS_1ST = YES SORT_GROUP_NAMES = NO SORT_BY_SCOPE_NAME = NO SHOW_INCLUDE_FILES = YES SHOW_USED_FILES = YES SHOW_FILES = YES SHOW_NAMESPACES = YES INLINE_INFO = YES FORCE_LOCAL_INCLUDES = NO #--------------------------------------------------------------------------- # Warnings #--------------------------------------------------------------------------- QUIET = NO WARNINGS = YES WARN_IF_UNDOCUMENTED = YES WARN_IF_DOC_ERROR = YES WARN_NO_PARAMDOC = NO WARN_AS_ERROR = NO WARN_FORMAT = "$file:$line: $text" WARN_LOGFILE = docs/doxygen_warnings.log #--------------------------------------------------------------------------- # Source browsing #--------------------------------------------------------------------------- SOURCE_BROWSER = YES INLINE_SOURCES = NO STRIP_CODE_COMMENTS = YES REFERENCED_BY_RELATION = YES REFERENCES_RELATION = YES REFERENCES_LINK_SOURCE = YES VERBATIM_HEADERS = YES #--------------------------------------------------------------------------- # HTML output #--------------------------------------------------------------------------- GENERATE_HTML = YES HTML_OUTPUT = html HTML_FILE_EXTENSION = .html HTML_DYNAMIC_SECTIONS = YES HTML_COLORSTYLE_HUE = 220 HTML_COLORSTYLE_SAT = 100 HTML_COLORSTYLE_GAMMA = 80 GENERATE_TREEVIEW = YES DISABLE_INDEX = NO FULL_SIDEBAR = NO HTML_INDEX_NUM_ENTRIES = 100 TREEVIEW_WIDTH = 280 ENUM_VALUES_PER_LINE = 4 SEARCHENGINE = YES SERVER_BASED_SEARCH = NO #--------------------------------------------------------------------------- # Qt Creator / Qt Help output #--------------------------------------------------------------------------- # Result: docs/html/dbc.qch # In Qt Creator: Edit -> Preferences/Options -> Help -> Documentation -> Add GENERATE_QHP = YES QCH_FILE = dbc.qch QHP_NAMESPACE = ca.himro.dbcframework QHP_VIRTUAL_FOLDER = doc QHP_CUST_FILTER_NAME = "DBC Framework" QHP_CUST_FILT_ATTRS = dbc framework c++ qt QHP_SECT_FILTER_ATTRS = dbc framework c++ qt QHG_LOCATION = qhelpgenerator # Not useful on Linux/Qt Creator workflow GENERATE_HTMLHELP = NO GENERATE_DOCSET = NO GENERATE_ECLIPSEHELP = NO #--------------------------------------------------------------------------- # Other output formats disabled #--------------------------------------------------------------------------- GENERATE_LATEX = NO GENERATE_RTF = NO GENERATE_MAN = NO GENERATE_XML = NO GENERATE_AUTOGEN_DEF = NO GENERATE_PERLMOD = NO #--------------------------------------------------------------------------- # Preprocessor / Qt macros #--------------------------------------------------------------------------- ENABLE_PREPROCESSING = YES MACRO_EXPANSION = YES EXPAND_ONLY_PREDEF = YES SEARCH_INCLUDES = YES INCLUDE_PATH = INCLUDE_FILE_PATTERNS = *.h *.hpp *.hh *.hxx PREDEFINED = DOXYGEN \ Q_OBJECT= \ Q_GADGET= \ Q_NAMESPACE= \ Q_ENUM(...)= \ Q_ENUM_NS(...)= \ Q_FLAG(...)= \ Q_FLAG_NS(...)= \ Q_PROPERTY(...)= \ Q_DECLARE_FLAGS(...)= \ Q_DECLARE_OPERATORS_FOR_FLAGS(...)= \ Q_INTERFACES(...)= \ Q_CLASSINFO(...)= \ Q_PLUGIN_METADATA(...)= \ Q_INVOKABLE= \ Q_SIGNAL= \ Q_SLOT= \ Q_SIGNALS=public \ Q_SLOTS= \ Q_EMIT= \ signals=public \ slots= \ emit= \ Q_DECL_OVERRIDE=override \ Q_DECL_FINAL=final \ Q_DECL_DEPRECATED= \ Q_DECL_DEPRECATED_X(...)= \ QT_BEGIN_NAMESPACE= \ QT_END_NAMESPACE= \ QT_FORWARD_DECLARE_CLASS(...)= \ Q_DISABLE_COPY(...)= \ Q_DISABLE_COPY_MOVE(...)= \ Q_UNUSED(...)= EXPAND_AS_DEFINED = SKIP_FUNCTION_MACROS = YES #--------------------------------------------------------------------------- # Graphviz / diagrams #--------------------------------------------------------------------------- # For Qt Creator help, diagrams are useful, but call/caller graphs are noisy and slow. HAVE_DOT = YES DOT_NUM_THREADS = 0 DOT_IMAGE_FORMAT = svg INTERACTIVE_SVG = YES DOT_TRANSPARENT = NO DOT_MULTI_TARGETS = YES DOT_CLEANUP = YES CLASS_DIAGRAMS = YES CLASS_GRAPH = YES COLLABORATION_GRAPH = NO GROUP_GRAPHS = YES UML_LOOK = YES UML_LIMIT_NUM_FIELDS = 12 TEMPLATE_RELATIONS = YES INCLUDE_GRAPH = NO INCLUDED_BY_GRAPH = NO CALL_GRAPH = NO CALLER_GRAPH = NO GRAPHICAL_HIERARCHY = YES DIRECTORY_GRAPH = NO DOT_GRAPH_MAX_NODES = 50 MAX_DOT_GRAPH_DEPTH = 2 GENERATE_LEGEND = YES #--------------------------------------------------------------------------- # Indexes / lists #--------------------------------------------------------------------------- ALPHABETICAL_INDEX = YES COLS_IN_ALPHA_INDEX = 5 GENERATE_TODOLIST = YES GENERATE_TESTLIST = YES GENERATE_BUGLIST = YES GENERATE_DEPRECATEDLIST= YES #--------------------------------------------------------------------------- # External references #--------------------------------------------------------------------------- TAGFILES = GENERATE_TAGFILE = docs/dbcframework.tag ALLEXTERNALS = NO EXTERNAL_GROUPS = YES EXTERNAL_PAGES = YES PERL_PATH = /usr/bin/perl