Doxygen mainpage title1/20/2024 ![]() The call graph will be generated regardless of the value of CALL_GRAPH. When this command is put in a comment block of a function or method and HAVE_DOT is set to YES, then doxygen will generate a call graph for that function (provided the implementation of the function or method calls other documented functions). See also page Grouping, sections \defgroup, \ingroup, and \weakgroup. ![]() * Additional documentation for group 'mygrp' The title is optional, so this command can also be used to add a number of entities to an existing group using and like this: /*! \addtogroup mygrp Unrecognized commands are treated as normal text.ĭefines a group just like \defgroup, but in contrast to that command using the same more than once will not result in a warning, but rather one group with a merged documentation and the first title found in any of the commands. The following subsections provide a list of all commands that are recognized by doxygen. Here is an alphabetically sorted list of all commands with references to their documentation: If in addition to the above argument specifiers brackets are used the argument is optional, unless they are placed between quotes in that case they are a mandatory part of the command argument. ![]() The starting curly brace has to directly follow the command, so without whitespace. If braces are also used for command options, here the braces are mandatory and just 'normal' characters. ![]() If (round) braces are used the argument extends until the end of the line on which the command was found. If braces are used the argument is a single word. Some commands have one or more arguments. References IndexList::addStyleSheetFile(), Definition::anchor(), MemberDef::argsString(), Config_getBool, Config_getString, convertToXML(), ResourceMgr::copyResource(), DefinitionIntf::definitionType(), endl(), err(), externalRef(), Definition::getBodyDef(), MemberDef::getClassDef(), MemberDef::getFileDef(), Definition::getLanguage(), getLanguageSpecificSeparator(), MemberDef::getNamespaceDef(), Definition::getOuterScope(), Definition::getOutputFileBase(), Definition::getReference(), Doxygen::globalScope, Doxygen::htmlFileExtension, SearchDefinitionList::id(), Doxygen::indexList, ResourceMgr::instance(), MemberDef::isFunction(), MemberDef::isSlot(), SearchIndexList::letter(), Definition::localName(), Definition::name(), SearchDefinitionList::name(), SearchIndexInfo::name, NUM_SEARCH_INDICES, Definition::qualifiedName(), theTranslator, Translator::trGlobalNamespace(), Translator::trLoading(), Translator::trNoMatches(), Translator::trSearching(), DefinitionIntf::TypeClass, DefinitionIntf::TypeMember, DefinitionIntf::TypeNamespace, and versionString.All commands in the documentation start with a backslash ( \) or an at-sign ( If you prefer you can replace all commands starting with a backslash below by their counterparts that start with an at-sign. References addMemberToSearchIndex(), LetterToIndexMap::append(), Doxygen::classSDict, Doxygen::functionNameSDict, getUtf8CodeToLower(), Doxygen::groupSDict, GroupDef::groupTitle(), Doxygen::inputNameList, isId(), PageDef::isLinkable(), GroupDef::isLinkable(), NamespaceDef::isLinkable(), FileDef::isLinkable(), ClassDef::isLinkable(), SDict::Iterator, SDict::Iterator, SDict::Iterator, SDict::Iterator, SDict::Iterator, Definition::localName(), Doxygen::mainPage, Doxygen::memberNameSDict, FileDef::name(), Definition::name(), SearchIndexInfo::name, Doxygen::namespaceSDict, NUM_SEARCH_INDICES, Doxygen::pageSDict, SEARCH_INDEX_ALL, SEARCH_INDEX_CLASSES, SEARCH_INDEX_DEFINES, SEARCH_INDEX_ENUMS, SEARCH_INDEX_ENUMVALUES, SEARCH_INDEX_EVENTS, SEARCH_INDEX_FILES, SEARCH_INDEX_FUNCTIONS, SEARCH_INDEX_GROUPS, SEARCH_INDEX_NAMESPACES, SEARCH_INDEX_PAGES, SEARCH_INDEX_PROPERTIES, SEARCH_INDEX_RELATED, SEARCH_INDEX_TYPEDEFS, SEARCH_INDEX_VARIABLES, SDict::sort(), SearchIndexInfo::symbolList, SearchIndexInfo::text, theTranslator, PageDef::title(), Translator::trAll(), Translator::trClasses(), Translator::trDefines(), Translator::trEnumerations(), Translator::trEnumerationValues(), Translator::trEvents(), Translator::trFile(), Translator::trFriends(), Translator::trFunctions(), Translator::trGroup(), Translator::trNamespace(), Translator::trPage(), Translator::trProperties(), Translator::trTypedefs(), and Translator::trVariables().ĭefinition at line 903 of file searchindex.cpp. #include #include #include #include #include " sortdict.h" #include " definition.h" #include " util.h"ĭefinition at line 718 of file searchindex.cpp.
0 Comments
Leave a Reply.AuthorWrite something about yourself. No need to be fancy, just an overview. ArchivesCategories |