kapidox/data/Doxyfile.global

0001 # Default settings for KDE projects
0002 # See https://www.doxygen.nl/manual/config.html for help
0003
0004 QUIET = YES
0005
0006 # Put the brief description in the same place as the detailed one
0007 BRIEF_MEMBER_DESC      = NO
0008 ALWAYS_DETAILED_SEC    = YES
0009
0010 # If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full
0011 # path before files name in the file list and in the header files. If set
0012 # to NO the shortest path that makes the file name unique will be used.
0013 FULL_PATH_NAMES        = NO
0014
0015 # Do not require explicitly @brief command for brief description
0016 JAVADOC_AUTOBRIEF      = YES
0017
0018 # A bunch of useful aliases
0019 ALIASES                = "intern=\par<b>Internal use only.</b>" \
0020                          "reimp=\par<b>Reimplemented from superclass.</b>" \
0021                          "obsolete=@deprecated" \
0022                          "feature=\xrefitem features \"Feature(s)\" \"Features\"" \
0023                          "unmaintained=\xrefitem unmaintained \"Unmaintained\" \"Unmaintained\"" \
0024                          "requirement=\xrefitem requirements \"Requirement(s)\" \"Requirements\"" \
0025                          "faq=\xrefitem FAQ \"F.A.Q.\" \"F.A.Q.\"" \
0026                          "authors=\xrefitem authors \"Author(s)\" \"Authors\"" \
0027                          "maintainers=\xrefitem maintainers \"Maintainer(s)\" \"Maintainers\"" \
0028                          "glossary=\xrefitem glossary \"Glossary\" \"Glossary\"" \
0029                          "acronym=\b " \
0030                          "licenses=\xrefitem licenses \"License(s)\" \"Licenses\"" \
0031                          "FIXME=\xrefitem fixme \"Fixme\" \"Fixme\"" \
0032                          "bc=\xrefitem bc \"Binary Compatible\" \"Binary Compatible\"" \
0033                          "threadsafe=\xrefitem threadsafe \"Threadsafe\" \"Threadsafe\"" \
0034                          "artistic=<a href=\"https://www.opensource.org/licenses/artistic-license.php\">Artistic</a>" \
0035                          "bsd=<a href=\"https://www.xfree86.org/3.3.6/COPYRIGHT2.html#5\">BSD</a>" \
0036                          "x11=<a href=\"https://www.xfree86.org/3.3.6/COPYRIGHT2.html#3\">X11</a>" \
0037                          "gpl=<a href=\"https://www.gnu.org/licenses/old-licenses/gpl-2.0.html#SEC1\">GPLv2</a>" \
0038                          "lgpl=<a href=\"https://www.gnu.org/licenses/old-licenses/lgpl-2.1.html#SEC1\">LGPLv2</a>" \
0039                          "mit=<a href=\"https://www.opensource.org/licenses/mit-license.php\">MIT</a>" \
0040                          "qpl=<a href=\"https://opensource.org/licenses/QPL-1.0\">QPL</a>"
0041
0042
0043
0044 #---------------------------------------------------------------------------
0045 # Build related configuration options
0046 #---------------------------------------------------------------------------
0047
0048 # Only extract things in headers, not in .cpp files
0049 EXTRACT_LOCAL_CLASSES  = NO
0050 EXTRACT_LOCAL_METHODS  = NO
0051
0052 # Anonymous namespaces are hidden
0053 EXTRACT_ANON_NSPACES   = NO
0054
0055 # Require classes to be documented to appear in apidox, but always document all
0056 # public and protected members (even if static)
0057 HIDE_UNDOC_MEMBERS     = NO
0058 HIDE_UNDOC_CLASSES     = YES
0059 EXTRACT_PRIVATE        = NO
0060 EXTRACT_STATIC         = YES
0061
0062 # Hide all friend (class|struct|union) declarations.
0063 HIDE_FRIEND_COMPOUNDS  = YES
0064
0065 # Extract documentation entered after an \internal command
0066 INTERNAL_DOCS          = YES
0067
0068 # Produce CasedFiles (matching the case of the class)
0069 CASE_SENSE_NAMES       = YES
0070
0071 # Sort the brief documentation of file, namespace and class members
0072 # alphabetically by member name.
0073 SORT_BRIEF_DOCS        = YES
0074
0075 # Put constructors and destructors at the top
0076 SORT_MEMBERS_CTORS_1ST = YES
0077
0078 # Do not create a test list from \test commands
0079 GENERATE_TESTLIST      = NO
0080
0081 # Show comment in source code browser
0082 STRIP_CODE_COMMENTS    = NO
0083
0084
0085 #---------------------------------------------------------------------------
0086 # configuration options related to the input files
0087 #---------------------------------------------------------------------------
0088
0089 FILE_PATTERNS          = *.h \
0090                          *.cpp \
0091                          *.cc \
0092                          *.hpp \
0093                          *.dox \
0094                          *.c++ \
0095                          *.cxx \
0096                          *.mm \
0097                          *.h++ \
0098                          *.hh \
0099                          *.qml \
0100                          *.md
0101
0102 # Search subdirectories
0103 RECURSIVE              = YES
0104
0105 # Files and paths we want to ignore
0106 EXCLUDE_PATTERNS       = */.svn/* \
0107                          */.git/* \
0108                          */cmake/* \
0109                          *.moc.* \
0110                          moc* \
0111                          *.all_cpp.* \
0112                          *unload.* \
0113                          */test/* \
0114                          */tests/* \
0115                          */autotests/* \
0116                          *_p.cpp \
0117                          *_p.h
0118
0119 # Symbols from Qt that show up occassionlly and we don't want to see
0120 EXCLUDE_SYMBOLS        = iterator const_iterator
0121
0122 # Use doxyqml filter for qml files
0123 FILTER_PATTERNS        = *.qml=doxyqml
0124 EXTENSION_MAPPING      = qml=C++
0125 USE_MDFILE_AS_MAINPAGE = README.md
0126
0127 #---------------------------------------------------------------------------
0128 # configuration options related to source browsing
0129 #---------------------------------------------------------------------------
0130
0131 # Generate a list of source files.  Documented entities will be
0132 # cross-referenced with these sources.
0133 SOURCE_BROWSER         = YES
0134
0135 # Do not generate a verbatim copy of the header file for each class for
0136 # which an include is specified.
0137 VERBATIM_HEADERS       = NO
0138
0139 #---------------------------------------------------------------------------
0140 # configuration options related to the alphabetical class index
0141 #---------------------------------------------------------------------------
0142
0143 # Number of columns for alphabetical index
0144 COLS_IN_ALPHA_INDEX    = 1
0145
0146 # Ignore the "K" prefix when sorting
0147 IGNORE_PREFIX          = K
0148
0149 #---------------------------------------------------------------------------
0150 # configuration options related to the generated output
0151 #---------------------------------------------------------------------------
0152
0153 GENERATE_LATEX         = NO
0154
0155 GENERATE_QHP           = NO
0156
0157 GENERATE_MAN           = NO
0158 # Generate dummy files for combined pages
0159 MAN_LINKS              = YES
0160
0161 # Turn off the condensed index at top of each HTML page.
0162 DISABLE_INDEX          = YES
0163
0164 #---------------------------------------------------------------------------
0165 # Configuration options related to the preprocessor
0166 #---------------------------------------------------------------------------
0167
0168 # Expand macros, but only those specified by the
0169 # PREDEFINED and EXPAND_AS_DEFINED tags.
0170 MACRO_EXPANSION        = YES
0171 EXPAND_ONLY_PREDEF     = YES
0172
0173 # K_DOXYGEN set to have preprocessor macros know that kapidox/doxygen processes them
0174 # DOXYGEN_SHOULD_SKIP_THIS is the deprecated variant (remove for KF6)
0175 PREDEFINED             = DOXYGEN_SHOULD_SKIP_THIS \
0176                          K_DOXYGEN \
0177                          Q_SLOTS=slots \
0178                          Q_SIGNALS=signals \
0179                          Q_DECL_CONSTEXPR=constexpr \
0180                          Q_DECL_FINAL=final \
0181                          "Q_DECL_EQ_DEFAULT= = default" \
0182                          "Q_DECL_EQ_DELETE= = delete" \
0183                          Q_DECL_NULLPTR=nullptr \
0184                          Q_DECL_OVERRIDE=override \
0185                          Q_DECL_HIDDEN= \
0186                          Q_REQUIRED_RESULT= \
0187                          "Q_DECLARE_FLAGS(Flags, Enum)=typedef QFlags<Enum> Flags;" \
0188
0189 #---------------------------------------------------------------------------
0190 # Configuration::additions related to external references
0191 #---------------------------------------------------------------------------
0192
0193 # Only list the current project's groups in the module index.
0194 EXTERNAL_GROUPS        = NO
0195
0196 #---------------------------------------------------------------------------
0197 # Configuration options related to the dot tool
0198 #---------------------------------------------------------------------------
0199
0200 # Do not inheritance and usage relations if the target is undocumented or is
0201 # not a class.
0202
0203 HIDE_UNDOC_RELATIONS   = NO
0204
0205 # Assume we can use the dot tool
0206 HAVE_DOT               = YES
0207
0208 # If the COLLABORATION_GRAPH and HAVE_DOT tags are set to YES then doxygen
0209 # will generate a graph for each documented class showing the direct and
0210 # indirect implementation dependencies (inheritance, containment, and
0211 # class references variables) of the class with other documented classes.
0212 COLLABORATION_GRAPH    = NO
0213
0214 # If set to YES, the inheritance and collaboration graphs will show the
0215 # relations between templates and their instances.
0216 TEMPLATE_RELATIONS     = YES
0217
0218 # Do not overwrite these values or the KApiDox JS search function will break.
0219 SEARCHENGINE           = YES
0220 SERVER_BASED_SEARCH    = YES
0221 EXTERNAL_SEARCH        = YES