diff --git a/src/kapidox/data/Doxyfile.global b/src/kapidox/data/Doxyfile.global index 86ef817..f943bf2 100644 --- a/src/kapidox/data/Doxyfile.global +++ b/src/kapidox/data/Doxyfile.global @@ -1,214 +1,215 @@ # Default settings for KDE projects # See http://www.stack.nl/~dimitri/doxygen/manual/config.html for help QUIET = YES # Put the brief description in the same place as the detailed one BRIEF_MEMBER_DESC = NO ALWAYS_DETAILED_SEC = YES # If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full # path before files name in the file list and in the header files. If set # to NO the shortest path that makes the file name unique will be used. FULL_PATH_NAMES = NO # Do not require explicity @brief command for brief description JAVADOC_AUTOBRIEF = YES # A bunch of useful aliases ALIASES = "intern=\parInternal use only." \ "reimp=\parReimplemented from superclass." \ "obsolete=@deprecated" \ "feature=\xrefitem features \"Feature(s)\" \"Features\"" \ "unmaintained=\xrefitem unmaintained \"Unmaintained\" \"Unmaintained\"" \ "requirement=\xrefitem requirements \"Requirement(s)\" \"Requirements\"" \ "faq=\xrefitem FAQ \"F.A.Q.\" \"F.A.Q.\"" \ "authors=\xrefitem authors \"Author(s)\" \"Authors\"" \ "maintainers=\xrefitem maintainers \"Maintainer(s)\" \"Maintainers\"" \ "glossary=\xrefitem glossary \"Glossary\" \"Glossary\"" \ "acronym=\b " \ "licenses=\xrefitem licenses \"License(s)\" \"Licenses\"" \ "FIXME=\xrefitem fixme \"Fixme\" \"Fixme\"" \ "bc=\xrefitem bc \"Binary Compatible\" \"Binary Compatible\"" \ "threadsafe=\xrefitem threadsafe \"Threadsafe\" \"Threadsafe\"" \ "artistic=Artistic" \ "bsd=BSD" \ "x11=X11" \ "gpl=GPLv2" \ "lgpl=LGPLv2" \ "mit=MIT" \ "qpl=QPL" #--------------------------------------------------------------------------- # Build related configuration options #--------------------------------------------------------------------------- # Only extract things in headers, not in .cpp files EXTRACT_LOCAL_CLASSES = NO EXTRACT_LOCAL_METHODS = NO # Anonymous namespaces are hidden EXTRACT_ANON_NSPACES = NO # Require classes to be documented to appear in apidox, but always document all # public and protected members (even if static) HIDE_UNDOC_MEMBERS = NO HIDE_UNDOC_CLASSES = YES EXTRACT_PRIVATE = NO EXTRACT_STATIC = YES # Hide all friend (class|struct|union) declarations. HIDE_FRIEND_COMPOUNDS = YES # Extract documentation entered after an \internal command INTERNAL_DOCS = YES # Produce CasedFiles (matching the case of the class) CASE_SENSE_NAMES = YES # Sort the brief documentation of file, namespace and class members # alphabetically by member name. SORT_BRIEF_DOCS = YES # Put constructors and destructors at the top SORT_MEMBERS_CTORS_1ST = YES # Do not create a test list from \test commands GENERATE_TESTLIST = NO #--------------------------------------------------------------------------- # configuration options related to the input files #--------------------------------------------------------------------------- FILE_PATTERNS = *.h \ *.cpp \ *.cc \ *.hpp \ *.dox \ *.c++ \ *.cxx \ *.mm \ *.h++ \ *.hh \ *.qml \ *.md # Search subdirectories RECURSIVE = YES # Files and paths we want to ignore EXCLUDE_PATTERNS = */.svn/* \ */.git/* \ */cmake/* \ *.moc.* \ moc* \ *.all_cpp.* \ *unload.* \ */test/* \ */tests/* \ */autotests/* \ *_p.cpp \ *_p.h # Symbols from Qt that show up occassionlly and we don't want to see EXCLUDE_SYMBOLS = iterator const_iterator # Use doxyqml filter for qml files FILTER_PATTERNS = *.qml=doxyqml EXTENSION_MAPPING = qml=C++ USE_MDFILE_AS_MAINPAGE = README.md #--------------------------------------------------------------------------- # configuration options related to source browsing #--------------------------------------------------------------------------- # Generate a list of source files. Documented entities will be # cross-referenced with these sources. SOURCE_BROWSER = YES # Do not generate a verbatim copy of the header file for each class for # which an include is specified. VERBATIM_HEADERS = NO #--------------------------------------------------------------------------- # configuration options related to the alphabetical class index #--------------------------------------------------------------------------- # Number of columns for alphabetical index COLS_IN_ALPHA_INDEX = 1 # Ignore the "K" prefix when sorting IGNORE_PREFIX = K #--------------------------------------------------------------------------- # configuration options related to the generated output #--------------------------------------------------------------------------- GENERATE_LATEX = NO GENERATE_QHP = NO GENERATE_MAN = NO # Generate dummy files for combined pages MAN_LINKS = YES # Turn off the condensed index at top of each HTML page. DISABLE_INDEX = YES # Turn off built-in JS search engine #SEARCHENGINE = NO #--------------------------------------------------------------------------- # Configuration options related to the preprocessor #--------------------------------------------------------------------------- # Expand macros, but only those specified by the # PREDEFINED and EXPAND_AS_DEFINED tags. MACRO_EXPANSION = YES EXPAND_ONLY_PREDEF = YES PREDEFINED = DOXYGEN_SHOULD_SKIP_THIS \ Q_SLOTS="slots" \ Q_SIGNALS="signals" \ Q_DECL_CONSTEXPR="constexpr" \ Q_DECL_FINAL="final" \ Q_DECL_NULLPTR="0" \ Q_DECL_OVERRIDE="override" \ Q_DECL_HIDDEN=""\ + Q_REQUIRED_RESULT="" \ #--------------------------------------------------------------------------- # Configuration::additions related to external references #--------------------------------------------------------------------------- # Only list the current project's groups in the module index. EXTERNAL_GROUPS = NO #--------------------------------------------------------------------------- # Configuration options related to the dot tool #--------------------------------------------------------------------------- # Do not inheritance and usage relations if the target is undocumented or is # not a class. HIDE_UNDOC_RELATIONS = NO # Assume we can use the dot tool HAVE_DOT = YES # If the COLLABORATION_GRAPH and HAVE_DOT tags are set to YES then doxygen # will generate a graph for each documented class showing the direct and # indirect implementation dependencies (inheritance, containment, and # class references variables) of the class with other documented classes. COLLABORATION_GRAPH = NO # If set to YES, the inheritance and collaboration graphs will show the # relations between templates and their instances. TEMPLATE_RELATIONS = YES SEARCHENGINE = YES SERVER_BASED_SEARCH = YES EXTERNAL_SEARCH = YES