Doxygen
ClassDefImpl::IMPL类 参考

Private data associated with a ClassDef object. 更多...

+ ClassDefImpl::IMPL 的协作图:

Public 成员函数

 IMPL ()
 
 ~IMPL ()
 
void init (const QCString &defFileName, const QCString &name, const QCString &ctStr, const QCString &fName)
 

Public 属性

QCString fileName
 
QCString memberListFileName
 
QCString collabFileName
 
QCString inheritFileName
 
std::unique_ptr< IncludeInfoincInfo
 
BaseClassList inherits
 
BaseClassList inheritedBy
 
FileDeffileDef = 0
 
MemberNameInfoLinkedMap allMemberNameInfoLinkedMap
 
ArgumentList tempArgs
 
ArgumentList typeConstraints
 
FileList files
 
ExampleList examples
 
ClassDef::CompoundType compType
 
Protection prot
 
ClassLinkedRefMap innerClasses
 
UsesClassList usesImplClassList
 
UsesClassList usedByImplClassList
 
ConstraintClassList constraintClassList
 
TemplateInstanceList templateInstances
 
TemplateNameMap templBaseClassNames
 
const ClassDeftemplateMaster = 0
 
QCString className
 
ClassDefcategoryOf = 0
 
MemberLists memberLists
 
MemberGroupList memberGroups
 
bool isAbstract = false
 
bool isStatic = false
 
bool membersMerged = false
 
bool isLocal = false
 
bool isTemplArg = false
 
bool subGrouping = false
 
bool usedOnly = false
 Reason of existence is a "use" relation 更多...
 
StringSet vhdlSummaryTitles
 List of titles to use for the summary 更多...
 
bool isSimple = false
 Is this a simple (non-nested) C structure? 更多...
 
const MemberDefarrowOperator = 0
 Does this class overloaded the -> operator? 更多...
 
const ClassDeftagLessRef = 0
 
bool isJavaEnum = false
 Does this class represent a Java style enum? 更多...
 
uint64 spec = 0
 
QCString metaData
 
QCString requiresClause
 C++20 requires clause 更多...
 

详细描述

Private data associated with a ClassDef object.

在文件 classdef.cpp571 行定义.

构造及析构函数说明

◆ IMPL()

ClassDefImpl::IMPL::IMPL ( )

在文件 classdef.cpp762 行定义.

763 {
764 }

◆ ~IMPL()

ClassDefImpl::IMPL::~IMPL ( )

在文件 classdef.cpp766 行定义.

767 {
768 }

成员函数说明

◆ init()

void ClassDefImpl::IMPL::init ( const QCString defFileName,
const QCString name,
const QCString ctStr,
const QCString fName 
)

在文件 classdef.cpp719 行定义.

721 {
722  if (!fName.isEmpty())
723  {
724  fileName=stripExtension(fName);
725  }
726  else
727  {
728  fileName=ctStr+name;
729  }
730  prot=Public;
731  //nspace=0;
732  fileDef=0;
733  subGrouping=Config_getBool(SUBGROUPING);
734  templateMaster =0;
735  isAbstract = FALSE;
736  isStatic = FALSE;
737  isTemplArg = FALSE;
739  categoryOf = 0;
740  usedOnly = FALSE;
741  isSimple = Config_getBool(INLINE_SIMPLE_STRUCTS);
742  arrowOperator = 0;
743  tagLessRef = 0;
744  spec=0;
745  //QCString ns;
746  //extractNamespaceName(name,className,ns);
747  //printf("m_name=%s m_className=%s ns=%s\n",qPrint(m_name),qPrint(m_className),qPrint(ns));
748 
749  // we cannot use getLanguage at this point, as setLanguage has not been called.
750  SrcLangExt lang = getLanguageFromFileName(defFileName);
751  if ((lang==SrcLangExt_Cpp || lang==SrcLangExt_ObjC) &&
752  guessSection(defFileName)==Entry::SOURCE_SEC)
753  {
754  isLocal=TRUE;
755  }
756  else
757  {
758  isLocal=FALSE;
759  }
760 }

引用了 arrowOperator, categoryOf, Config_getBool, FALSE, fileDef, fileName, getLanguageFromFileName(), guessSection(), isAbstract, QCString::isEmpty(), isLocal, isSimple, isStatic, isTemplArg, membersMerged, DefinitionMixin< ClassDefMutable >::name(), prot, Public, Entry::SOURCE_SEC, spec, SrcLangExt_Cpp, SrcLangExt_ObjC, stripExtension(), subGrouping, tagLessRef, templateMaster, TRUE , 以及 usedOnly.

