浏览该文件的文档.
100 virtual bool isSlot()
const;
111 virtual bool isDCOP()
const;
138 virtual bool isCopy()
const;
141 virtual bool isWeak()
const;
145 virtual bool isNew()
const;
256 const QCString &fileName,
int startLine,
bool hasDocs,
318 bool inGroup,
bool showEnumValues=
FALSE,
bool
319 showInline=
FALSE)
const;
329 const std::unique_ptr<ArgumentList> &actualArgs)
const;
333 bool onlyText=
FALSE)
const;
356 const ArgumentList &al,
bool writeReqClause=
true)
const;
379 return new MemberDefImpl(defFileName,defLine,defColumn,type,name,args,excp,prot,virt,
380 stat,related,t,tal,al,metaData);
762 const std::unique_ptr<ArgumentList> &actualArgs)
const
795 if ((i=clRealName.
find(
'<'))!=-1)
797 clRealName=clRealName.
left(i);
799 if ((i=clRealName.
findRev(
"::"))!=-1)
801 clRealName=clRealName.
right(clRealName.
length()-i-2);
803 while ((i=s.
find(clRealName,p))!=-1)
805 result+=s.
mid(p,i-p);
810 result+=clRealName+t;
900 int il=cName.
find(
'<');
902 if (il!=-1 && ir!=-1 && ir>il)
904 cName=cName.
mid(il,ir-il+1);
921 bool paramTypeStarted=
FALSE;
923 auto alIt = defArgList.
begin();
924 while (alIt!=defArgList.
end())
927 if (isDefine || first)
930 paramTypeStarted=
TRUE;
955 if (paramTypeStarted)
958 paramTypeStarted=
FALSE;
999 if (alIt!=defArgList.
end())
1011 if (key!=
",") key+=
":";
1014 if (paramTypeStarted)
1019 paramTypeStarted=
TRUE;
1079 int index = exception.
find(
'(');
1084 for (
int comma = exception.
find(
',', index); comma!=-1; )
1088 exception.
mid(index,comma-index));
1091 comma = exception.
find(
',', index);
1093 int close = exception.
find(
')', index);
1103 "missing ) in exception list on member %s",
qPrint(md->
name()));
1116 if (
'{'==exception.
at(0))
1119 int index = exception.
find(
';');
1126 index = exception.
find(
';',oldIndex);
1311 if (type.
isEmpty()) decl=d->
name()+args;
else decl=type+
" "+d->
name()+args;
1329 cachedAnonymousType=0;
1332 docEnumValues=
FALSE;
1347 docsForDefinition =
TRUE;
1349 cachedTypedefValue = 0;
1353 hasDocumentedParams =
FALSE;
1354 hasDocumentedReturnType =
FALSE;
1395 m_impl->
init(
this,t,a,e,p,v,s,r,mt,tal,al,meta);
1488 const ClassDef *mcd = md->getClassDef();
1519 static bool separateMemberPages =
Config_getBool(SEPARATE_MEMBER_PAGES);
1520 static bool inlineSimpleClasses =
Config_getBool(INLINE_SIMPLE_STRUCTS);
1545 if (inlineSimpleClasses && classDef->
isSimple())
1562 "Internal inconsistency: member %s does not belong to any"
1641 static bool extractPrivateVirtual =
Config_getBool(EXTRACT_PRIV_VIRTUAL);
1691 if (!groupDef && !nspace &&
1706 if (
m_impl->
stat && classDef==0 && !extractStatic)
1771 bool onlyText)
const
1779 if (!hideScopeNames)
1789 else if (nspace && (gd || fd))
1854 std::string stype = ltype.
str();
1855 static const reg::Ex r(R
"([\w@:]*@\d+[\w@:]*)");
1868 if (annoClassDef==0)
1875 return annoClassDef;
1884 static bool extractPrivateVirtual =
Config_getBool(EXTRACT_PRIV_VIRTUAL);
1885 static bool hideUndocMembers =
Config_getBool(HIDE_UNDOC_MEMBERS);
1888 static bool hideFriendCompounds =
Config_getBool(HIDE_FRIEND_COMPOUNDS);
1900 auto &info = it->second;
1903 hasDocs = hasDocs ||
1905 (
m_impl->
grpId!=-1 && !(info->doc.isEmpty() && info->header.isEmpty()));
1917 bool visibleIfDocumented = (!hideUndocMembers ||
1924 bool visibleIfEnabled = !(hideUndocMembers &&
1931 bool visibleIfFriendCompound = !(hideFriendCompounds &&
1959 bool visibleIfNotDefaultCDTor = !(cOrDTor &&
1974 bool visible = visibleIfStatic && visibleIfDocumented &&
1975 visibleIfEnabled && visibleIfPrivate &&
1976 visibleIfNotDefaultCDTor &&
1977 visibleIfFriendCompound &&
2027 for (
auto it = al.
begin(); it!=al.
end();)
2065 bool inGroup,
int indentLevel,
const ClassDef *inheritedFrom,
const QCString &inheritId)
const
2075 ASSERT (cd!=0 || nd!=0 || fd!=0 || gd!=0);
2076 if (cd) d=cd;
else if (nd) d=nd;
else if (fd) d=fd;
else d=gd;
2102 bool writeAnchor = (inGroup ||
getGroupDef()==0) &&
2115 if (!detailsVisible)
2128 for (j=0;j<indentLevel;j++)
2155 static const reg::Ex r(R
"(@\d+)");
2157 std::string stype = ltype.str();
2158 bool endAnonScopeNeeded=
FALSE;
2161 int i = (int)
match.position();
2162 int l = (int)
match.length();
2175 for (j=0;j< indentLevel;j++)
2186 else if (!varName.
isEmpty() && (varName.
at(0)==
'*' || varName.
at(0)==
'&'))
2191 endAnonScopeNeeded=
TRUE;
2221 else if (ltype==
"@")
2241 if (htmlOn && !ltype.
isEmpty())
2267 static bool extractPrivateVirtual =
Config_getBool(EXTRACT_PRIV_VIRTUAL);
2271 if (!
name().isEmpty() &&
2375 ol.
docify(
" [implementation]");
2400 for (
const auto &s : sl)
2423 for (
const auto &s : sl)
2444 if (endAnonScopeNeeded)
2461 if (rootNode && !rootNode->isEmpty())
2497 static bool alwaysDetailedSec =
Config_getBool(ALWAYS_DETAILED_SEC);
2500 static bool hideUndocMembers =
Config_getBool(HIDE_UNDOC_MEMBERS);
2502 static bool extractPrivateVirtual =
Config_getBool(EXTRACT_PRIV_VIRTUAL);
2519 (alwaysDetailedSec &&
2567 if (!hideUndocMembers)
2570 docFilter = docFilter || docInfo;
2586 (docFilter && staticFilter && privateFilter && friendCompoundFilter && !
isHidden());
2597 static bool separateMemPages =
Config_getBool(SEPARATE_MEMBER_PAGES);
2598 static bool inlineSimpleStructs =
Config_getBool(INLINE_SIMPLE_STRUCTS);
2599 static bool hideUndocMembers =
Config_getBool(HIDE_UNDOC_MEMBERS);
2602 bool simpleFilter = (
hasBriefDescription() || !hideUndocMembers) && inlineSimpleStructs &&
2607 bool result = visible || simpleFilter;
2643 if (
isFriend()) sl.push_back(
"friend");
2644 else if (
isRelated()) sl.push_back(
"related");
2648 if (inlineInfo &&
isInline()) sl.push_back(
"inline");
2650 if (
isMutable()) sl.push_back(
"mutable");
2651 if (
isStatic()) sl.push_back(
"static");
2667 if (
isFinal()) sl.push_back(
"final");
2671 if (
isSealed()) sl.push_back(
"sealed");
2672 if (
isNew()) sl.push_back(
"new");
2680 if (
isAssign()) sl.push_back(
"assign");
2681 else if (
isCopy()) sl.push_back(
"copy");
2682 else if (
isRetain()) sl.push_back(
"retain");
2683 else if (
isWeak()) sl.push_back(
"weak");
2685 else if (
isUnretained()) sl.push_back(
"unsafe_unretained");
2693 if (lvirt==
Virtual) sl.push_back(
"virtual");
2694 else if (lvirt==
Pure) sl.push_back(
"pure virtual");
2695 if (
isSignal()) sl.push_back(
"signal");
2696 if (
isSlot()) sl.push_back(
"slot");
2697 if (
isDefault()) sl.push_back(
"default");
2698 if (
isDelete()) sl.push_back(
"delete");
2703 if (
isBound()) sl.push_back(
"bound");
2714 sl.push_back(
"implementation");
2723 sl.push_back(
"inherited");
2729 sl.push_back(
"implementation");
2742 warn_uncond(
"Call graph for '%s' not generated, too many nodes (%d), threshold is %d. Consider increasing DOT_GRAPH_MAX_NODES.\n",
2764 warn_uncond(
"Caller graph for '%s' not generated, too many nodes (%d), threshold is %d. Consider increasing DOT_GRAPH_MAX_NODES.\n",
2812 int markerPos = reimplFromLine.
find(
"@0");
2840 reimplFromLine.
length()-markerPos-2));
2845 err(
"translation error: no marker in trReimplementsFromList()\n");
2856 for (
const auto &bmd : bml)
2858 const ClassDef *bcd=bmd->getClassDef();
2875 auto replaceFunc = [&bml,&ol](
size_t entryIndex)
2878 auto it = bml.
begin();
2882 while (it!=bml.
end())
2888 if (cnt==entryIndex)
break;
3014 if (fmd->isLinkable())
3026 ol.
startDoxyAnchor(cfname,cname,fmd->anchor(),fmd->name(),fmd->argsString());
3036 bool hasBrief = !fmd->briefDescription().isEmpty();
3037 bool hasDetails = !fmd->documentation().isEmpty();
3081 ldef = title =
"anonymous enum";
3104 std::string sdef = ldef.
str();
3108 ldef =
match.prefix().str() +
" { ... } " +
match.suffix().str();
3115 int ep = ldef.
find(
"::");
3121 ldef=ldef.
left(sp+1)+ldef.
mid(ep+2);
3125 int dp = ldef.
find(
':');
3128 ldef=ldef.
left(dp+1);
3133 while (i>=0 && (
isId(ldef.
at(i)) || ldef.
at(i)==
':')) i--;
3153 static bool showGroupedMembInc =
Config_getBool(SHOW_GROUPED_MEMB_INC);
3157 if (inGroup && fd && showGroupedMembInc && !nm.
isEmpty())
3203 langCorrected =
".doxygen_lex_c";
3207 intf->resetCodeParserState();
3218 int memCount,
int memTotal,
3223 bool showEnumValues,
3228 bool hasParameterList =
FALSE;
3244 const Definition *scopedContainer = container;
3250 ciname = (
toGroupDef(container))->groupTitle();
3266 doxyName.
prepend(scopeName+sep);
3275 if (title.
at(0)==
'@')
3277 ldef = title =
"anonymous enum";
3299 if (ldef.
at(0)==
'@')
3323 bool htmlEndLabelTable=
FALSE;
3326 static const reg::Ex r(R
"(@\d+)");
3328 std::string sdef = ldef.str();
3333 for (
const auto &vmd : *ml)
3335 if (vmd->isEnumerate() &&
match.str()==vmd->name())
3339 std::string prefix =
match.prefix().str();
3340 std::string suffix =
match.suffix().str();
3359 std::string prefix =
match.prefix().str();
3360 std::string suffix =
match.suffix().str();
3361 ol.
docify(prefix.c_str());
3395 if (!first) ol.
docify(
" ");
3411 if (!first) ol.
docify(
" ");
3436 htmlEndLabelTable=
TRUE;
3443 int ep = ldef.
find(
"::");
3449 ldef=ldef.
left(sp+1)+ldef.
mid(ep+2);
3451 ldef=ldef.
mid(ep+2);
3455 int dp = ldef.
find(
':');
3458 ldef=ldef.
left(dp+1);
3463 while (i>=0 && (
isId(ldef.
at(i)) || ldef.
at(i)==
':')) i--;
3495 if (scope==0) scope = nd;
3507 if (scope==0) scope = nd;
3529 hasParameterList=
true;
3539 for (
const auto &s : sl)
3548 if (hasParameterList)
3563 if (htmlEndLabelTable)
3566 ol.
writeString(
" <td class=\"mlabels-right\">\n");
3569 for (
const auto &s : sl)
3601 scopedContainer,
this,
3627 scopedContainer,
this,
3651 for (
const Argument &a : docArgList)
3653 if (a.hasDocumentation())
3657 paramDocs+=
"@param"+direction+
" "+a.name+
" "+docsWithoutDir;
3701 static const reg::Ex re1(R
"(\a\w*::)");
3702 static const reg::Ex re2(R
"(\a\w*<[^>]*>::)");
3704 std::string t = ts.
str();
3707 t =
match.prefix().str() +
match.suffix().str();
3733 if (scope) cname = scope->
name();
3734 if (doxyName.
at(0)==
'@')
3736 doxyName=
"__unnamed__";
3754 const char *prefixes[] = {
"struct ",
"union ",
"class ", 0 };
3755 const char **p = prefixes;
3848 default:
return "unknown";
3882 name().find(
'@')==-1 && d && d->
name().
find(
'@')==-1 &&
3926 bool isFortranSubroutine = isFortran && returnType.
find(
"subroutine")!=-1;
3928 bool isVoidReturn = (returnType==
"void") || (returnType.
right(5)==
" void");
3929 if (!isVoidReturn && returnType ==
"auto")
3935 isVoidReturn = (strippedTrailingReturn==
"void") || (strippedTrailingReturn.
right(5)==
" void");
3954 for (
auto it = al.
begin(); it!=al.
end() && allDoc; ++it)
3958 !(isPython && (a.
name==
"self" || a.
name==
"cls"))
3966 if (!allDoc && declAl.
empty())
3969 for (
auto it = al.
begin(); it!=al.
end() && allDoc; ++it)
3973 !(isPython && (a.
name==
"self" || a.
name==
"cls"))
4000 isFortranSubroutine ||
4012 isFortranSubroutine ||
4035 "parameters of member %s are not (all) documented",
4042 "return type of member %s is not documented",
4052 int i=baseName.
find(
'<');
4053 if (i!=-1) baseName=baseName.
left(i);
4117 MD5Buffer((
const unsigned char *)memAnchor.
data(),memAnchor.
length(),md5_sig);
4118 MD5SigToString(md5_sig,sigStr);
4123 const QCString &fileName,
int startLine,
4166 const ArgumentList &formalArgs,
const std::unique_ptr<ArgumentList> &actualArgs)
const
4169 std::unique_ptr<ArgumentList> actualArgList = std::make_unique<ArgumentList>(
m_impl->
defArgList);
4173 for (
Argument &arg : *actualArgList)
4177 actualArgList->setTrailingReturnType(
4182 if (methodName.
left(9)==
"operator ")
4239 static bool optimizeOutputForC =
Config_getBool(OPTIMIZE_OUTPUT_FOR_C);
4246 if (optimizeOutputForC)
4278 memName =
"[" + pd->
name() +
" " +
name() +
"]";
4310 "Internal inconsistency: recursion detected in overload relation for member %s!"
4328 tagFile <<
" <member kind=\"";
4350 tagFile <<
"\" protection=\"";
4353 else tagFile <<
"private";
4357 tagFile <<
"\" virtualness=\"";
4359 else tagFile <<
"pure";
4363 tagFile <<
"\" static=\"yes";
4376 tagFile <<
" <clangid>" <<
convertToXML(idStr) <<
"</clangid>\n";
4383 if (!fmd->isReference())
4386 tagFile <<
"\" anchor=\"" <<
convertToXML(fmd->anchor());
4392 tagFile <<
"\">" <<
convertToXML(fmd->name()) <<
"</enumvalue>\n";
4397 tagFile <<
" </member>\n";
4415 else if (
name()==
"__init__" &&
4424 int i=locName.
find(
'<');
4461 else if (
name()==
"__del__" &&
4491 uint numVisibleEnumValues=0;
4494 if (fmd->isBriefSectionVisible()) numVisibleEnumValues++;
4528 if (numVisibleEnumValues>0 && enumValuesPerLine>0)
4547 if (numVisibleEnumValues>enumValuesPerLine
4548 && (enumMemCount%enumValuesPerLine)==0
4582 bool prevVisible = fmdVisible;
4600 if (numVisibleEnumValues>enumValuesPerLine)
4674 bool MemberDefImpl::protectionVisible()
const
4685 const QCString &docFile,
int docLine)
4687 m_impl->inbodyDocs = docs;
4688 m_impl->inbodyDocs =
m_impl->inbodyDocs.stripWhiteSpace();
4711 if (
isStatic()) qm=
"+";
else qm=
"-";
4746 if (
isStatic()) qm=
"+ ";
else qm=
"- ";
5286 auto decSrc = decAlSrc.
begin(), defSrc = defAlSrc.
begin();
5287 for (
auto decIt = decAl.
begin(), defIt = defAl.
begin();
5288 decIt != decAl.
end() && defIt != defAl.
end() && decSrc != decAlSrc.
end() && defSrc != defAlSrc.
end();
5289 ++decIt, ++defIt, ++decSrc, ++defSrc++)
5724 auto srcIt = srcAl.
begin();
5725 auto dstIt = dstAl.
begin();
5726 while ( srcIt!=srcAl.
end() && dstIt!=dstAl.
end())
5740 auto srcIt = srcAl.
begin();
5741 auto dstIt = dstAl.
begin();
5743 while ( srcIt!=srcAl.
end() && dstIt!=dstAl.
end())
5759 a.canType.resize(0);
5790 for (
auto decIt = decAl.
begin(), defIt = defAl.
begin();
5791 decIt!= decAl.
end() && defIt!= defAl.
end();
5983 static bool hideFriendCompounds =
Config_getBool(HIDE_FRIEND_COMPOUNDS);
6049 if (src==0 || dst==0)
return;
6117 return static_cast<const MemberDef*
>(d);
virtual void writeDocumentation(const MemberList *ml, int memCount, int memTotal, OutputList &ol, const QCString &scopeName, const Definition *container, bool inGroup, bool showEnumValues=FALSE, bool showInline=FALSE) const
virtual MemberDef * memberDefinition() const
virtual QCString trSubprogram(bool first_capital, bool singular)=0
Definition * toDefinition(DefinitionMutable *dm)
virtual const ArgumentList & typeConstraints() const
virtual QCString briefFile() const
void startParameterType(bool first, const QCString &key)
virtual bool isDestructor() const
virtual void addSourceReferences(const MemberDef *d)=0
RefQualifierType refQualifier() const
ArgumentList typeConstraints
void combineDeclarationAndDefinition(MemberDefMutable *mdec, MemberDefMutable *mdef)
std::vector< std::string > StringVector
QCString trailingReturnType() const
void _writeTemplatePrefix(OutputList &ol, const Definition *def, const ArgumentList &al, bool writeReqClause=true) const
virtual bool hasUserDocumentation() const
QCString explicitOutputFileBase
void startParameterName(bool one)
void disableAllBut(OutputGenerator::OutputType o)
virtual bool isConstExpr() const
virtual bool isReference() const
virtual void setPrototype(bool p, const QCString &df, int line, int column)
const MemberDef * redefines
virtual Protection protection() const
virtual ClassDef * relatedAlso() const
virtual bool isOverride() const
void startMemberDescription(const QCString &anchor, const QCString &inheritId=QCString(), bool typ=false)
virtual bool isDCOP() const =0
ArgumentLists defTmpArgLists
virtual CodeSymbolType codeSymbolType() const
virtual ~MemberDefAliasImpl()
void init(Definition *def, const QCString &t, const QCString &a, const QCString &e, Protection p, Specifier v, bool s, Relationship r, MemberType mt, const ArgumentList &tal, const ArgumentList &al, const QCString &meta)
virtual void detectUndocumentedParams(bool hasParamCommand, bool hasReturnCommand) const
virtual bool isMaybeAmbiguous() const
void writeMarkerList(OutputList &ol, const std::string &markerText, size_t numMarkers, std::function< void(size_t)> replaceFunc)
virtual bool isTypedef() const =0
virtual bool hasCallerGraph() const
static const uint64 Override
virtual bool isGettable() const
virtual bool hasSourceReffedBy() const
virtual void writeMemberDocSimple(OutputList &ol, const Definition *container) const
virtual QCString getWriteAccessor() const
This struct is used to capture the tag file information for an Entry.
virtual int getDeclColumn() const =0
virtual void setEnumBaseType(const QCString &type)
virtual QCString getOutputFileBase() const =0
QCString stripAnonymousNamespaceScope(const QCString &s)
virtual void setCategory(ClassDef *)
virtual bool isSignal() const
virtual int initializerLines() const
virtual QCString getReadAccessor() const
virtual bool isDefine() const
GroupDef * toGroupDef(Definition *d)
virtual bool isVariable() const
virtual void writeLink(OutputList &ol, const ClassDef *cd, const NamespaceDef *nd, const FileDef *fd, const GroupDef *gd, bool onlyText=FALSE) const
void startAnonTypeScope(int i1)
virtual QCString argsString() const
virtual bool isGettable() const
virtual int docLine() const =0
virtual bool isRetain() const
virtual bool hasExamples() const
virtual void mergeMemberSpecifiers(uint64 s)=0
virtual int getDeclLine() const =0
virtual bool isEnumerate() const
virtual const QCString & initializer() const
virtual void makeRelated()
virtual void setMemberGroup(MemberGroup *grp)
MemberDefMutable * toMemberDefMutable(Definition *d)
virtual bool isConstrained() const =0
void endMemberDeclaration(const QCString &anchor, const QCString &inheritId)
virtual DefType definitionType() const
virtual void writeEnumDeclaration(OutputList &typeDecl, const ClassDef *cd, const NamespaceDef *nd, const FileDef *fd, const GroupDef *gd) const
static const uint64 Initonly
virtual QCString anchor() const =0
virtual bool isObjCMethod() const
virtual CodeSymbolType codeSymbolType() const
virtual bool hasReferencedByRelation() const =0
virtual void makeImplementationDetail()
virtual void setBitfields(const QCString &s)
virtual QCString getGroupFileName() const
Protection
Protection level of members
virtual MemberDef * memberDeclaration() const
virtual bool isExplicit() const
virtual QCString argsString() const =0
virtual const MemberList * getSectionList(const Definition *container) const
virtual void setMemberGroupId(int id)
virtual void setDefFile(const QCString &df, int defLine, int defColumn)
virtual bool isLinkable() const
virtual bool isNonAtomic() const
virtual QCString briefDescription(bool abbr=FALSE) const =0
virtual bool isNotFriend() const
virtual bool isDestructor() const =0
The common base class of all entity definitions found in the sources.
virtual QCString documentation() const =0
virtual const MemberDef * getAnonymousEnumType() const
virtual ClassDef * categoryOf() const =0
Returns the class of which this is a category (Objective-C only)
virtual QCString documentation() const
virtual bool isSignal() const =0
virtual bool isObjCProperty() const =0
virtual const RefItemVector & xrefListItems() const
void startDoxyAnchor(const QCString &fName, const QCString &manName, const QCString &anchor, const QCString &name, const QCString &args)
virtual bool isConstExpr() const
virtual bool isDefault() const =0
static bool writeDefArgumentList(OutputList &ol, const Definition *scope, const MemberDef *md)
static void writeExceptionListImpl(OutputList &ol, const ClassDef *cd, const MemberDef *md, QCString const &exception)
virtual bool isStatic() const =0
An abstract interface of a namespace symbol.
void endDoxyAnchor(const QCString &fn, const QCString &anchor)
static std::mutex g_cachedAnonymousTypeMutex
virtual void setMemberClass(const ClassDef *cd)
virtual bool isBriefSectionVisible() const
virtual bool isMaybeDefault() const
virtual bool isAssign() const
virtual bool hasOneLineInitializer() const
void docify(const QCString &s)
virtual bool isMaybeDefault() const =0
static const uint64 Retain
virtual int getMemberGroupId() const =0
bool hasReferencesRelation
virtual QCString name() const
virtual void writeDocAnchorsToTagFile(TextStream &fs) const
virtual bool isBound() const
static bool writeVHDLTypeDocumentation(const MemberDef *mdef, const Definition *d, OutputList &ol)
virtual bool isFriendToHide() const
QCString substituteTemplateArgumentsInString(const QCString &nm, const ArgumentList &formalArgs, const std::unique_ptr< ArgumentList > &actualArgs)
void startInlineMemberType()
virtual Grouping::GroupPri_t getGroupPri() const =0
uint length() const
Returns the length of the string, not counting the 0-terminator.
static const uint64 Unretained
virtual bool isMaybeVoid() const =0
const ClassDef * classDef
virtual bool isLinkableInProject() const
virtual int numberOfFlowKeyWords() const =0
virtual bool hasExamples() const
virtual void mergeRefItems(Definition *d)=0
static const uint64 Readonly
virtual MemberDef * memberDefinition() const
static const uint64 Assign
This class represents an function or template argument list.
virtual bool isAttribute() const =0
virtual void writeEnumDeclaration(OutputList &typeDecl, const ClassDef *cd, const NamespaceDef *nd, const FileDef *fd, const GroupDef *gd) const =0
virtual QCString getGroupFileName() const =0
virtual void setTagInfo(const TagInfo *i)
void endMemberDescription()
virtual QCString getReference() const
virtual QCString compoundTypeString() const =0
Returns the type of compound as a string
virtual const GroupDef * getGroupDef() const
virtual const ArgumentList & argumentList() const
virtual bool isPrivateGettable() const
virtual QCString trCallGraph()=0
virtual bool isDocsForDefinition() const
virtual bool isInitonly() const =0
virtual ClassDef * getClassDefOfAnonymousType() const
virtual bool isBriefSectionVisible() const
virtual bool isStatic() const
virtual ClassDef * category() const
virtual StringVector getLabels(const Definition *container) const =0
virtual int getDefLine() const =0
int findRev(char c, int index=-1, bool cs=TRUE) const
virtual bool isUNOProperty() const
static void writeSource(const MemberDefMutable *mdef, OutputList &ol, const QCString &cname)
virtual void writeTagFile(TextStream &) const
virtual QCString docFile() const
virtual bool isImplementation() const
bool isEmpty() const
Returns TRUE iff the string is empty
virtual bool isForeign() const
virtual void setMemberDeclaration(MemberDef *md)
virtual void setDeclFile(const QCString &df, int line, int column)
bool match(const std::string &str, Match &match, const Ex &re)
Matches a given string str for a match against regular expression re.
virtual const FileDef * getFileDef() const
virtual void setAnonymousUsed() const
virtual QCString qualifiedName() const
void writeLabel(const QCString &l, bool isLast)
virtual ClassDef * getClassDefOfAnonymousType() const
virtual int getDeclColumn() const
virtual bool fromAnonymousScope() const
virtual bool hasDocumentedEnumValues() const =0
static const uint64 Property
virtual bool isExternal() const
static const uint64 Final
virtual const MemberDef * inheritsDocsFrom() const =0
virtual bool isVariable() const
virtual bool isNonAtomic() const =0
void endMemberDocPrefixItem()
virtual bool isRelatedOrFriend() const
void writeString(const QCString &text)
virtual bool isRelated() const
virtual QCString argsString() const
virtual bool isReadable() const
void insertMemberAlign(bool templ=FALSE)
virtual void setBriefDescription(const QCString &b, const QCString &briefFile, int briefLine)
virtual const MemberDef * getAnonymousEnumType() const
virtual bool isAssign() const
Implements TextGeneratorIntf for an OutputDocInterface stream.
virtual bool isConstrained() const
virtual ClassDef * getClassDefOfAnonymousType() const =0
virtual int getDefLine() const
virtual bool isSealed() const
virtual void setFromAnonymousMember(MemberDef *m)
virtual void incrementFlowKeyWordCount()
virtual void insertReimplementedBy(const MemberDef *md)
virtual const MemberDef * getAnonymousEnumType() const =0
virtual bool isUnretained() const
MemberDef * toMemberDef(Definition *d)
virtual QCString bitfieldString() const =0
QCString cachedResolvedType
void push_back(const MemberDef *md)
virtual bool hasReferencedByRelation() const
virtual bool hasMultiLineInitializer() const =0
virtual bool isObjCProperty() const
bool hasReferencedByRelation
virtual QCString getCachedResolvedTypedef() const
virtual bool isReadonly() const
virtual QCString id() const
SrcLangExt
Language as given by extension
virtual void setTemplateSpecialization(bool b)
virtual bool isSettable() const
virtual const ArgumentList & typeConstraints() const =0
virtual const NamespaceDef * getNamespaceDef() const
virtual bool isSlot() const
virtual bool isPrototype() const =0
virtual void setAnonymousUsed() const =0
static NamespaceDefMutable * globalScope
virtual void moveArgumentList(std::unique_ptr< ArgumentList > al)
ClassDef * cachedAnonymousType
virtual QCString fieldType() const
virtual QCString getCachedTypedefTemplSpec() const
virtual Definition * getOuterScope() const
virtual bool isMaybeDefault() const
void _writeReimplementedBy(OutputList &ol) const
void writeTypeConstraints(OutputList &ol, const Definition *d, const ArgumentList &al)
virtual QCString memberTypeName() const
virtual bool isConstrained() const
virtual bool isFriendClass() const
virtual bool isDelete() const =0
virtual bool isTypedef() const
virtual const MemberVector & enumFieldList() const
virtual bool isOptional() const
virtual bool isInline() const =0
virtual QCString getDeclType() const
virtual const MemberDef * getGroupAlias() const
virtual ClassDef * accessorClass() const
void addDocCrossReference(MemberDefMutable *src, MemberDefMutable *dst)
virtual bool isMutable() const
void endParameterName(bool last, bool one, bool bracket)
Specifier
Virtualness of a member.
virtual int numberOfFlowKeyWords() const
virtual bool isSealed() const
virtual bool isFriendClass() const =0
virtual bool isLinkableInProject() const =0
returns TRUE iff a link is possible to this item within this project.
void startMemberTemplateParams()
virtual bool isPrototype() const
virtual bool isProperty() const
static const uint64 Settable
virtual bool hasCallerGraph() const
virtual int getGroupStartLine() const
void warn_doc_error(const QCString &file, int line, const char *fmt,...)
bool hasDocumentation() const
virtual MemberDef * deepCopy() const
virtual bool hasSources() const
virtual SrcLangExt getLanguage() const
virtual bool isDocumentedFriendClass() const
virtual bool isProtectedGettable() const =0
virtual const ClassDef * getClassDef() const
static const uint64 Sealed
virtual QCString trEnumerationValues()=0
virtual void invalidateCachedArgumentTypes()
virtual bool isReadable() const
virtual Protection protection() const
virtual bool isTypeAlias() const
virtual bool isUnretained() const
virtual bool isRetain() const =0
virtual const ClassDef * accessorClass() const =0
static bool parseSourcesNeeded
virtual bool isReadonly() const
virtual bool isSlot() const
virtual bool isLinkableInProject() const =0
void addIndexItem(const QCString &s1, const QCString &s2)
void err(const char *fmt,...)
virtual bool getGroupHasDocs() const
virtual int inbodyLine() const =0
virtual bool isFunctionPtr() const
virtual bool isFunctionOrSignalSlot() const
virtual void setDocsForDefinition(bool b)=0
virtual bool isLinkable() const =0
virtual const GroupDef * getGroupDef() const
virtual const ExampleList & getExamples() const
void _writeGroupInclude(OutputList &ol, bool inGroup) const
char & at(size_t i)
Returns a reference to the character at index i.
virtual QCString enumBaseType() const
Text streaming class that buffers data.
virtual QCString name() const
virtual QCString requiresClause() const
virtual QCString declaration() const
virtual bool isMutable() const
MemberDefMutable * createMemberDef(const QCString &defFileName, int defLine, int defColumn, const QCString &type, const QCString &name, const QCString &args, const QCString &excp, Protection prot, Specifier virt, bool stat, Relationship related, MemberType t, const ArgumentList &tal, const ArgumentList &al, const QCString &metaData)
Factory method to create a new instance of a MemberDef
virtual QCString extraTypeChars() const
virtual QCString getDefFileName() const
int find(char c, int index=0, bool cs=TRUE) const
virtual bool visibleMemberGroup(bool hideNoHeader) const
virtual void insertReimplementedBy(const MemberDef *md)=0
virtual void enableReferencedByRelation(bool e)
MemberDefImpl(const QCString &defFileName, int defLine, int defColumn, const QCString &type, const QCString &name, const QCString &args, const QCString &excp, Protection prot, Specifier virt, bool stat, Relationship related, MemberType t, const ArgumentList &tal, const ArgumentList &al, const QCString &metaData)
virtual bool hasMultiLineInitializer() const
virtual int briefLine() const =0
virtual bool isRequired() const
virtual bool isDictionary() const =0
virtual const MemberDef * getGroupAlias() const =0
virtual void setBriefDescription(const QCString &b, const QCString &briefFile, int briefLine)=0
static const uint64 Default
virtual QCString fieldType() const
static void transferArgumentDocumentation(ArgumentList &decAl, ArgumentList &defAl)
ClassDef * getClass(const QCString &n)
virtual QCString displayDefinition() const
virtual int briefLine() const
bool volatileSpecifier() const
virtual void setReadAccessor(const QCString &r)
virtual bool isProperty() const =0
const MemberDef * getMdAlias() const
virtual const MemberDef * categoryRelation() const
virtual bool isSimple() const =0
virtual bool isWeak() const =0
virtual void setGroupDef(const GroupDef *gd, Grouping::GroupPri_t pri, const QCString &fileName, int startLine, bool hasDocs, MemberDef *member=0)
virtual bool showInCallGraph() const
virtual bool fromAnonymousScope() const
virtual QCString getOutputFileBase() const
virtual bool isLinkableInProject() const =0
virtual bool anonymousDeclShown() const =0
virtual const QCString & docName() const =0
virtual QCString memberTypeName() const
virtual bool isSliceLocal() const =0
virtual bool hasBriefDescription() const
void writeDoc(DocRoot *root, const Definition *ctx, const MemberDef *md, int id=0)
virtual const ArgumentList & templateArguments() const
virtual QCString docFile() const =0
virtual QCString getReference() const =0
virtual const NamespaceDef * getNamespaceDef() const
virtual bool isWeak() const
virtual bool isMaybeAmbiguous() const
virtual QCString trGlobal(bool first_capital, bool singular)=0
virtual QCString definition() const
bool protectionLevelVisible(Protection prot)
virtual bool hasExamples() const =0
void warn(const QCString &file, int line, const char *fmt,...)
virtual SrcLangExt getLanguage() const =0
Returns the programming language this definition was written in.
virtual bool isObjCMethod() const
virtual bool isFriendToHide() const
virtual QCString trImplementedFromList(int numEntries)=0
static const uint64 Alias
virtual Specifier virtualness(int count) const
virtual int getDeclLine() const
virtual bool showInCallGraph() const =0
bool hasParameters() const
virtual bool isObjCMethod() const =0
void _computeIsConstructor()
virtual bool visibleInIndex() const
virtual void setMemberType(MemberType t)
virtual bool isRelated() const
virtual int inbodyLine() const
const MemberDef * annEnumType
virtual bool isSequence() const =0
static const uint64 PrivateGettable
virtual QCString trReimplementedInList(int numEntries)=0
virtual MemberGroup * getMemberGroup() const
MemberGroup * m_memberGroup
static const uint64 Required
virtual void setFromAnonymousScope(bool b) const
static const uint64 MaybeDefault
virtual QCString getDeclFileName() const
virtual void invalidateTypedefValCache()
DirIterator end(const DirIterator &) noexcept
virtual void setMemberSpecifiers(uint64 s)
virtual bool isDefault() const
virtual StringVector getLabels(const Definition *container) const
virtual bool isDeleted() const
virtual QCString getReadAccessor() const =0
virtual void setHidden(bool b)
virtual MemberDef * fromAnonymousMember() const
int contains(char c, bool cs=TRUE) const
virtual bool isHidden() const
virtual bool isLinkable() const =0
virtual bool isConstExpr() const =0
virtual MemberType memberType() const
virtual bool isStrongEnumValue() const =0
virtual bool isBriefSectionVisible() const =0
A model of a group of symbols.
virtual bool isForeign() const
virtual int getDeclLine() const
virtual void setBodyDef(const FileDef *fd)=0
virtual bool isRemovable() const
virtual bool isNew() const =0
void _computeIsDestructor()
virtual QCString qualifiedName() const
virtual bool isTypedefValCached() const =0
virtual bool isStrongEnumValue() const
virtual QCString briefDescription(bool abbr=FALSE) const
virtual QCString getReadAccessor() const
virtual bool isDeleted() const
void _writeCategoryRelation(OutputList &ol) const
static const uint64 Optional
virtual bool isLinkableInProject() const =0
MemberDef * createMemberDefAlias(const Definition *newScope, const MemberDef *aliasMd)
virtual QCString anchor() const =0
virtual StringVector getLabels(const Definition *container) const
virtual bool isRequired() const =0
virtual void setInitializer(const QCString &i)
virtual const FileDef * getBodyDef() const =0
virtual const ArgumentLists & definitionTemplateParameterLists() const =0
virtual bool isTransient() const
Class representing a list of output generators that are written to in parallel.
virtual bool isTransient() const
virtual QCString typeString() const
virtual QCString documentation() const
void startMemberDocName(bool align)
virtual bool isEnumValue() const
virtual MemberDef * memberDeclaration() const =0
QCString addHtmlExtensionIfMissing(const QCString &fName)
A model of a class/file/namespace member symbol.
virtual void detectUndocumentedParams(bool hasParamCommand, bool hasReturnCommand) const
void warn_uncond(const char *fmt,...)
virtual void writeSourceDef(OutputList &ol, const QCString &scopeName) const
virtual void writeInlineCode(OutputList &ol, const QCString &scopeName) const
virtual void writeDeclaration(OutputList &ol, const ClassDef *cd, const NamespaceDef *nd, const FileDef *fd, const GroupDef *gd, bool inGroup, int indentLevel, const ClassDef *inheritFrom=0, const QCString &inheritId=QCString()) const
virtual bool hasCallerGraph() const =0
virtual const MemberDef * reimplements() const
virtual void setSectionList(const Definition *container, const MemberList *sl)
virtual QCString briefDescription(bool abbreviate=FALSE) const
static const uint64 Raisable
virtual bool isSequence() const
virtual void writeEnumDeclaration(OutputList &typeDecl, const ClassDef *cd, const NamespaceDef *nd, const FileDef *fd, const GroupDef *gd) const
virtual bool isRemovable() const
virtual void setMemberDefinition(MemberDef *md)=0
A abstract class representing of a compound symbol.
virtual const ClassDef * getCachedTypedefVal() const =0
virtual MemberDefMutable * createTemplateInstanceMember(const ArgumentList &formalArgs, const std::unique_ptr< ArgumentList > &actualArgs) const =0
void startParameterList(bool openBracket)
QCString stripWhiteSpace() const
returns a copy of this string with leading and trailing whitespace removed
#define Config_getInt(name)
static bool isspace(char c)
virtual bool isReference() const
virtual MemberDef * fromAnonymousMember() const =0
void inSort(const MemberDef *md)
virtual bool isImplementation() const
virtual bool isFriend() const =0
virtual bool isNoExcept() const
void startMemberItem(const QCString &anchor, int i1, const QCString &id=QCString())
void disable(OutputGenerator::OutputType o)
virtual bool isPrivateGettable() const
virtual QCString trExtendsClass()=0
const MemberDef * templateMaster
virtual int getDeclColumn() const
void exceptionEntry(const QCString &prefix, bool closeBracket)
virtual ClassDef * relatedAlso() const =0
QCString left(size_t len) const
virtual bool isFriend() const
static const uint64 Inline
static const uint64 Constrained
virtual bool isNonAtomic() const
virtual void warnIfUndocumented() const
virtual DefType definitionType() const
virtual QCString excpString() const =0
virtual QCString anchor() const
void _writeEnumValues(OutputList &ol, const Definition *container, const QCString &cfname, const QCString &ciname, const QCString &cname) const
virtual bool isDefine() const =0
virtual Specifier virtualness(int count=0) const =0
void _writeExamples(OutputList &ol) const
virtual bool isRaisable() const =0
virtual QCString inbodyDocumentation() const
virtual bool isVariable() const =0
virtual const MemberVector & enumFieldList() const =0
virtual bool isOverride() const
virtual void setDefinitionTemplateParameterLists(const ArgumentLists &lists)
static ParserManager * parserManager
virtual bool isAnonymous() const =0
virtual QCString trMore()=0
virtual bool isProtectedGettable() const
virtual bool isFriendClass() const
virtual QCString getOutputFileBase() const =0
Returns the unique base name (without extension) of the class's file on disk
virtual int getStartBodyLine() const
virtual void setRelatedAlso(ClassDef *cd)
virtual bool isReimplementedBy(const ClassDef *cd) const
virtual bool isNotFriend() const =0
virtual bool isFunction() const
virtual bool getGroupHasDocs() const =0
virtual bool isConstructor() const =0
virtual bool isObjCProperty() const
virtual void insertEnumField(const MemberDef *md)
static const uint64 ConstExpr
virtual int initializerLines() const =0
virtual void setArgsString(const QCString &as)
Representation of an call graph
virtual void setDocumentation(const QCString &d, const QCString &docFile, int docLine, bool stripWhiteSpace=TRUE)
virtual MemberDef * deepCopy() const
virtual bool isSignal() const
virtual bool isReference() const =0
virtual bool isSlot() const =0
static const uint64 MaybeVoid
QCString simplifyWhiteSpace() const
return a copy of this string with leading and trailing whitespace removed and multiple whitespace cha...
virtual bool isWritable() const
virtual bool isAttribute() const
virtual bool isPrivateSettable() const
QCString removeRedundantWhiteSpace(const QCString &s)
virtual bool isExplicit() const
virtual bool visibleMemberGroup(bool hideNoHeader) const
uchar m_isConstructorCached
virtual void enableCallerGraph(bool e)
virtual QCString displayName(bool=TRUE) const =0
virtual MemberDef * memberDeclaration() const
virtual bool isReimplementedBy(const ClassDef *cd) const =0
void lineBreak(const QCString &style=QCString())
Translator * theTranslator
virtual bool isFriendToHide() const =0
virtual QCString displayName(bool includeScope=TRUE) const =0
virtual const ArgumentLists & definitionTemplateParameterLists() const
virtual QCString inbodyDocumentation() const =0
virtual bool isBound() const
virtual void setInbodyDocumentation(const QCString &d, const QCString &inbodyFile, int inbodyLine)
virtual bool isAddable() const
virtual void setMemberDeclaration(MemberDef *md)=0
virtual const MemberVector & enumFieldList() const
virtual void makeForeign()
bool hasDocumentedReturnType
virtual QCString name() const =0
virtual MemberDef * resolveAlias()
static const uint64 Abstract
virtual bool isObjectiveC() const =0
Returns TRUE if this class is implemented in Objective-C
static void invalidateCachedTypesInArgumentList(ArgumentList &al)
virtual bool isFunctionOrSignalSlot() const
virtual const ArgumentList & declArgumentList() const
virtual bool visibleMemberGroup(bool hideNoHeader) const =0
virtual bool fromAnonymousScope() const =0
virtual bool isRelatedOrFriend() const =0
virtual QCString getCachedTypedefTemplSpec() const
virtual bool isDocumentedFriendClass() const =0
virtual QCString inbodyFile() const =0
virtual bool livesInsideEnum() const
This class contains the information about the argument of a function or template
virtual void setCategoryRelation(const MemberDef *)
virtual int getEndBodyLine() const
virtual bool hasReferencesRelation() const
virtual bool isAbstract() const
virtual QCString definition() const =0
virtual const ClassDef * getClassDef() const =0
virtual bool isExternal() const
virtual void setInbodyDocumentation(const QCString &d, const QCString &inbodyFile, int inbodyLine)=0
GroupPri_t
Grouping priority
virtual void setEnumClassScope(const ClassDef *cd)
virtual bool isFinal() const =0
void _writeTagData(const DefType) const
static const uint64 Explicit
virtual void setBriefDescription(const QCString &brief, const QCString &briefFile, int briefLine)
QCString extractDirection(QCString &docs)
Strip the direction part from docs and return it as a string in canonical form The input docs string ...
virtual QCString trProvidedByCategory()=0
virtual const MemberDef * categoryRelation() const
virtual bool isFunction() const
virtual void resolveUnnamedParameters(const MemberDef *md)
virtual const MemberDef * templateMaster() const =0
virtual void warnIfUndocumented() const
virtual bool isEnumStruct() const
virtual const ExampleList & getExamples() const =0
DocRoot * validatingParseDoc(IDocParser &parserIntf, const QCString &fileName, int startLine, const Definition *ctx, const MemberDef *md, const QCString &input, bool indexWords, bool isExample, const QCString &exampleName, bool singleLine, bool linkFromIndex, bool markdownSupport)
virtual bool isMutable() const =0
virtual bool isSettable() const
virtual bool hasDocumentation() const =0
virtual QCString getReference() const
virtual bool isSliceLocal() const
virtual const ClassDef * getCachedTypedefVal() const
virtual ArgumentLists getTemplateParameterLists() const =0
Returns the template parameter lists that form the template declaration of this class.
virtual QCString trVhdlType(uint64 type, bool single)=0
static MemberGroupInfoMap memberGroupInfoMap
virtual int getDefColumn() const
void warn_undoc(const QCString &file, int line, const char *fmt,...)
virtual bool isInline() const
virtual const ClassDef * accessorClass() const
virtual const MemberDef * templateMaster() const
QCString getLanguageSpecificSeparator(SrcLangExt lang, bool classScope)
Returns the scope separator to use given the programming language lang
virtual void enableReferencesRelation(bool e)=0
virtual bool isFunction() const =0
virtual bool isSequence() const
virtual void setGroupDef(const GroupDef *gd, Grouping::GroupPri_t pri, const QCString &fileName, int startLine, bool hasDocs, MemberDef *member=0)=0
virtual bool isBaseClass(const ClassDef *bcd, bool followInstances, int level=0) const =0
Returns TRUE iff bcd is a direct or indirect base class of this class.
virtual bool isDocumentedFriendClass() const
static const uint64 Removable
MemberDefImpl & operator=(const MemberDefImpl &)
virtual bool livesInsideEnum() const
void endAnonTypeScope(int i1)
virtual bool isReimplementedBy(const ClassDef *cd) const
static QCString addTemplateNames(const QCString &s, const QCString &n, const QCString &t)
Object representing the matching results.
virtual void setWriteAccessor(const QCString &w)
std::unique_ptr< CodeParserInterface > getCodeParser(const QCString &extension)
Gets the interface to the parser associated with a given extension.
virtual int getMemberGroupId() const
void linkifyText(const TextGeneratorIntf &out, const Definition *scope, const FileDef *fileScope, const Definition *self, const QCString &text, bool autoBreak, bool external, bool keepSpaces, int indentLevel)
SrcLangExt getLanguageFromFileName(const QCString &fileName, SrcLangExt defLang)
virtual QCString briefDescription(bool abbreviate=FALSE) const =0
virtual void setMemberGroup(MemberGroup *grp)
virtual bool isReference() const
virtual QCString displayName(bool=TRUE) const
virtual bool isDictionary() const
virtual int getStartBodyLine() const =0
virtual bool showInCallGraph() const
A vector of MemberDef object
virtual int getEndBodyLine() const =0
virtual const NamespaceDef * getNamespaceDef() const =0
virtual void warnIfUndocumentedParams() const
virtual MemberDef * resolveAlias()
virtual bool hasOneLineInitializer() const
static const uint64 Delete
virtual bool isDeleted() const =0
virtual bool isPublished() const =0
virtual const MemberList * getSectionList(const Definition *) const
virtual void setDocumentation(const QCString &doc, const QCString &docFile, int docLine, bool stripWhiteSpace=TRUE)
virtual bool isTemplateSpecialization() const
QCString tempArgListToString(const ArgumentList &al, SrcLangExt lang, bool includeDefault)
virtual bool isWeak() const
const MemberDef * groupAlias
virtual const MemberVector & reimplementedBy() const
static const uint64 ProtectedGettable
virtual bool isWritable() const
virtual void setNamespace(const NamespaceDef *nd)
bool constSpecifier() const
virtual QCString memberTypeName() const =0
virtual QCString bitfieldString() const
static const uint64 Gettable
virtual const MemberDef * reimplements() const =0
virtual bool isTypeAlias() const =0
void writeExamples(OutputList &ol, const ExampleList &list)
virtual void writeDeclaration(OutputList &ol, const ClassDef *cd, const NamespaceDef *nd, const FileDef *fd, const GroupDef *gd, bool inGroup, int indentLevel, const ClassDef *inheritFrom=0, const QCString &inheritId=QCString()) const
virtual Protection protection() const =0
virtual bool isProtectedGettable() const
virtual void moveTo(Definition *)
ClassDef * toClassDef(Definition *d)
virtual void setTemplateMaster(const MemberDef *mt)
QCString cachedTypedefTemplSpec
virtual void writeDeclaration(OutputList &ol, const ClassDef *cd, const NamespaceDef *nd, const FileDef *fd, const GroupDef *gd, bool inGroup, int indentLevel=0, const ClassDef *inheritFrom=0, const QCString &inheritId=QCString()) const =0
static const uint64 MaybeAmbiguous
virtual bool isRaisable() const
virtual void setDocsForDefinition(bool b)
virtual bool isStrong() const
virtual bool hasReferencesRelation() const
bool isEnabled(OutputGenerator::OutputType o)
virtual const ArgumentList & typeConstraints() const
virtual QCString getDeclFileName() const
virtual bool isStrong() const =0
virtual bool isWritable() const =0
virtual int initializerLines() const
virtual uint64 getMemberSpecifiers() const
virtual bool visibleInIndex() const =0
virtual QCString trReimplementedFromList(int numEntries)=0
virtual void setHidden(bool b)
void endInlineMemberName()
static const uint64 Transient
void addRefItem(const RefItemVector &sli, const QCString &key, const QCString &prefix, const QCString &name, const QCString &title, const QCString &args, const Definition *scope)
virtual int docLine() const
void _computeLinkableInProject()
virtual bool isFunctionPtr() const
virtual DefType definitionType() const =0
std::map< const Definition *, const MemberList * > sectionMap
virtual QCString getGroupFileName() const
virtual MemberDef * memberDefinition() const =0
virtual QCString inbodyFile() const
virtual QCString declaration() const =0
virtual QCString getDeclFileName() const =0
virtual bool anonymousDeclShown() const
virtual QCString briefFile() const =0
virtual void addSourceReferencedBy(const MemberDef *d)=0
virtual bool hasOneLineInitializer() const =0
const NamespaceDef * nspace
void startTextLink(const QCString &file, const QCString &anchor)
void endMemberDoc(bool hasArgs)
virtual QCString getOutputFileBase() const
void endCallGraph(DotCallGraph &g)
virtual QCString trInitialValue()=0
virtual bool isTypedefValCached() const
virtual void setType(const QCString &t)
virtual QCString getWriteAccessor() const
virtual bool isForeign() const =0
void startDescTableTitle()
virtual bool isAnonymous() const
virtual const ArgumentLists & definitionTemplateParameterLists() const
virtual QCString localName() const
virtual bool isDefine() const
virtual CompoundType compoundType() const =0
Returns the type of compound this is, i.e.
virtual void setAnonymousEnumType(const MemberDef *md)
bool _isReimplements() const
virtual void enableReferencesRelation(bool e)
virtual bool isNoExcept() const
virtual void setExplicitExternal(bool b, const QCString &df, int line, int column)
virtual bool hasReferencedByRelation() const
virtual CodeSymbolType codeSymbolType() const =0
virtual const ClassDef * getCachedTypedefVal() const
virtual QCString anchor() const
virtual bool isFinal() const
void docFindSections(const QCString &input, const Definition *d, const QCString &fileName)
virtual bool isMaybeVoid() const
virtual bool isProtectedSettable() const
virtual QCString definition() const
static const uint64 ProtectedSettable
virtual void enableCallGraph(bool e)
virtual bool isFriend() const
virtual bool isAbstract() const =0
virtual void cacheTypedefVal(const ClassDef *val, const QCString &templSpec, const QCString &resolvedType)
virtual uint64 getMemberSpecifiers() const =0
virtual void warnIfUndocumentedParams() const
void startCodeFragment(const QCString &style)
virtual void setDefinition(const QCString &d)
virtual bool isEnumStruct() const
virtual const MemberList * getSectionList(const Definition *container) const =0
virtual QCString getReference() const =0
virtual QCString documentation() const
virtual bool isSettable() const =0
virtual bool isInitonly() const
virtual bool hasCallGraph() const
static const uint64 Readable
virtual bool hasCallGraph() const
uchar m_isDestructorCached
virtual bool isDetailedSectionVisible(MemberListContainer container) const
virtual QCString qualifiedName() const =0
virtual bool isTypedefValCached() const
virtual bool hasDocumentation() const
virtual const MemberVector & reimplementedBy() const =0
virtual void setMemberDefinition(MemberDef *md)
std::vector< ArgumentList > ArgumentLists
static const reg::Ex reAnonymous(R"([\w:@]*@\d+)")
virtual QCString excpString() const
virtual bool isDCOP() const
virtual QCString extraTypeChars() const
QCString mid(size_t index, size_t len=static_cast< size_t >(-1)) const
QCString substitute(const QCString &s, const QCString &src, const QCString &dst)
substitute all occurrences of src in s by dst
virtual MemberType memberType() const
virtual bool isInline() const
virtual bool isAddable() const =0
virtual QCString getDeclType() const =0
virtual bool isLinkableInProject() const =0
virtual bool isTemplateSpecialization() const =0
virtual QCString fieldType() const =0
void writeNonBreakableSpace(int num)
static const uint64 Attribute
virtual void enableReferencedByRelation(bool e)=0
void writePageRef(OutputDocInterface &od, const QCString &cn, const QCString &mn)
virtual const ArgumentList & templateArguments() const =0
std::vector< RefItem * > RefItemVector
virtual QCString getOutputFileBase() const =0
virtual bool isEnumStruct() const =0
virtual void setInbodyDocumentation(const QCString &doc, const QCString &docFile, int docLine)
virtual bool isPrivateGettable() const =0
virtual QCString getCachedResolvedTypedef() const =0
virtual void enableCallGraph(bool e)=0
static const uint64 Strong
virtual bool isDictionary() const
virtual const ArgumentList & declArgumentList() const
virtual bool isLinkable() const =0
QCString & remove(size_t index, size_t len)
virtual void setProtection(Protection p)
static const uint64 Writable
virtual void setReimplements(const MemberDef *md)
#define Config_getBool(name)
virtual bool isAttribute() const
void startDescTableData()
QCString & append(char c)
virtual QCString getOutputFileBase() const =0
virtual bool isRemovable() const =0
virtual void setFileDef(const FileDef *fd)
virtual bool isPrivateSettable() const
virtual void moveDeclArgumentList(std::unique_ptr< ArgumentList > al)=0
Grouping::GroupPri_t grouppri
NamespaceDef * toNamespaceDef(Definition *d)
virtual const MemberDef * categoryRelation() const =0
virtual bool isStrongEnumValue() const
virtual QCString objCMethodName(bool localLink, bool showStatic) const =0
virtual void setAccessorType(ClassDef *cd, const QCString &t)
virtual bool isDocsForDefinition() const =0
virtual QCString requiresClause() const
virtual const MemberDef * getEnumScope() const =0
virtual const QCString & initializer() const
virtual const MemberVector & reimplementedBy() const
virtual QCString getScopeString() const =0
Class representing a regular expression.
virtual MemberDefMutable * createTemplateInstanceMember(const ArgumentList &formalArgs, const std::unique_ptr< ArgumentList > &actualArgs) const
virtual void setDocumentation(const QCString &d, const QCString &docFile, int docLine, bool stripWhiteSpace=TRUE)=0
virtual bool isEnumerate() const =0
virtual QCString getReference() const =0
If this class originated from a tagfile, this will return the tag file reference
virtual bool isUNOProperty() const =0
virtual bool isExternal() const =0
virtual QCString displayName(bool=TRUE) const =0
void msg(const char *fmt,...)
static const uint64 NonAtomic
virtual bool isTypedef() const
virtual bool isSealed() const =0
virtual void findSectionsInDocumentation()
virtual bool isStatic() const
virtual QCString documentation() const =0
virtual const ArgumentList & declArgumentList() const =0
virtual const ArgumentList & argumentList() const
virtual bool livesInsideEnum() const =0
virtual void writeSourceRefs(OutputList &ol, const QCString &scopeName) const
virtual QCString getCachedResolvedTypedef() const
virtual bool hasDocumentation() const
virtual const FileDef * getBodyDef() const
void startMemberDoc(const QCString &clName, const QCString &memName, const QCString &anchor, const QCString &title, int memCount, int memTotal, bool showInline)
virtual void moveTo(Definition *)
virtual bool isExplicit() const =0
const MemberDef * docProvider
virtual Definition * getOuterScope() const =0
virtual QCString trImplementedInList(int numEntries)=0
virtual bool isEnumValue() const =0
bool startsWith(const char *s) const
void parseText(const QCString &textStr)
void startInlineMemberDoc()
virtual bool isEnumValue() const
static const uint64 Addable
virtual bool isOptional() const
virtual bool isOverride() const =0
const char * qPrint(const char *s)
static const uint64 Bound
static QCString stripTrailingReturn(const QCString &trailRet)
virtual bool isFunctionPtr() const =0
virtual int numberOfFlowKeyWords() const
virtual void moveDeclArgumentList(std::unique_ptr< ArgumentList > al)
virtual const FileDef * getFileDef() const =0
const MemberDef * categoryRelation
virtual QCString displayDefinition() const =0
virtual void setBodySegment(int defLine, int bls, int ble)=0
virtual QCString typeString() const
virtual bool isTemplateSpecialization() const
void endMemberTemplateParams(const QCString &anchor, const QCString &inheritId)
void startInlineMemberName()
void startDescTable(const QCString &title)
virtual QCString getDefFileName() const =0
static const uint64 Local
virtual bool isImplementation() const =0
virtual bool isSliceLocal() const
virtual void writeDeclaration(OutputList &ol, const MemberDef *md, bool inGroup, int indentLevel, const ClassDef *inheritedFrom, const QCString &inheritId) const =0
virtual QCString briefDescription(bool abbr=FALSE) const
virtual bool hasCallGraph() const =0
void generateDoc(const QCString &fileName, int startLine, const Definition *ctx, const MemberDef *md, const QCString &docStr, bool indexWords, bool isExample, const QCString &exampleName, bool singleLine, bool linkFromIndex, bool markdownSupport)
virtual bool isFunctionOrSignalSlot() const =0
virtual bool isCopy() const
void endInlineMemberType()
virtual bool isDetailedSectionVisible(MemberListContainer container) const =0
void startMemberDocPrefixItem()
virtual QCString trDefineValue()=0
virtual QCString getScopeString() const
bool contains(const MemberDef *md)
virtual bool hasMultiLineInitializer() const
virtual const ArgumentList & argumentList() const =0
virtual QCString compoundTypeString() const =0
virtual QCString getDeclType() const
static void writeExceptionList(OutputList &ol, const ClassDef *cd, const MemberDef *md)
virtual bool isEvent() const
virtual Grouping::GroupPri_t getGroupPri() const
static const uint64 Mutable
virtual QCString displayName(bool b=TRUE) const
QCString removeAnonymousScopes(const QCString &str)
virtual QCString extraTypeChars() const =0
virtual const MemberDef * inheritsDocsFrom() const
virtual QCString displayName(bool includeScope=TRUE) const =0
Returns the name as it is appears in the documentation
virtual bool hasSourceRefs() const
void pushGeneratorState()
virtual QCString bitfieldString() const
virtual void resolveUnnamedParameters(const MemberDef *md)=0
const char * data() const
Returns a pointer to the contents of the string in the form of a 0-terminated C string
virtual bool hasDocumentedEnumValues() const
virtual ClassDef * category() const =0
virtual bool isProtectedSettable() const
static const uint64 EnumStruct
virtual Specifier virtualness(int count=0) const
QCString convertToXML(const QCString &s, bool keepEntities)
bool inSort(const Example &ex)
virtual bool isGettable() const =0
A model of a file symbol.
static QCString simplifyTypeForTable(const QCString &s)
virtual bool isAbstract() const
virtual bool isDelete() const
A class representing a group of members.
virtual ClassDef * relatedAlso() const
void _writeCallerGraph(OutputList &ol) const
static const uint64 PrivateSettable
virtual bool isProperty() const
virtual bool isPublished() const
virtual void setReference(const QCString &r)
virtual bool isDocsForDefinition() const
FileDef * toFileDef(Definition *d)
bool detailedDescriptionCachedValue
virtual QCString enumBaseType() const =0
const MemberDef * enumScope
virtual bool isStrong() const
virtual MemberDefMutable * createTemplateInstanceMember(const ArgumentList &formalArgs, const std::unique_ptr< ArgumentList > &actualArgs) const
virtual const MemberDef * resolveAlias() const
virtual bool isEvent() const
virtual bool isNew() const
virtual bool isLinkable() const
bool _hasVisibleCallGraph() const
virtual int getGroupStartLine() const =0
virtual bool isAddable() const
virtual void moveArgumentList(std::unique_ptr< ArgumentList > al)=0
virtual QCString trMember(bool first_capital, bool singular)=0
virtual const MemberDef * inheritsDocsFrom() const
virtual const MemberDef * reimplements() const
virtual QCString getWriteAccessor() const =0
QCString stripExtension(const QCString &fName)
virtual MemberDef * fromAnonymousMember() const
virtual QCString excpString() const
virtual bool isConstructor() const
virtual void setInheritsDocsFrom(const MemberDef *md)
virtual bool getGroupHasDocs() const
virtual Grouping::GroupPri_t getGroupPri() const
virtual bool isNoExcept() const =0
const ClassDef * cachedTypedefValue
static bool suppressDocWarnings
void writeObjectLink(const QCString &ref, const QCString &file, const QCString &anchor, const QCString &name)
virtual bool isInitonly() const
static bool isMisc(const MemberDef *mdef)
virtual int getMemberGroupId() const
virtual bool isPrototype() const
virtual void copyArgumentNames(const MemberDef *bmd)
virtual bool isReadable() const =0
MemberDefAliasImpl(const Definition *newScope, const MemberDef *md)
virtual void setRequiresClause(const QCString &req)
ClassDefMutable * toClassDefMutable(Definition *d)
virtual bool isLinkableInProject() const
virtual bool isMaybeAmbiguous() const =0
virtual bool hasDetailedDescription() const
virtual bool isDetailedSectionVisible(MemberListContainer container) const
void startMemberDeclaration()
virtual bool isFinal() const
virtual const ClassDef * getClassDef() const
virtual void setDefinition(const QCString &d)=0
virtual void setEnumScope(const MemberDef *md, bool livesInsideEnum=FALSE)
bool hasDetailedDescriptionCached
virtual bool isRaisable() const
virtual bool isCopy() const
bool search(const std::string &str, Match &match, const Ex &re, size_t pos)
Search in a given string str starting at position pos for a match against regular expression re.
virtual bool isEnumerate() const
virtual bool isDestructor() const
virtual bool anonymousDeclShown() const
virtual int getGroupStartLine() const
virtual QCString declaration() const
virtual bool hasReferencesRelation() const =0
const Definition * getScope() const
virtual bool isDelete() const
virtual QCString getDefFileExtension() const
virtual bool hasDetailedDescription() const
virtual bool hasDocumentation() const
virtual QCString trCallerGraph()=0
size_t _countReimplementedBy() const
virtual void enableCallerGraph(bool e)=0
virtual bool isCopy() const =0
virtual QCString displayDefinition() const
virtual bool isOptional() const =0
virtual const QCString & initializer() const =0
virtual bool isUnretained() const =0
virtual bool isRequired() const
virtual void setTypeConstraints(const ArgumentList &al)
virtual const MemberDef * getGroupAlias() const
virtual QCString getOutputFileBase() const =0
virtual QCString qualifiedName() const
virtual bool isRelated() const =0
A bunch of utility functions.
virtual void mergeMemberSpecifiers(uint64 s)
virtual const FileDef * getFileDef() const
virtual bool visibleInIndex() const
virtual QCString typeString() const =0
virtual void writeLink(OutputList &ol, const ClassDef *cd, const NamespaceDef *nd, const FileDef *fd, const GroupDef *gd, bool onlyText=FALSE) const =0
virtual QCString localName() const =0
virtual const ExampleList & getExamples() const
virtual bool isPrivateSettable() const =0
virtual QCString requiresClause() const =0
void endInlineMemberDoc()
virtual bool isPublished() const
virtual bool isNew() const
virtual bool isRelatedOrFriend() const
virtual QCString getScopeString() const
void enable(OutputGenerator::OutputType o)
virtual const MemberDef * getEnumScope() const
void _writeReimplements(OutputList &ol) const
MemberGroup * memberGroup
virtual void setOuterScope(Definition *def)
virtual ClassDef * category() const
Relationship
Kind of member relationship
virtual bool isLinkable() const =0
return TRUE iff a link to this class is possible (either within this project, or as a cross-reference...
virtual bool isDCOP() const
virtual bool isUNOProperty() const
virtual void writeSourceReffedBy(OutputList &ol, const QCString &scopeName) const
std::unique_ptr< ArgumentList > stringToArgumentList(SrcLangExt lang, const QCString &argsString, QCString *extraTypeChars=0)
virtual uint64 getMemberSpecifiers() const
A list of MemberDef objects as shown in documentation sections.
virtual bool isDefault() const
virtual bool hasDetailedDescription() const =0
virtual void setDocumentedEnumValues(bool value)
bool stripPrefix(const QCString &prefix)
bool matchArguments2(const Definition *srcScope, const FileDef *srcFileScope, const ArgumentList *srcAl, const Definition *dstScope, const FileDef *dstFileScope, const ArgumentList *dstAl, bool checkCV)
virtual bool isRetain() const
virtual MemberGroup * getMemberGroup() const
virtual bool hasDocumentedEnumValues() const
const Definition * getAlias() const
virtual const MemberDef * templateMaster() const
QCString right(size_t len) const
virtual void setGroupAlias(const MemberDef *md)
void endCodeFragment(const QCString &style)
virtual void setMaxInitLines(int lines)
QCString & prepend(const char *s)
bool resize(size_t newlen)
Resizes the string to hold newlen characters (this value should also count the 0-terminator).
virtual bool addExample(const QCString &anchor, const QCString &name, const QCString &file)
virtual bool isMaybeVoid() const
virtual bool isEvent() const =0
uint qstrlen(const char *str)
virtual MemberType memberType() const =0
static const uint64 Published
virtual QCString objCMethodName(bool localLink, bool showStatic) const
bool _hasVisibleCallerGraph() const
virtual bool isBound() const =0
virtual const ArgumentList & templateArguments() const
virtual bool isProtectedSettable() const =0
void startParagraph(const QCString &classDef=QCString())
virtual QCString getSourceFileBase() const
virtual const GroupDef * getGroupDef() const =0
virtual QCString enumBaseType() const
void _writeMultiLineInitializer(OutputList &ol, const QCString &scopeName) const
virtual const MemberDef * getEnumScope() const
virtual bool isConstructor() const
static const uint64 NoExcept
virtual QCString getReference() const
virtual QCString displayName(bool=TRUE) const =0
virtual bool isTransient() const =0
virtual bool isAssign() const =0
virtual QCString objCMethodName(bool localLink, bool showStatic) const
std::unique_ptr< IDocParser > createDocParser()
void _writeCallGraph(OutputList &ol) const
void _writeTypeConstraints(OutputList &ol) const
virtual bool isTypeAlias() const
virtual QCString anchor() const =0
virtual bool isNotFriend() const
virtual QCString getCachedTypedefTemplSpec() const =0
This is an alternative implementation of QCString.
virtual void addListReference(Definition *d)