被这些函数引用 ClassDefImpl::ClassDefImpl().

类成员变量说明

◆ allMemberNameInfoLinkedMap

◆ arrowOperator

const MemberDef* ClassDefImpl::IMPL::arrowOperator = 0

Does this class overloaded the -> operator?

在文件 classdef.cpp704 行定义.

被这些函数引用 init(), ClassDefImpl::internalInsertMember() , 以及 ClassDefImpl::isSmartPointer().

◆ categoryOf

ClassDef* ClassDefImpl::IMPL::categoryOf = 0

If this class is a Objective-C category, then this points to the class which is extended.

在文件 classdef.cpp667 行定义.

被这些函数引用 ClassDefImpl::categoryOf(), init() , 以及 ClassDefImpl::setCategoryOf().

◆ className

QCString ClassDefImpl::IMPL::className

local class name which could be a typedef'ed alias name.

在文件 classdef.cpp662 行定义.

被这些函数引用 ClassDefImpl::className() , 以及 ClassDefImpl::setClassName().

◆ collabFileName

QCString ClassDefImpl::IMPL::collabFileName

file name used for the collaboration diagram

在文件 classdef.cpp589 行定义.

被这些函数引用 ClassDefImpl::ClassDefImpl() , 以及 ClassDefImpl::collaborationGraphFileName().

◆ compType

◆ constraintClassList

ConstraintClassList ClassDefImpl::IMPL::constraintClassList

在文件 classdef.cpp649 行定义.

被这些函数引用 ClassDefImpl::addTypeConstraint() , 以及 ClassDefImpl::templateTypeConstraints().

◆ examples

ExampleList ClassDefImpl::IMPL::examples

Examples that use this class

在文件 classdef.cpp629 行定义.

被这些函数引用 ClassDefImpl::addExample(), ClassDefImpl::getExamples(), ClassDefImpl::hasExamples() , 以及 ClassDefImpl::writeDetailedDocumentationBody().

◆ fileDef

FileDef* ClassDefImpl::IMPL::fileDef = 0

Namespace this class is part of (this is the inner most namespace in case of nested namespaces)

File this class is defined in

在文件 classdef.cpp614 行定义.

被这些函数引用 ClassDefImpl::getFileDef(), init() , 以及 ClassDefImpl::setFileDef().

◆ fileName

QCString ClassDefImpl::IMPL::fileName

file name that forms the base for the output file containing the class documentation. For compatibility with Qt (e.g. links via tag files) this name cannot be derived from the class name directly.

在文件 classdef.cpp583 行定义.

被这些函数引用 ClassDefImpl::anchor(), ClassDefImpl::ClassDefImpl(), ClassDefImpl::getInstanceOutputFileBase(), ClassDefImpl::getOutputFileBase() , 以及 init().

◆ files

FileList ClassDefImpl::IMPL::files

Files that were used for generating the class documentation.

在文件 classdef.cpp626 行定义.

被这些函数引用 ClassDefImpl::generatedFromFiles(), ClassDefImpl::insertUsedFile(), ClassDefImpl::showUsedFiles() , 以及 ClassDefImpl::usedFiles().

◆ incInfo

std::unique_ptr<IncludeInfo> ClassDefImpl::IMPL::incInfo

Include information about the header file should be included in the documentation. 0 by default, set by setIncludeFile().

在文件 classdef.cpp597 行定义.

被这些函数引用 ClassDefImpl::includeInfo(), ClassDefImpl::setIncludeFile(), ClassDefImpl::writeIncludeFiles() , 以及 ClassDefImpl::writeIncludeFilesForSlice().

◆ inheritedBy

BaseClassList ClassDefImpl::IMPL::inheritedBy

◆ inheritFileName

QCString ClassDefImpl::IMPL::inheritFileName

file name used for the inheritance graph

在文件 classdef.cpp592 行定义.

被这些函数引用 ClassDefImpl::ClassDefImpl() , 以及 ClassDefImpl::inheritanceGraphFileName().

◆ inherits

◆ innerClasses

◆ isAbstract

bool ClassDefImpl::IMPL::isAbstract = false

Is this an abstract class?

在文件 classdef.cpp675 行定义.

被这些函数引用 init(), ClassDefImpl::internalInsertMember() , 以及 ClassDefImpl::isAbstract().

◆ isJavaEnum

bool ClassDefImpl::IMPL::isJavaEnum = false

Does this class represent a Java style enum?

在文件 classdef.cpp709 行定义.

被这些函数引用 ClassDefImpl::ClassDefImpl() , 以及 ClassDefImpl::isJavaEnum().

◆ isLocal

bool ClassDefImpl::IMPL::isLocal = false

TRUE if the class is defined in a source file rather than a header file.

在文件 classdef.cpp684 行定义.

被这些函数引用 init(), ClassDefImpl::isLinkableInProject() , 以及 ClassDefImpl::isLocal().

◆ isSimple

◆ isStatic

bool ClassDefImpl::IMPL::isStatic = false

Is the class part of an unnamed namespace?

在文件 classdef.cpp678 行定义.

被这些函数引用 init(), ClassDefImpl::isLinkableInProject(), ClassDefImpl::isVisibleInHierarchy() , 以及 ClassDefImpl::setIsStatic().

◆ isTemplArg

bool ClassDefImpl::IMPL::isTemplArg = false

在文件 classdef.cpp686 行定义.

被这些函数引用 init(), ClassDefImpl::isTemplateArgument() , 以及 ClassDefImpl::makeTemplateArgument().

◆ memberGroups

◆ memberListFileName

QCString ClassDefImpl::IMPL::memberListFileName

file name used for the list of all members

在文件 classdef.cpp586 行定义.

被这些函数引用 ClassDefImpl::ClassDefImpl() , 以及 ClassDefImpl::getMemberListFileName().

◆ memberLists

◆ membersMerged

bool ClassDefImpl::IMPL::membersMerged = false

TRUE if classes members are merged with those of the base classes.

在文件 classdef.cpp681 行定义.

被这些函数引用 init() , 以及 ClassDefImpl::mergeMembers().

◆ metaData

QCString ClassDefImpl::IMPL::metaData

在文件 classdef.cpp713 行定义.

被这些函数引用 ClassDefImpl::setMetaData() , 以及 ClassDefImpl::writeIncludeFilesForSlice().

◆ prot

Protection ClassDefImpl::IMPL::prot

The protection level in which this class was found. Typically Public, but for nested classes this can also be Protected or Private.

在文件 classdef.cpp638 行定义.

被这些函数引用 init(), ClassDefImpl::isLinkableInProject(), ClassDefImpl::isVisibleInHierarchy(), ClassDefImpl::protection() , 以及 ClassDefImpl::setProtection().

◆ requiresClause

QCString ClassDefImpl::IMPL::requiresClause

C++20 requires clause

在文件 classdef.cpp716 行定义.

被这些函数引用 ClassDefImpl::requiresClause(), ClassDefImpl::setRequiresClause() , 以及 ClassDefImpl::writeTemplateSpec().

◆ spec

◆ subGrouping

bool ClassDefImpl::IMPL::subGrouping = false

Does this class group its user-grouped members as a sub-section of the normal (public/protected/..) groups?

在文件 classdef.cpp692 行定义.

被这些函数引用 ClassDefImpl::addGroupedInheritedMembers(), ClassDefImpl::addMembersToMemberGroup(), ClassDefImpl::countMembersIncludingGrouped(), init(), ClassDefImpl::setSubGrouping(), ClassDefImpl::subGrouping() , 以及 ClassDefImpl::writeMemberGroups().

◆ tagLessRef

const ClassDef* ClassDefImpl::IMPL::tagLessRef = 0

在文件 classdef.cpp706 行定义.

被这些函数引用 init(), ClassDefImpl::setTagLessReference() , 以及 ClassDefImpl::tagLessReference().

◆ tempArgs

◆ templateInstances

TemplateInstanceList ClassDefImpl::IMPL::templateInstances

Template instances that exists of this class, the key in the dictionary is the template argument list.

在文件 classdef.cpp654 行定义.

被这些函数引用 ClassDefImpl::getTemplateInstances(), ClassDefImpl::insertTemplateInstance() , 以及 ClassDefImpl::insertUsedFile().

◆ templateMaster

◆ templBaseClassNames

TemplateNameMap ClassDefImpl::IMPL::templBaseClassNames

◆ typeConstraints

ArgumentList ClassDefImpl::IMPL::typeConstraints

Type constraints for template parameters

在文件 classdef.cpp623 行定义.

被这些函数引用 ClassDefImpl::setTypeConstraints(), ClassDefImpl::typeConstraints() , 以及 ClassDefImpl::writeDetailedDocumentationBody().

◆ usedByImplClassList

UsesClassList ClassDefImpl::IMPL::usedByImplClassList

在文件 classdef.cpp647 行定义.

被这些函数引用 ClassDefImpl::addUsedByClass() , 以及 ClassDefImpl::usedByImplementationClasses().

◆ usedOnly

bool ClassDefImpl::IMPL::usedOnly = false

Reason of existence is a "use" relation

在文件 classdef.cpp695 行定义.

被这些函数引用 init(), ClassDefImpl::isUsedOnly() , 以及 ClassDefImpl::setUsedOnly().

◆ usesImplClassList

UsesClassList ClassDefImpl::IMPL::usesImplClassList

在文件 classdef.cpp646 行定义.

被这些函数引用 ClassDefImpl::addUsedClass() , 以及 ClassDefImpl::usedImplementationClasses().

◆ vhdlSummaryTitles

StringSet ClassDefImpl::IMPL::vhdlSummaryTitles

List of titles to use for the summary

在文件 classdef.cpp698 行定义.

被这些函数引用 ClassDefImpl::internalInsertMember() , 以及 ClassDefImpl::writeSummaryLinks().


该类的文档由以下文件生成:
ClassDefImpl::IMPL::isStatic
bool isStatic
Definition: classdef.cpp:678
ClassDefImpl::IMPL::fileDef
FileDef * fileDef
Definition: classdef.cpp:614
QCString::isEmpty
bool isEmpty() const
Returns TRUE iff the string is empty
Definition: qcstring.h:144
ClassDefImpl::IMPL::subGrouping
bool subGrouping
Definition: classdef.cpp:692
ClassDefImpl::IMPL::templateMaster
const ClassDef * templateMaster
Definition: classdef.cpp:659
SrcLangExt
SrcLangExt
Language as given by extension
Definition: types.h:41
Public
@ Public
Definition: types.h:26
ClassDefImpl::IMPL::arrowOperator
const MemberDef * arrowOperator
Does this class overloaded the -> operator?
Definition: classdef.cpp:704
ClassDefImpl::IMPL::categoryOf
ClassDef * categoryOf
Definition: classdef.cpp:667
DefinitionMixin< ClassDefMutable >::name
virtual QCString name() const
Definition: definitionimpl.h:155
ClassDefImpl::IMPL::usedOnly
bool usedOnly
Reason of existence is a "use" relation
Definition: classdef.cpp:695
SrcLangExt_ObjC
@ SrcLangExt_ObjC
Definition: types.h:49
Entry::SOURCE_SEC
@ SOURCE_SEC
Definition: entry.h:88
ClassDefImpl::IMPL::tagLessRef
const ClassDef * tagLessRef
Definition: classdef.cpp:706
ClassDefImpl::IMPL::spec
uint64 spec
Definition: classdef.cpp:711
SrcLangExt_Cpp
@ SrcLangExt_Cpp
Definition: types.h:50
getLanguageFromFileName
SrcLangExt getLanguageFromFileName(const QCString &fileName, SrcLangExt defLang)
Definition: util.cpp:5574
TRUE
#define TRUE
Definition: qcstring.h:36
ClassDefImpl::IMPL::isAbstract
bool isAbstract
Definition: classdef.cpp:675
ClassDefImpl::IMPL::prot
Protection prot
Definition: classdef.cpp:638
ClassDefImpl::IMPL::isSimple
bool isSimple
Is this a simple (non-nested) C structure?
Definition: classdef.cpp:701
ClassDefImpl::IMPL::membersMerged
bool membersMerged
Definition: classdef.cpp:681
Config_getBool
#define Config_getBool(name)
Definition: config.h:33
ClassDefImpl::IMPL::fileName
QCString fileName
Definition: classdef.cpp:583
ClassDefImpl::IMPL::isTemplArg
bool isTemplArg
Definition: classdef.cpp:686
stripExtension
QCString stripExtension(const QCString &fName)
Definition: util.cpp:5295
ClassDefImpl::IMPL::isLocal
bool isLocal
Definition: classdef.cpp:684
guessSection
int guessSection(const QCString &name)
Definition: util.cpp:331
FALSE
#define FALSE
Definition: qcstring.h:33