Doxygen
NamespaceDefImpl类 参考
+ 类 NamespaceDefImpl 继承关系图:
+ NamespaceDefImpl 的协作图:

Public 成员函数

 NamespaceDefImpl (const QCString &defFileName, int defLine, int defColumn, const QCString &name, const QCString &ref=QCString(), const QCString &refFile=QCString(), const QCString &type=QCString(), bool isPublished=false)
 
virtual ~NamespaceDefImpl ()
 
virtual DefType definitionType () const
 
virtual CodeSymbolType codeSymbolType () const
 
virtual QCString getOutputFileBase () const
 
virtual QCString anchor () const
 
virtual void insertUsedFile (FileDef *fd)
 
virtual void writeDocumentation (OutputList &ol)
 
virtual void writeMemberPages (OutputList &ol)
 
virtual void writeQuickMemberLinks (OutputList &ol, const MemberDef *currentMd) const
 
virtual void writeTagFile (TextStream &)
 
virtual void insertClass (const ClassDef *cd)
 
virtual void insertConcept (const ConceptDef *cd)
 
virtual void insertNamespace (const NamespaceDef *nd)
 
virtual void insertMember (MemberDef *md)
 
virtual void computeAnchors ()
 
virtual void countMembers ()
 
virtual int numDocMembers () const
 
virtual void addUsingDirective (const NamespaceDef *nd)
 
virtual LinkedRefMap< const NamespaceDefgetUsedNamespaces () const
 
virtual void addUsingDeclaration (const ClassDef *cd)
 
virtual LinkedRefMap< const ClassDefgetUsedClasses () const
 
virtual void combineUsingRelations (NamespaceDefSet &visitedNamespace)
 
virtual QCString displayName (bool=TRUE) const
 
virtual QCString localName () const
 
virtual void setInline (bool isInline)
 
virtual bool isConstantGroup () const
 
virtual bool isModule () const
 
virtual bool isLibrary () const
 
virtual bool isInline () const
 
virtual bool isLinkableInProject () const
 
virtual bool isLinkable () const
 
virtual bool hasDetailedDescription () const
 
virtual void addMembersToMemberGroup ()
 
virtual void distributeMemberGroupDocumentation ()
 
virtual void findSectionsInDocumentation ()
 
virtual void sortMemberLists ()
 
virtual const DefinitionfindInnerCompound (const QCString &name) const
 
virtual void addInnerCompound (const Definition *d)
 
virtual void addListReferences ()
 
virtual void setFileName (const QCString &fn)
 
virtual bool subGrouping () const
 
virtual MemberListgetMemberList (MemberListType lt) const
 
virtual const MemberListsgetMemberLists () const
 
virtual const MemberDefgetMemberByName (const QCString &) const
 
virtual const MemberGroupListgetMemberGroups () const
 
virtual ClassLinkedRefMap getClasses () const
 
virtual ClassLinkedRefMap getInterfaces () const
 
virtual ClassLinkedRefMap getStructs () const
 
virtual ClassLinkedRefMap getExceptions () const
 
virtual NamespaceLinkedRefMap getNamespaces () const
 
virtual ConceptLinkedRefMap getConcepts () const
 
virtual QCString title () const
 
virtual QCString compoundTypeString () const
 
virtual void setMetaData (const QCString &m)
 
- Public 成员函数 继承自 DefinitionMixin< NamespaceDefMutable >
 DefinitionMixin (const QCString &defFileName, int defLine, int defColumn, const QCString &name, const char *b=0, const char *d=0, bool isSymbol=TRUE)
 
virtual ~DefinitionMixin ()
 
virtual bool isAlias () const
 
virtual QCString name () const
 
virtual bool isAnonymous () const
 
virtual QCString localName () const
 
virtual QCString qualifiedName () const
 
virtual QCString symbolName () const
 
virtual QCString getSourceFileBase () const
 
virtual QCString getSourceAnchor () const
 
virtual QCString documentation () const
 
virtual int docLine () const
 
virtual QCString docFile () const
 
virtual QCString briefDescription (bool abbreviate=FALSE) const
 
virtual QCString briefDescriptionAsTooltip () const
 
virtual int briefLine () const
 
virtual QCString inbodyDocumentation () const
 
virtual QCString inbodyFile () const
 
virtual int inbodyLine () const
 
virtual QCString briefFile () const
 
virtual QCString getDefFileName () const
 
virtual QCString getDefFileExtension () const
 
virtual int getDefLine () const
 
virtual int getDefColumn () const
 
virtual bool hasDocumentation () const
 
virtual bool hasUserDocumentation () const
 
virtual bool isVisibleInProject () const
 
virtual bool isVisible () const
 
virtual bool isHidden () const
 
virtual bool isArtificial () const
 
virtual QCString getReference () const
 
virtual bool isReference () const
 
virtual QCString externalReference (const QCString &relPath) const
 
virtual int getStartDefLine () const
 
virtual int getStartBodyLine () const
 
virtual int getEndBodyLine () const
 
virtual const FileDefgetBodyDef () const
 
virtual SrcLangExt getLanguage () const
 
virtual const GroupListpartOfGroups () const
 
virtual bool isLinkableViaGroup () const
 
virtual const RefItemVectorxrefListItems () const
 
virtual DefinitiongetOuterScope () const
 
virtual const MemberVectorgetReferencesMembers () const
 
virtual const MemberVectorgetReferencedByMembers () const
 
virtual bool hasSections () const
 
virtual bool hasSources () const
 
virtual bool hasBriefDescription () const
 
virtual QCString id () const
 
virtual const SectionRefsgetSectionRefs () const
 
virtual void setName (const QCString &name)
 
virtual void setId (const QCString &name)
 
virtual void setDefFile (const QCString &df, int defLine, int defColumn)
 
virtual void setDocumentation (const QCString &doc, const QCString &docFile, int docLine, bool stripWhiteSpace=TRUE)
 
virtual void setBriefDescription (const QCString &brief, const QCString &briefFile, int briefLine)
 
virtual void setInbodyDocumentation (const QCString &doc, const QCString &docFile, int docLine)
 
virtual void setReference (const QCString &r)
 
virtual void addSectionsToDefinition (const std::vector< const SectionInfo * > &anchorList)
 
virtual void setBodySegment (int defLine, int bls, int ble)
 
virtual void setBodyDef (const FileDef *fd)
 
virtual void addSourceReferencedBy (const MemberDef *md)
 
virtual void addSourceReferences (const MemberDef *md)
 
virtual void setRefItems (const RefItemVector &sli)
 
virtual void mergeRefItems (Definition *def)
 
virtual void mergeReferences (const Definition *other)
 
virtual void mergeReferencedBy (const Definition *other)
 
virtual void setOuterScope (Definition *def)
 
virtual void setHidden (bool b)
 
virtual void setArtificial (bool b)
 
virtual void setLanguage (SrcLangExt lang)
 
virtual void writeSourceDef (OutputList &ol, const QCString &scopeName) const
 
virtual void writeInlineCode (OutputList &ol, const QCString &scopeName) const
 
virtual bool hasSourceRefs () const
 
virtual bool hasSourceReffedBy () const
 
virtual void writeSourceRefs (OutputList &ol, const QCString &scopeName) const
 
virtual void writeSourceReffedBy (OutputList &ol, const QCString &scopeName) const
 
virtual void makePartOfGroup (const GroupDef *gd)
 
virtual void writeNavigationPath (OutputList &ol) const
 
virtual QCString navigationPathAsString () const
 
virtual QCString pathFragment () const
 
virtual void writeDocAnchorsToTagFile (TextStream &fs) const
 
virtual void setLocalName (const QCString &name)
 
virtual void addSectionsToIndex ()
 
virtual void writeToc (OutputList &ol, const LocalToc &lt) const
 
virtual void computeTooltip ()
 
virtual void _setSymbolName (const QCString &name)
 
virtual QCString _symbolName () const
 
- Public 成员函数 继承自 DefinitionMutable
virtual bool hasSourceRefs () const =0
 
virtual bool hasSourceReffedBy () const =0
 
virtual ~DefinitionMutable ()=default
 
- Public 成员函数 继承自 NamespaceDef
virtual ~NamespaceDef ()
 
- Public 成员函数 继承自 Definition
virtual bool isAlias () const =0
 
virtual QCString name () const =0
 
virtual bool isAnonymous () const =0
 
virtual QCString qualifiedName () const =0
 
virtual QCString symbolName () const =0
 
virtual QCString getSourceFileBase () const =0
 
virtual QCString getSourceAnchor () const =0
 
virtual QCString documentation () const =0
 
virtual int docLine () const =0
 
virtual QCString docFile () const =0
 
virtual QCString briefDescriptionAsTooltip () const =0
 
virtual int briefLine () const =0
 
virtual QCString inbodyDocumentation () const =0
 
virtual QCString inbodyFile () const =0
 
virtual int inbodyLine () const =0
 
virtual QCString briefFile () const =0
 
virtual QCString getDefFileName () const =0
 
virtual QCString getDefFileExtension () const =0
 
virtual int getDefLine () const =0
 
virtual int getDefColumn () const =0
 
virtual bool hasDocumentation () const =0
 
virtual bool hasUserDocumentation () const =0
 
virtual bool isVisibleInProject () const =0
 
virtual bool isVisible () const =0
 
virtual bool isHidden () const =0
 
virtual bool isArtificial () const =0
 
virtual QCString getReference () const =0
 
virtual bool isReference () const =0
 
virtual int getStartDefLine () const =0
 
virtual int getStartBodyLine () const =0
 
virtual int getEndBodyLine () const =0
 
virtual const FileDefgetBodyDef () const =0
 
virtual SrcLangExt getLanguage () const =0
 Returns the programming language this definition was written in. 更多...
 
virtual const GroupListpartOfGroups () const =0
 
virtual bool isLinkableViaGroup () const =0
 
virtual const RefItemVectorxrefListItems () const =0
 
virtual DefinitiongetOuterScope () const =0
 
virtual const MemberVectorgetReferencesMembers () const =0
 
virtual const MemberVectorgetReferencedByMembers () const =0
 
virtual bool hasSections () const =0
 
virtual bool hasSources () const =0
 
virtual bool hasBriefDescription () const =0
 returns TRUE if this class has a brief description 更多...
 
virtual QCString id () const =0
 
virtual const SectionRefsgetSectionRefs () const =0
 returns the section dictionary, only of importance for pagedef 更多...
 
virtual QCString navigationPathAsString () const =0
 
virtual QCString pathFragment () const =0
 
virtual QCString _symbolName () const =0
 
virtual ~Definition ()=default
 

Private 类型

enum  { NAMESPACE, MODULE, CONSTANT_GROUP, LIBRARY }
 

Private 成员函数

void addMemberToList (MemberListType lt, MemberDef *md)
 
void writeMemberDeclarations (OutputList &ol, MemberListType lt, const QCString &title)
 
void writeMemberDocumentation (OutputList &ol, MemberListType lt, const QCString &title)
 
void writeDetailedDescription (OutputList &ol, const QCString &title)
 
void writeBriefDescription (OutputList &ol)
 
void startMemberDeclarations (OutputList &ol)
 
void endMemberDeclarations (OutputList &ol)
 
void writeClassDeclarations (OutputList &ol, const QCString &title, const ClassLinkedRefMap &d)
 
void writeConcepts (OutputList &ol, const QCString &title)
 
void writeInlineClasses (OutputList &ol)
 
void writeMemberGroups (OutputList &ol)
 
void writeAuthorSection (OutputList &ol)
 
void startMemberDocumentation (OutputList &ol)
 
void endMemberDocumentation (OutputList &ol)
 
void writeSummaryLinks (OutputList &ol) const
 
void addNamespaceAttributes (OutputList &ol)
 
void writeClassesToTagFile (TextStream &, const ClassLinkedRefMap &d)
 
void writeConceptsToTagFile (TextStream &)
 
void writeNamespaceDeclarations (OutputList &ol, const QCString &title, bool isConstantGroup=false)
 

Private 属性

QCString fileName
 
FileList files
 
LinkedRefMap< const NamespaceDefm_usingDirList
 
LinkedRefMap< const ClassDefm_usingDeclList
 
LinkedRefMap< const Definitionm_innerCompounds
 
MemberLinkedRefMap m_allMembers
 
MemberLists m_memberLists
 
MemberGroupList m_memberGroups
 
ClassLinkedRefMap classes
 
ClassLinkedRefMap interfaces
 
ClassLinkedRefMap structs
 
ClassLinkedRefMap exceptions
 
ConceptLinkedRefMap m_concepts
 
NamespaceLinkedRefMap namespaces
 
bool m_subGrouping = false
 
enum NamespaceDefImpl:: { ... }  m_type
 
bool m_isPublished = false
 
QCString metaData
 
bool m_inline = false
 

额外继承的成员函数

- Public 类型 继承自 Definition
enum  DefType {
  TypeClass = 0, TypeFile = 1, TypeNamespace = 2, TypeMember = 3,
  TypeGroup = 4, TypePackage = 5, TypePage = 6, TypeDir = 7,
  TypeConcept = 8
}
 
- Protected 成员函数 继承自 DefinitionMixin< NamespaceDefMutable >
 DefinitionMixin (const DefinitionMixin &def)=default
 

详细描述

在文件 namespacedef.cpp52 行定义.

成员枚举类型说明

◆ anonymous enum

anonymous enum
private
枚举值
NAMESPACE 
MODULE 
CONSTANT_GROUP 
LIBRARY 

在文件 namespacedef.cpp157 行定义.

构造及析构函数说明

◆ NamespaceDefImpl()

NamespaceDefImpl::NamespaceDefImpl ( const QCString defFileName,
int  defLine,
int  defColumn,
const QCString name,
const QCString ref = QCString(),
const QCString refFile = QCString(),
const QCString type = QCString(),
bool  isPublished = false 
)

在文件 namespacedef.cpp255 行定义.

258  :
259  DefinitionMixin(df,dl,dc,name)
260  ,m_isPublished(isPublished)
261 {
262  if (!fName.isEmpty())
263  {
264  if (!lref.isEmpty())
265  {
266  fileName = stripExtension(fName);
267  }
268  else
269  {
271  }
272  }
273  else
274  {
275  setFileName(name);
276  }
277  setReference(lref);
278  m_inline=FALSE;
279  m_subGrouping=Config_getBool(SUBGROUPING);
280  if (type=="module")
281  {
282  m_type = MODULE;
283  }
284  else if (type=="constants")
285  {
287  }
288  else if (type=="library")
289  {
290  m_type = LIBRARY;
291  }
292  else
293  {
294  m_type = NAMESPACE;
295  }
296 }

引用了 Config_getBool, CONSTANT_GROUP, convertNameToFile(), FALSE, fileName, QCString::isEmpty(), LIBRARY, m_inline, m_subGrouping, m_type, MODULE, DefinitionMixin< NamespaceDefMutable >::name(), NAMESPACE, setFileName(), DefinitionMixin< NamespaceDefMutable >::setReference() , 以及 stripExtension().

◆ ~NamespaceDefImpl()

NamespaceDefImpl::~NamespaceDefImpl ( )
virtual

在文件 namespacedef.cpp298 行定义.

299 {
300 }

成员函数说明

◆ addInnerCompound()

◆ addListReferences()

void NamespaceDefImpl::addListReferences ( )
virtual

实现了 NamespaceDefMutable.

在文件 namespacedef.cpp1208 行定义.

1209 {
1210  //bool fortranOpt = Config_getBool(OPTIMIZE_FOR_FORTRAN);
1211  {
1212  const RefItemVector &xrefItems = xrefListItems();
1213  addRefItem(xrefItems,
1214  qualifiedName(),
1219  QCString(),
1220  this
1221  );
1222  }
1223  for (const auto &mg : m_memberGroups)
1224  {
1225  mg->addListReferences(this);
1226  }
1227  for (auto &ml : m_memberLists)
1228  {
1229  if (ml->listType()&MemberListType_documentationLists)
1230  {
1231  ml->addListReferences(this);
1232  }
1233  }
1234 }

引用了 addRefItem(), displayName(), DefinitionMixin< NamespaceDefMutable >::getLanguage(), getOutputFileBase(), m_memberGroups, m_memberLists, MemberListType_documentationLists, DefinitionMixin< NamespaceDefMutable >::qualifiedName(), SrcLangExt_Fortran, theTranslator, Translator::trModule(), Translator::trNamespace(), TRUE , 以及 DefinitionMixin< NamespaceDefMutable >::xrefListItems().

◆ addMembersToMemberGroup()

void NamespaceDefImpl::addMembersToMemberGroup ( )
virtual

实现了 NamespaceDefMutable.

在文件 namespacedef.cpp400 行定义.

401 {
402  for (auto &ml : m_memberLists)
403  {
404  if (ml->listType()&MemberListType_declarationLists)
405  {
407  }
408  }
409 
410  // add members inside sections to their groups
411  for (const auto &mg : m_memberGroups)
412  {
413  if (mg->allMembersInSameSection() && m_subGrouping)
414  {
415  //printf("----> addToDeclarationSection(%s)\n",qPrint(mg->header()));
416  mg->addToDeclarationSection();
417  }
418  }
419 }

引用了 m_memberGroups, m_memberLists, m_subGrouping , 以及 MemberListType_declarationLists.

◆ addMemberToList()

void NamespaceDefImpl::addMemberToList ( MemberListType  lt,
MemberDef md 
)
private

在文件 namespacedef.cpp1371 行定义.

1372 {
1373  static bool sortBriefDocs = Config_getBool(SORT_BRIEF_DOCS);
1374  static bool sortMemberDocs = Config_getBool(SORT_MEMBER_DOCS);
1375  const auto &ml = m_memberLists.get(lt,MemberListContainer::Namespace);
1376  ml->setNeedsSorting(
1377  ((ml->listType()&MemberListType_declarationLists) && sortBriefDocs) ||
1378  ((ml->listType()&MemberListType_documentationLists) && sortMemberDocs));
1379  ml->push_back(md);
1380 
1381  if (ml->listType()&MemberListType_declarationLists)
1382  {
1384  if (mdm)
1385  {
1386  mdm->setSectionList(this,ml.get());
1387  }
1388  }
1389 }

引用了 Config_getBool, MemberLists::get(), m_memberLists, MemberListType_declarationLists, MemberListType_documentationLists, Namespace, MemberDefMutable::setSectionList() , 以及 toMemberDefMutable().

被这些函数引用 insertMember().

◆ addNamespaceAttributes()

void NamespaceDefImpl::addNamespaceAttributes ( OutputList ol)
private

◆ addUsingDeclaration()

void NamespaceDefImpl::addUsingDeclaration ( const ClassDef cd)
virtual

实现了 NamespaceDefMutable.

在文件 namespacedef.cpp1180 行定义.

1181 {
1182  m_usingDeclList.add(cd->qualifiedName(),cd);
1183 }

引用了 LinkedRefMap< T, Hash, KeyEqual, Map >::add(), m_usingDeclList , 以及 Definition::qualifiedName().

被这些函数引用 combineUsingRelations().

◆ addUsingDirective()

void NamespaceDefImpl::addUsingDirective ( const NamespaceDef nd)
virtual

实现了 NamespaceDefMutable.

在文件 namespacedef.cpp1174 行定义.

1175 {
1176  m_usingDirList.add(nd->qualifiedName(),nd);
1177  //printf("%p: NamespaceDefImpl::addUsingDirective: %s:%d\n",this,qPrint(name()),m_usingDirList->count());
1178 }

引用了 LinkedRefMap< T, Hash, KeyEqual, Map >::add(), m_usingDirList , 以及 Definition::qualifiedName().

被这些函数引用 combineUsingRelations().

◆ anchor()

virtual QCString NamespaceDefImpl::anchor ( ) const
inlinevirtual

Returns the anchor within a page where this item can be found

实现了 NamespaceDef.

在文件 namespacedef.cpp64 行定义.

64 { return QCString(); }

◆ codeSymbolType()

virtual CodeSymbolType NamespaceDefImpl::codeSymbolType ( ) const
inlinevirtual

Used for syntax highlighting symbol class

实现了 Definition.

在文件 namespacedef.cpp61 行定义.

引用了 DefinitionMixin< NamespaceDefMutable >::getLanguage(), Namespace, Package , 以及 SrcLangExt_Java.

◆ combineUsingRelations()

void NamespaceDefImpl::combineUsingRelations ( NamespaceDefSet visitedNamespace)
virtual

实现了 NamespaceDefMutable.

在文件 namespacedef.cpp1252 行定义.

1253 {
1254  if (visitedNamespaces.find(this)!=visitedNamespaces.end()) return; // already processed
1255  visitedNamespaces.insert(this);
1256 
1258  for (auto &nd : usingDirList)
1259  {
1261  if (ndm)
1262  {
1263  ndm->combineUsingRelations(visitedNamespaces);
1264  }
1265  }
1266 
1267  for (auto &nd : usingDirList)
1268  {
1269  // add used namespaces of namespace nd to this namespace
1270  for (const auto &und : nd->getUsedNamespaces())
1271  {
1272  addUsingDirective(und);
1273  }
1274  // add used classes of namespace nd to this namespace
1275  for (const auto &ucd : nd->getUsedClasses())
1276  {
1277  addUsingDeclaration(ucd);
1278  }
1279  }
1280 }

引用了 addUsingDeclaration(), addUsingDirective(), NamespaceDefMutable::combineUsingRelations(), m_usingDirList , 以及 toNamespaceDefMutable().

◆ compoundTypeString()

QCString NamespaceDefImpl::compoundTypeString ( ) const
virtual

实现了 NamespaceDef.

在文件 namespacedef.cpp1497 行定义.

1498 {
1499  SrcLangExt lang = getLanguage();
1500  if (lang==SrcLangExt_Java)
1501  {
1502  return "package";
1503  }
1504  else if(lang==SrcLangExt_CSharp)
1505  {
1506  return "namespace";
1507  }
1508  else if (lang==SrcLangExt_Fortran)
1509  {
1510  return "module";
1511  }
1512  else if (lang==SrcLangExt_IDL)
1513  {
1514  if (isModule())
1515  {
1516  return "module";
1517  }
1518  else if (isConstantGroup())
1519  {
1520  return "constants";
1521  }
1522  else if (isLibrary())
1523  {
1524  return "library";
1525  }
1526  else
1527  {
1528  err_full(getDefFileName(),getDefLine(),"Internal inconsistency: namespace in IDL not module, library or constant group");
1529  }
1530  }
1531  return "namespace";
1532 }

引用了 err_full(), DefinitionMixin< NamespaceDefMutable >::getDefFileName(), DefinitionMixin< NamespaceDefMutable >::getDefLine(), DefinitionMixin< NamespaceDefMutable >::getLanguage(), isConstantGroup(), isLibrary(), isModule(), SrcLangExt_CSharp, SrcLangExt_Fortran, SrcLangExt_IDL , 以及 SrcLangExt_Java.

◆ computeAnchors()

void NamespaceDefImpl::computeAnchors ( )
virtual

实现了 NamespaceDefMutable.

在文件 namespacedef.cpp544 行定义.

545 {
547  if (allMemberList) allMemberList->setAnchors();
548 }

引用了 getMemberList(), MemberListType_allMembersList , 以及 MemberList::setAnchors().

◆ countMembers()

void NamespaceDefImpl::countMembers ( )
virtual

实现了 NamespaceDefMutable.

在文件 namespacedef.cpp1154 行定义.

1155 {
1156  for (auto &ml : m_memberLists)
1157  {
1158  ml->countDecMembers();
1159  ml->countDocMembers();
1160  }
1161  for (const auto &mg : m_memberGroups)
1162  {
1163  mg->countDecMembers();
1164  mg->countDocMembers();
1165  }
1166 }

引用了 m_memberGroups , 以及 m_memberLists.

◆ definitionType()

virtual DefType NamespaceDefImpl::definitionType ( ) const
inlinevirtual

Use this for dynamic inspection of the type of the derived class

实现了 NamespaceDef.

在文件 namespacedef.cpp60 行定义.

60 { return TypeNamespace; }

引用了 Definition::TypeNamespace.

◆ displayName()

QCString NamespaceDefImpl::displayName ( bool  includeScope = TRUE) const
virtual

Returns the name of the definition as it appears in the output

实现了 NamespaceDef.

在文件 namespacedef.cpp1236 行定义.

1237 {
1238  return makeDisplayName(this,includeScope);
1239 }

引用了 makeDisplayName().

被这些函数引用 addListReferences(), title(), writeDocumentation(), writeMemberDocumentation() , 以及 writeMemberPages().

◆ distributeMemberGroupDocumentation()

void NamespaceDefImpl::distributeMemberGroupDocumentation ( )
virtual

实现了 NamespaceDefMutable.

在文件 namespacedef.cpp314 行定义.

315 {
316  for (const auto &mg : m_memberGroups)
317  {
318  mg->distributeMemberGroupDocumentation();
319  }
320 }

引用了 m_memberGroups.

◆ endMemberDeclarations()

void NamespaceDefImpl::endMemberDeclarations ( OutputList ol)
private

在文件 namespacedef.cpp742 行定义.

743 {
744  ol.endMemberSections();
745 }

引用了 OutputList::endMemberSections().

被这些函数引用 writeDocumentation().

◆ endMemberDocumentation()

void NamespaceDefImpl::endMemberDocumentation ( OutputList ol)
private

在文件 namespacedef.cpp756 行定义.

757 {
758  if (Config_getBool(SEPARATE_MEMBER_PAGES))
759  {
762  }
763 }

引用了 Config_getBool, OutputList::enable(), FALSE, OutputGenerator::Html , 以及 Doxygen::suppressDocWarnings.

被这些函数引用 writeDocumentation().

◆ findInnerCompound()

const Definition * NamespaceDefImpl::findInnerCompound ( const QCString name) const
virtual

重载 DefinitionMixin< NamespaceDefMutable > .

在文件 namespacedef.cpp1190 行定义.

1191 {
1192  if (n==0) return 0;
1193  const Definition *d = m_innerCompounds.find(n);
1194  if (d==0)
1195  {
1196  if (!m_usingDirList.empty())
1197  {
1198  d = m_usingDirList.find(n);
1199  }
1200  if (d==0 && !m_usingDeclList.empty())
1201  {
1202  d = m_usingDeclList.find(n);
1203  }
1204  }
1205  return d;
1206 }

引用了 LinkedRefMap< T, Hash, KeyEqual, Map >::empty(), LinkedRefMap< T, Hash, KeyEqual, Map >::find(), m_innerCompounds, m_usingDeclList , 以及 m_usingDirList.

◆ findSectionsInDocumentation()

void NamespaceDefImpl::findSectionsInDocumentation ( )
virtual

实现了 NamespaceDefMutable.

在文件 namespacedef.cpp322 行定义.

323 {
326  for (const auto &mg : m_memberGroups)
327  {
328  mg->findSectionsInDocumentation(this);
329  }
330  for (auto &ml : m_memberLists)
331  {
332  if (ml->listType()&MemberListType_declarationLists)
333  {
334  ml->findSectionsInDocumentation(this);
335  }
336  }
337 }

引用了 DefinitionMixin< NamespaceDefMutable >::briefDescription(), DefinitionMixin< NamespaceDefMutable >::docFile(), docFindSections(), DefinitionMixin< NamespaceDefMutable >::documentation(), m_memberGroups, m_memberLists , 以及 MemberListType_declarationLists.

◆ getClasses()

virtual ClassLinkedRefMap NamespaceDefImpl::getClasses ( ) const
inlinevirtual

Returns the classes contained in this namespace

实现了 NamespaceDef.

在文件 namespacedef.cpp105 行定义.

105 { return classes; }

引用了 classes.

◆ getConcepts()

virtual ConceptLinkedRefMap NamespaceDefImpl::getConcepts ( ) const
inlinevirtual

Returns the concepts contained in this namespace

实现了 NamespaceDef.

在文件 namespacedef.cpp110 行定义.

110 { return m_concepts; }

引用了 m_concepts.

◆ getExceptions()

virtual ClassLinkedRefMap NamespaceDefImpl::getExceptions ( ) const
inlinevirtual

Returns the Slice exceptions contained in this namespace

实现了 NamespaceDef.

在文件 namespacedef.cpp108 行定义.

108 { return exceptions; }

引用了 exceptions.

◆ getInterfaces()

virtual ClassLinkedRefMap NamespaceDefImpl::getInterfaces ( ) const
inlinevirtual

Returns the Slice interfaces contained in this namespace

实现了 NamespaceDef.

在文件 namespacedef.cpp106 行定义.

106 { return interfaces; }

引用了 interfaces.

◆ getMemberByName()

const MemberDef * NamespaceDefImpl::getMemberByName ( const QCString n) const
virtual

实现了 NamespaceDef.

在文件 namespacedef.cpp1467 行定义.

1468 {
1469  return m_allMembers.find(n);
1470 }

引用了 LinkedRefMap< T, Hash, KeyEqual, Map >::find() , 以及 m_allMembers.

◆ getMemberGroups()

virtual const MemberGroupList& NamespaceDefImpl::getMemberGroups ( ) const
inlinevirtual

Returns the user defined member groups

实现了 NamespaceDef.

在文件 namespacedef.cpp104 行定义.

104 { return m_memberGroups; }

引用了 m_memberGroups.

◆ getMemberList()

MemberList * NamespaceDefImpl::getMemberList ( MemberListType  lt) const
virtual

实现了 NamespaceDef.

在文件 namespacedef.cpp1419 行定义.

1420 {
1421  for (auto &ml : m_memberLists)
1422  {
1423  if (ml->listType()==lt)
1424  {
1425  return ml.get();
1426  }
1427  }
1428  return 0;
1429 }

引用了 m_memberLists.

被这些函数引用 computeAnchors(), insertMember(), numDocMembers(), writeDocumentation(), writeMemberDeclarations(), writeMemberDocumentation(), writeQuickMemberLinks(), writeSummaryLinks() , 以及 writeTagFile().

◆ getMemberLists()

virtual const MemberLists& NamespaceDefImpl::getMemberLists ( ) const
inlinevirtual

实现了 NamespaceDef.

在文件 namespacedef.cpp102 行定义.

102 { return m_memberLists; }

引用了 m_memberLists.

◆ getNamespaces()

virtual NamespaceLinkedRefMap NamespaceDefImpl::getNamespaces ( ) const
inlinevirtual

Returns the namespaces contained in this namespace

实现了 NamespaceDef.

在文件 namespacedef.cpp109 行定义.

109 { return namespaces; }

引用了 namespaces.

◆ getOutputFileBase()

QCString NamespaceDefImpl::getOutputFileBase ( ) const
virtual

Returns the base file name (without extension) of this definition. as it is referenced to/written to disk.

实现了 NamespaceDef.

在文件 namespacedef.cpp1185 行定义.

1186 {
1187  return fileName;
1188 }

引用了 fileName.

被这些函数引用 addListReferences(), writeBriefDescription(), writeDocumentation() , 以及 writeTagFile().

◆ getStructs()

virtual ClassLinkedRefMap NamespaceDefImpl::getStructs ( ) const
inlinevirtual

Returns the Slice structs contained in this namespace

实现了 NamespaceDef.

在文件 namespacedef.cpp107 行定义.

107 { return structs; }

引用了 structs.

◆ getUsedClasses()

virtual LinkedRefMap<const ClassDef> NamespaceDefImpl::getUsedClasses ( ) const
inlinevirtual

实现了 NamespaceDef.

在文件 namespacedef.cpp80 行定义.

80 { return m_usingDeclList; }

引用了 m_usingDeclList.

◆ getUsedNamespaces()

virtual LinkedRefMap<const NamespaceDef> NamespaceDefImpl::getUsedNamespaces ( ) const
inlinevirtual

实现了 NamespaceDef.

在文件 namespacedef.cpp78 行定义.

78 { return m_usingDirList; }

引用了 m_usingDirList.

◆ hasDetailedDescription()

bool NamespaceDefImpl::hasDetailedDescription ( ) const
virtual

实现了 NamespaceDef.

在文件 namespacedef.cpp550 行定义.

551 {
552  static bool repeatBrief = Config_getBool(REPEAT_BRIEF);
553  return ((!briefDescription().isEmpty() && repeatBrief) ||
554  !documentation().isEmpty());
555 }

引用了 DefinitionMixin< NamespaceDefMutable >::briefDescription(), Config_getBool , 以及 DefinitionMixin< NamespaceDefMutable >::documentation().

被这些函数引用 writeBriefDescription() , 以及 writeDetailedDescription().

◆ insertClass()

void NamespaceDefImpl::insertClass ( const ClassDef cd)
virtual

实现了 NamespaceDefMutable.

在文件 namespacedef.cpp366 行定义.

367 {
369 
370  if (Config_getBool(OPTIMIZE_OUTPUT_SLICE))
371  {
373  {
374  d = interfaces;
375  }
376  else if (cd->compoundType()==ClassDef::Struct)
377  {
378  d = structs;
379  }
380  else if (cd->compoundType()==ClassDef::Exception)
381  {
382  d = exceptions;
383  }
384  }
385 
386  d.add(cd->name(),cd);
387 }

引用了 LinkedRefMap< T, Hash, KeyEqual, Map >::add(), classes, ClassDef::compoundType(), Config_getBool, ClassDef::Exception, exceptions, ClassDef::Interface, interfaces, Definition::name(), ClassDef::Struct , 以及 structs.

被这些函数引用 addInnerCompound().

◆ insertConcept()

void NamespaceDefImpl::insertConcept ( const ConceptDef cd)
virtual

实现了 NamespaceDefMutable.

在文件 namespacedef.cpp389 行定义.

390 {
391  m_concepts.add(cd->name(),cd);
392 }

引用了 LinkedRefMap< T, Hash, KeyEqual, Map >::add(), m_concepts , 以及 Definition::name().

被这些函数引用 addInnerCompound().

◆ insertMember()

void NamespaceDefImpl::insertMember ( MemberDef md)
virtual

实现了 NamespaceDefMutable.

在文件 namespacedef.cpp421 行定义.

422 {
423  //printf("%s::insertMember(%s) isInline=%d hasDocs=%d\n",qPrint(name()),qPrint(md->name()),
424  // isInline(),hasDocumentation());
425  if (md->isHidden()) return;
427 
428  // if this is an inline namespace that is not documented, then insert the
429  // member in the parent scope instead
430  if (isInline() && !hasDocumentation())
431  {
432  Definition *outerScope = getOuterScope();
433  if (outerScope)
434  {
435  if (outerScope->definitionType()==Definition::TypeNamespace)
436  {
437  NamespaceDefMutable *nd = toNamespaceDefMutable(outerScope);
438  if (nd)
439  {
440  nd->insertMember(md);
441  if (mdm)
442  {
443  mdm->setNamespace(nd);
444  }
445  }
446  }
447  else if (outerScope->definitionType()==Definition::TypeFile)
448  {
449  FileDef *fd = toFileDef(outerScope);
450  fd->insertMember(md);
451  if (mdm)
452  {
453  mdm->setFileDef(fd);
454  mdm->setOuterScope(fd);
455  }
456  }
457  }
458  }
459  else // member is a non-inline namespace or a documented inline namespace
460  {
462  if (allMemberList==0)
463  {
464  m_memberLists.emplace_back(std::make_unique<MemberList>(MemberListType_allMembersList,MemberListContainer::Namespace));
465  allMemberList = m_memberLists.back().get();
466  }
467  allMemberList->push_back(md);
468  //printf("%s::m_allMembersDict->append(%s)\n",qPrint(name()),qPrint(md->localName()));
469  m_allMembers.add(md->localName(),md);
470  //::addNamespaceMemberNameToIndex(md);
471  //static bool sortBriefDocs=Config_getBool(SORT_BRIEF_DOCS);
472  switch(md->memberType())
473  {
474  case MemberType_Variable:
477  break;
478  case MemberType_Function:
481  break;
482  case MemberType_Typedef:
485  break;
486  case MemberType_Sequence:
489  break;
493  break;
497  break;
499  break;
500  case MemberType_Define:
503  break;
504  default:
505  err("NamespaceDefImpl::insertMembers(): "
506  "member '%s' with class scope '%s' inserted in namespace scope '%s'!\n",
507  qPrint(md->name()),
508  md->getClassDef() ? qPrint(md->getClassDef()->name()) : "",
509  qPrint(name()));
510  }
511  // if this is an inline namespace, then insert an alias of this member in the outer scope.
512  if (isInline())
513  {
514  Definition *outerScope = getOuterScope();
515  if (outerScope)
516  {
517  std::unique_ptr<MemberDef> aliasMd;
518  if (outerScope->definitionType()==Definition::TypeNamespace)
519  {
520  aliasMd.reset(createMemberDefAlias(outerScope,md));
521  NamespaceDefMutable *ndm = toNamespaceDefMutable(outerScope);
522  if (ndm)
523  {
524  ndm->insertMember(aliasMd.get());
525  }
526  }
527  else if (outerScope->definitionType()==Definition::TypeFile)
528  {
529  aliasMd.reset(createMemberDefAlias(outerScope,md));
530  toFileDef(outerScope)->insertMember(aliasMd.get());
531  }
532  if (aliasMd)
533  {
534  MemberName *mn;
535  QCString name = md->name();
537  mn->push_back(std::move(aliasMd));
538  }
539  }
540  }
541  }
542 }

引用了 LinkedMap< T, Hash, KeyEqual, Map >::add(), LinkedRefMap< T, Hash, KeyEqual, Map >::add(), addMemberToList(), createMemberDefAlias(), Definition::definitionType(), err(), Doxygen::functionNameLinkedMap, MemberLists::get(), MemberDef::getClassDef(), getMemberList(), DefinitionMixin< NamespaceDefMutable >::getOuterScope(), DefinitionMixin< NamespaceDefMutable >::hasDocumentation(), NamespaceDefMutable::insertMember(), FileDef::insertMember(), Definition::isHidden(), isInline(), Definition::localName(), m_allMembers, m_memberLists, MemberListType_allMembersList, MemberListType_decDefineMembers, MemberListType_decDictionaryMembers, MemberListType_decEnumMembers, MemberListType_decFuncMembers, MemberListType_decSequenceMembers, MemberListType_decTypedefMembers, MemberListType_decVarMembers, MemberListType_docDefineMembers, MemberListType_docDictionaryMembers, MemberListType_docEnumMembers, MemberListType_docFuncMembers, MemberListType_docSequenceMembers, MemberListType_docTypedefMembers, MemberListType_docVarMembers, MemberDef::memberType(), MemberType_Define, MemberType_Dictionary, MemberType_Enumeration, MemberType_EnumValue, MemberType_Function, MemberType_Sequence, MemberType_Typedef, MemberType_Variable, Definition::name(), DefinitionMixin< NamespaceDefMutable >::name(), Namespace, MemberVector::push_back(), MemberName::push_back(), qPrint(), MemberDefMutable::setFileDef(), MemberDefMutable::setNamespace(), DefinitionMutable::setOuterScope(), toFileDef(), toMemberDefMutable(), toNamespaceDefMutable(), Definition::TypeFile , 以及 Definition::TypeNamespace.

◆ insertNamespace()

void NamespaceDefImpl::insertNamespace ( const NamespaceDef nd)
virtual

实现了 NamespaceDefMutable.

在文件 namespacedef.cpp394 行定义.

395 {
396  namespaces.add(nd->name(),nd);
397 }

引用了 LinkedRefMap< T, Hash, KeyEqual, Map >::add(), Definition::name() , 以及 namespaces.

被这些函数引用 addInnerCompound().

◆ insertUsedFile()

void NamespaceDefImpl::insertUsedFile ( FileDef fd)
virtual

实现了 NamespaceDefMutable.

在文件 namespacedef.cpp339 行定义.

340 {
341  if (fd==0) return;
342  auto it = std::find(files.begin(),files.end(),fd);
343  if (it==files.end())
344  {
345  files.push_back(fd);
346  }
347 }

引用了 files.

◆ isConstantGroup()

virtual bool NamespaceDefImpl::isConstantGroup ( ) const
inlinevirtual

实现了 NamespaceDef.

在文件 namespacedef.cpp85 行定义.

85 { return CONSTANT_GROUP == m_type; }

引用了 CONSTANT_GROUP , 以及 m_type.

被这些函数引用 addNamespaceAttributes(), compoundTypeString(), title() , 以及 writeNamespaceDeclarations().

◆ isInline()

virtual bool NamespaceDefImpl::isInline ( ) const
inlinevirtual

实现了 NamespaceDef.

在文件 namespacedef.cpp88 行定义.

88 { return m_inline; }

引用了 m_inline.

被这些函数引用 insertMember() , 以及 setInline().

◆ isLibrary()

virtual bool NamespaceDefImpl::isLibrary ( ) const
inlinevirtual

实现了 NamespaceDef.

在文件 namespacedef.cpp87 行定义.

87 { return LIBRARY == m_type; }

引用了 LIBRARY , 以及 m_type.

被这些函数引用 compoundTypeString().

◆ isLinkable()

bool NamespaceDefImpl::isLinkable ( ) const
virtual

Returns TRUE iff it is possible to link to this item. This can be a link to another project imported via a tag file.

实现了 NamespaceDef.

在文件 namespacedef.cpp1462 行定义.

1463 {
1464  return isLinkableInProject() || isReference();
1465 }

引用了 isLinkableInProject() , 以及 DefinitionMixin< NamespaceDefMutable >::isReference().

◆ isLinkableInProject()

bool NamespaceDefImpl::isLinkableInProject ( ) const
virtual

Returns TRUE iff it is possible to link to this item within this project.

实现了 NamespaceDef.

在文件 namespacedef.cpp1444 行定义.

1445 {
1446  int i = name().findRev("::");
1447  if (i==-1) i=0; else i+=2;
1448  static bool extractAnonNs = Config_getBool(EXTRACT_ANON_NSPACES);
1449  if (extractAnonNs && // extract anonymous ns
1450  name().mid(i,20)=="anonymous_namespace{" // correct prefix
1451  ) // not disabled by config
1452  {
1453  return TRUE;
1454  }
1455  return !name().isEmpty() && name().at(i)!='@' && // not anonymous
1456  (hasDocumentation() || getLanguage()==SrcLangExt_CSharp) && // documented
1457  !isReference() && // not an external reference
1458  !isHidden() && // not hidden
1459  !isArtificial(); // or artificial
1460 }

引用了 QCString::at(), Config_getBool, QCString::findRev(), DefinitionMixin< NamespaceDefMutable >::getLanguage(), DefinitionMixin< NamespaceDefMutable >::hasDocumentation(), DefinitionMixin< NamespaceDefMutable >::isArtificial(), QCString::isEmpty(), DefinitionMixin< NamespaceDefMutable >::isHidden(), DefinitionMixin< NamespaceDefMutable >::isReference(), DefinitionMixin< NamespaceDefMutable >::name(), SrcLangExt_CSharp , 以及 TRUE.

被这些函数引用 isLinkable().

◆ isModule()

virtual bool NamespaceDefImpl::isModule ( ) const
inlinevirtual

实现了 NamespaceDef.

在文件 namespacedef.cpp86 行定义.

86 { return NAMESPACE == m_type || MODULE == m_type; }

引用了 m_type, MODULE , 以及 NAMESPACE.

被这些函数引用 compoundTypeString().

◆ localName()

QCString NamespaceDefImpl::localName ( ) const
virtual

Returns the local name without any scope qualifiers.

实现了 NamespaceDef.

在文件 namespacedef.cpp1241 行定义.

1242 {
1243  QCString result=name();
1244  int i=result.findRev("::");
1245  if (i!=-1)
1246  {
1247  result=result.mid(i+2);
1248  }
1249  return result;
1250 }

引用了 QCString::findRev(), QCString::mid() , 以及 DefinitionMixin< NamespaceDefMutable >::name().

◆ numDocMembers()

int NamespaceDefImpl::numDocMembers ( ) const
virtual

实现了 NamespaceDef.

在文件 namespacedef.cpp1168 行定义.

1169 {
1171  return (allMemberList ? allMemberList->numDocMembers() : 0) + (int)m_innerCompounds.size();
1172 }

引用了 getMemberList(), m_innerCompounds, MemberListType_allMembersList, MemberList::numDocMembers() , 以及 LinkedRefMap< T, Hash, KeyEqual, Map >::size().

◆ setFileName()

void NamespaceDefImpl::setFileName ( const QCString fn)
virtual

实现了 NamespaceDefMutable.

在文件 namespacedef.cpp302 行定义.

303 {
304  if (isReference())
305  {
306  fileName = "namespace"+fn;
307  }
308  else
309  {
310  fileName = convertNameToFile("namespace"+fn);
311  }
312 }

引用了 convertNameToFile(), fileName , 以及 DefinitionMixin< NamespaceDefMutable >::isReference().

被这些函数引用 NamespaceDefImpl().

◆ setInline()

virtual void NamespaceDefImpl::setInline ( bool  isInline)
inlinevirtual

实现了 NamespaceDefMutable.

在文件 namespacedef.cpp84 行定义.

84 { m_inline = isInline; }

引用了 isInline() , 以及 m_inline.

◆ setMetaData()

void NamespaceDefImpl::setMetaData ( const QCString m)
virtual

实现了 NamespaceDefMutable.

在文件 namespacedef.cpp1534 行定义.

1535 {
1536  metaData = m;
1537 }

引用了 metaData.

◆ sortMemberLists()

void NamespaceDefImpl::sortMemberLists ( )
virtual

实现了 NamespaceDefMutable.

在文件 namespacedef.cpp1391 行定义.

1392 {
1393  for (auto &ml : m_memberLists)
1394  {
1395  if (ml->needsSorting()) { ml->sort(); ml->setNeedsSorting(FALSE); }
1396  }
1397 
1398  auto classComp = [](const ClassLinkedRefMap::Ptr &c1,const ClassLinkedRefMap::Ptr &c2)
1399  {
1400  return Config_getBool(SORT_BY_SCOPE_NAME) ?
1401  qstricmp(c1->name(), c2->name())<0 :
1402  qstricmp(c1->className(), c2->className())<0;
1403  };
1404 
1405  std::sort(classes.begin(), classes.end(), classComp);
1406  std::sort(interfaces.begin(),interfaces.end(),classComp);
1407  std::sort(structs.begin(), structs.end(), classComp);
1408  std::sort(exceptions.begin(),exceptions.end(),classComp);
1409 
1410 
1411  auto namespaceComp = [](const NamespaceLinkedRefMap::Ptr &n1,const NamespaceLinkedRefMap::Ptr &n2)
1412  {
1413  return qstricmp(n1->name(),n2->name())<0;
1414  };
1415 
1416  std::sort(namespaces.begin(),namespaces.end(),namespaceComp);
1417 }

引用了 LinkedRefMap< T, Hash, KeyEqual, Map >::begin(), classes, ClassDef::className(), Config_getBool, LinkedRefMap< T, Hash, KeyEqual, Map >::end(), exceptions, FALSE, interfaces, m_memberLists, Definition::name(), namespaces, qstricmp() , 以及 structs.

◆ startMemberDeclarations()

void NamespaceDefImpl::startMemberDeclarations ( OutputList ol)
private

在文件 namespacedef.cpp737 行定义.

738 {
739  ol.startMemberSections();
740 }

引用了 OutputList::startMemberSections().

被这些函数引用 writeDocumentation().

◆ startMemberDocumentation()

void NamespaceDefImpl::startMemberDocumentation ( OutputList ol)
private

在文件 namespacedef.cpp747 行定义.

748 {
749  if (Config_getBool(SEPARATE_MEMBER_PAGES))
750  {
753  }
754 }

引用了 Config_getBool, OutputList::disable(), OutputGenerator::Html, Doxygen::suppressDocWarnings , 以及 TRUE.

被这些函数引用 writeDocumentation().

◆ subGrouping()

virtual bool NamespaceDefImpl::subGrouping ( ) const
inlinevirtual

实现了 NamespaceDef.

在文件 namespacedef.cpp100 行定义.

100 { return m_subGrouping; }

引用了 m_subGrouping.

◆ title()

QCString NamespaceDefImpl::title ( ) const
virtual

◆ writeAuthorSection()

◆ writeBriefDescription()

void NamespaceDefImpl::writeBriefDescription ( OutputList ol)
private

在文件 namespacedef.cpp677 行定义.

678 {
679  if (hasBriefDescription())
680  {
681  std::unique_ptr<IDocParser> parser { createDocParser() };
682  std::unique_ptr<DocRoot> rootNode { validatingParseDoc(*parser.get(),
683  briefFile(),briefLine(),this,0,
685  QCString(),TRUE,FALSE,Config_getBool(MARKDOWN_SUPPORT)) };
686  if (rootNode && !rootNode->isEmpty())
687  {
688  ol.startParagraph();
689  ol.pushGeneratorState();
691  ol.writeString(" - ");
692  ol.popGeneratorState();
693  ol.writeDoc(rootNode.get(),this,0);
694  ol.pushGeneratorState();
696  ol.writeString(" \n");
698 
700  {
702  ol.startTextLink(getOutputFileBase(),"details");
704  ol.endTextLink();
705  }
706  ol.popGeneratorState();
707  ol.endParagraph();
708  }
709 
710  // FIXME:PARA
711  //ol.pushGeneratorState();
712  //ol.disable(OutputGenerator::RTF);
713  //ol.newParagraph();
714  //ol.popGeneratorState();
715  }
716 
717  // Write a summary of the Slice definition including metadata.
718  if (getLanguage() == SrcLangExt_Slice)
719  {
720  ol.startParagraph();
721  ol.startTypewriter();
722  if (!metaData.isEmpty())
723  {
724  ol.docify(metaData);
725  ol.lineBreak();
726  }
727  ol.docify("module ");
728  ol.docify(stripScope(name()));
729  ol.docify(" { ... }");
730  ol.endTypewriter();
731  ol.endParagraph();
732  }
733 
734  ol.writeSynopsis();
735 }

引用了 DefinitionMixin< NamespaceDefMutable >::briefDescription(), DefinitionMixin< NamespaceDefMutable >::briefFile(), DefinitionMixin< NamespaceDefMutable >::briefLine(), Config_getBool, createDocParser(), OutputList::disable(), OutputList::disableAllBut(), OutputList::docify(), OutputList::enable(), OutputList::endParagraph(), OutputList::endTextLink(), OutputList::endTypewriter(), FALSE, DefinitionMixin< NamespaceDefMutable >::getLanguage(), getOutputFileBase(), DefinitionMixin< NamespaceDefMutable >::hasBriefDescription(), hasDetailedDescription(), OutputGenerator::Html, QCString::isEmpty(), OutputList::lineBreak(), OutputGenerator::Man, metaData, DefinitionMixin< NamespaceDefMutable >::name(), OutputList::parseText(), OutputList::popGeneratorState(), OutputList::pushGeneratorState(), OutputGenerator::RTF, SrcLangExt_Slice, OutputList::startParagraph(), OutputList::startTextLink(), OutputList::startTypewriter(), stripScope(), theTranslator, Translator::trMore(), TRUE, validatingParseDoc(), OutputList::writeDoc(), OutputList::writeString() , 以及 OutputList::writeSynopsis().

被这些函数引用 writeDocumentation().

◆ writeClassDeclarations()

void NamespaceDefImpl::writeClassDeclarations ( OutputList ol,
const QCString title,
const ClassLinkedRefMap d 
)
private

在文件 namespacedef.cpp765 行定义.

766 {
767  d.writeDeclaration(ol,0,title,TRUE);
768 }

引用了 title(), TRUE , 以及 ClassLinkedRefMap::writeDeclaration().

被这些函数引用 writeDocumentation().

◆ writeClassesToTagFile()

void NamespaceDefImpl::writeClassesToTagFile ( TextStream tagFile,
const ClassLinkedRefMap d 
)
private

在文件 namespacedef.cpp900 行定义.

901 {
902  for (const auto &cd : list)
903  {
904  if (cd->isLinkableInProject())
905  {
906  tagFile << " <class kind=\"" << cd->compoundTypeString()
907  << "\">" << convertToXML(cd->name()) << "</class>\n";
908  }
909  }
910 }

引用了 convertToXML().

被这些函数引用 writeTagFile().

◆ writeConcepts()

void NamespaceDefImpl::writeConcepts ( OutputList ol,
const QCString title 
)
private

在文件 namespacedef.cpp770 行定义.

771 {
773 }

引用了 m_concepts, title(), TRUE , 以及 ConceptLinkedRefMap::writeDeclaration().

被这些函数引用 writeDocumentation().

◆ writeConceptsToTagFile()

void NamespaceDefImpl::writeConceptsToTagFile ( TextStream tagFile)
private

在文件 namespacedef.cpp912 行定义.

913 {
914  for (const auto &cd : m_concepts)
915  {
916  if (cd->isLinkableInProject())
917  {
918  tagFile << " <concept>" << convertToXML(cd->name()) << "</concept>\n";
919  }
920  }
921 }

引用了 convertToXML() , 以及 m_concepts.

被这些函数引用 writeTagFile().

◆ writeDetailedDescription()

void NamespaceDefImpl::writeDetailedDescription ( OutputList ol,
const QCString title 
)
private

在文件 namespacedef.cpp633 行定义.

634 {
636  {
637  ol.pushGeneratorState();
639  ol.writeRuler();
640  ol.popGeneratorState();
641  ol.pushGeneratorState();
643  ol.writeAnchor(QCString(),"details");
644  ol.popGeneratorState();
645  ol.startGroupHeader();
646  ol.parseText(title);
647  ol.endGroupHeader();
648 
649  ol.startTextBlock();
650  if (!briefDescription().isEmpty() && Config_getBool(REPEAT_BRIEF))
651  {
653  QCString(),FALSE,FALSE,Config_getBool(MARKDOWN_SUPPORT));
654  }
655  if (!briefDescription().isEmpty() && Config_getBool(REPEAT_BRIEF) &&
656  !documentation().isEmpty())
657  {
658  ol.pushGeneratorState();
661  //ol.newParagraph(); // FIXME:PARA
662  ol.enableAll();
665  ol.writeString("\n\n");
666  ol.popGeneratorState();
667  }
668  if (!documentation().isEmpty())
669  {
670  ol.generateDoc(docFile(),docLine(),this,0,documentation()+"\n",TRUE,FALSE,
671  QCString(),FALSE,FALSE,Config_getBool(MARKDOWN_SUPPORT));
672  }
673  ol.endTextBlock();
674  }
675 }

引用了 DefinitionMixin< NamespaceDefMutable >::briefDescription(), DefinitionMixin< NamespaceDefMutable >::briefFile(), DefinitionMixin< NamespaceDefMutable >::briefLine(), Config_getBool, OutputList::disable(), OutputList::disableAllBut(), DefinitionMixin< NamespaceDefMutable >::docFile(), DefinitionMixin< NamespaceDefMutable >::docLine(), DefinitionMixin< NamespaceDefMutable >::documentation(), OutputList::enable(), OutputList::enableAll(), OutputList::endGroupHeader(), OutputList::endTextBlock(), FALSE, OutputList::generateDoc(), hasDetailedDescription(), OutputGenerator::Html, OutputGenerator::Latex, OutputGenerator::Man, OutputList::parseText(), OutputList::popGeneratorState(), OutputList::pushGeneratorState(), OutputGenerator::RTF, OutputList::startGroupHeader(), OutputList::startTextBlock(), title(), TRUE, OutputList::writeAnchor(), OutputList::writeRuler() , 以及 OutputList::writeString().

被这些函数引用 writeDocumentation().

◆ writeDocumentation()

void NamespaceDefImpl::writeDocumentation ( OutputList ol)
virtual

实现了 NamespaceDefMutable.

在文件 namespacedef.cpp923 行定义.

924 {
925  static bool generateTreeView = Config_getBool(GENERATE_TREEVIEW);
926  //static bool outputJava = Config_getBool(OPTIMIZE_OUTPUT_JAVA);
927  //static bool fortranOpt = Config_getBool(OPTIMIZE_FOR_FORTRAN);
928 
929  QCString pageTitle = title();
930  startFile(ol,getOutputFileBase(),name(),pageTitle,HLI_NamespaceVisible,!generateTreeView);
931 
932  if (!generateTreeView)
933  {
935  {
937  }
938  ol.endQuickIndices();
939  }
940 
941  startTitle(ol,getOutputFileBase(),this);
942  ol.parseText(pageTitle);
943  addGroupListToTitle(ol,this);
946  ol.startContents();
947 
948  //if (Doxygen::searchIndex)
949  //{
950  // Doxygen::searchIndex->setCurrentDoc(this,anchor(),FALSE);
951  // Doxygen::searchIndex->addWord(localName(),TRUE);
952  //}
953  //Doxygen::indexList->addIndexItem(this,0);
954 
955  //---------------------------------------- start flexible part -------------------------------
956 
957  SrcLangExt lang = getLanguage();
958  for (const auto &lde : LayoutDocManager::instance().docEntries(LayoutDocManager::Namespace))
959  {
960  switch (lde->kind())
961  {
964  break;
967  break;
969  {
970  const LayoutDocEntrySection *ls = (const LayoutDocEntrySection*)lde.get();
971  writeClassDeclarations(ol,ls->title(lang),classes);
972  }
973  break;
975  {
976  const LayoutDocEntrySection *ls = (const LayoutDocEntrySection*)lde.get();
978  }
979  break;
981  {
982  const LayoutDocEntrySection *ls = (const LayoutDocEntrySection*)lde.get();
983  writeClassDeclarations(ol,ls->title(lang),structs);
984  }
985  break;
987  {
988  const LayoutDocEntrySection *ls = (const LayoutDocEntrySection*)lde.get();
990  }
991  break;
993  {
994  const LayoutDocEntrySection *ls = (const LayoutDocEntrySection*)lde.get();
995  writeConcepts(ol,ls->title(lang));
996  }
997  break;
999  {
1000  const LayoutDocEntrySection *ls = (const LayoutDocEntrySection*)lde.get();
1001  writeNamespaceDeclarations(ol,ls->title(lang),false);
1002  }
1003  break;
1005  {
1006  const LayoutDocEntrySection *ls = (const LayoutDocEntrySection*)lde.get();
1007  writeNamespaceDeclarations(ol,ls->title(lang),true);
1008  }
1009  break;
1011  writeMemberGroups(ol);
1012  break;
1014  {
1015  const LayoutDocEntryMemberDecl *lmd = (const LayoutDocEntryMemberDecl*)lde.get();
1016  writeMemberDeclarations(ol,lmd->type,lmd->title(lang));
1017  }
1018  break;
1021  break;
1023  {
1024  const LayoutDocEntrySection *ls = (const LayoutDocEntrySection*)lde.get();
1025  writeDetailedDescription(ol,ls->title(lang));
1026  }
1027  break;
1030  break;
1032  writeInlineClasses(ol);
1033  break;
1035  {
1036  const LayoutDocEntryMemberDef *lmd = (const LayoutDocEntryMemberDef*)lde.get();
1037  writeMemberDocumentation(ol,lmd->type,lmd->title(lang));
1038  }
1039  break;
1042  break;
1044  writeAuthorSection(ol);
1045  break;
1078  err("Internal inconsistency: member %d should not be part of "
1079  "LayoutDocManager::Namespace entry list\n",lde->kind());
1080  break;
1081  }
1082  }
1083 
1084  //---------------------------------------- end flexible part -------------------------------
1085 
1086  ol.endContents();
1087 
1088  endFileWithNavPath(this,ol);
1089 
1090  if (Config_getBool(SEPARATE_MEMBER_PAGES))
1091  {
1093  if (allMemberList) allMemberList->sort();
1094  writeMemberPages(ol);
1095  }
1096 }

引用了 addGroupListToTitle(), addNamespaceAttributes(), LayoutDocEntry::AuthorSection, LayoutDocEntry::BriefDesc, LayoutDocEntry::ClassAllMembersLink, LayoutDocEntry::ClassCollaborationGraph, classes, LayoutDocEntry::ClassIncludes, LayoutDocEntry::ClassInheritanceGraph, LayoutDocEntry::ClassInlineClasses, LayoutDocEntry::ClassNestedClasses, LayoutDocEntry::ClassUsedFiles, LayoutDocEntry::ConceptDefinition, Config_getBool, LayoutDocEntry::DetailedDesc, LayoutDocEntry::DirFiles, LayoutDocEntry::DirGraph, LayoutDocEntry::DirSubDirs, displayName(), OutputList::endContents(), endFileWithNavPath(), endMemberDeclarations(), endMemberDocumentation(), OutputList::endQuickIndices(), endTitle(), err(), exceptions, LayoutDocEntry::FileClasses, LayoutDocEntry::FileConcepts, LayoutDocEntry::FileConstantGroups, LayoutDocEntry::FileExceptions, LayoutDocEntry::FileIncludedByGraph, LayoutDocEntry::FileIncludeGraph, LayoutDocEntry::FileIncludes, LayoutDocEntry::FileInlineClasses, LayoutDocEntry::FileInterfaces, LayoutDocEntry::FileNamespaces, LayoutDocEntry::FileSourceLink, LayoutDocEntry::FileStructs, DefinitionMixin< NamespaceDefMutable >::getLanguage(), getMemberList(), DefinitionMixin< NamespaceDefMutable >::getOuterScope(), getOutputFileBase(), Doxygen::globalScope, LayoutDocEntry::GroupClasses, LayoutDocEntry::GroupConcepts, LayoutDocEntry::GroupDirs, LayoutDocEntry::GroupFiles, LayoutDocEntry::GroupGraph, LayoutDocEntry::GroupInlineClasses, LayoutDocEntry::GroupNamespaces, LayoutDocEntry::GroupNestedGroups, LayoutDocEntry::GroupPageDocs, HLI_NamespaceVisible, LayoutDocManager::instance(), interfaces, LayoutDocEntry::MemberDecl, LayoutDocEntry::MemberDeclEnd, LayoutDocEntry::MemberDeclStart, LayoutDocEntry::MemberDef, LayoutDocEntry::MemberDefEnd, LayoutDocEntry::MemberDefStart, LayoutDocEntry::MemberGroups, MemberListType_allMembersList, DefinitionMixin< NamespaceDefMutable >::name(), LayoutDocManager::Namespace, LayoutDocEntry::NamespaceClasses, LayoutDocEntry::NamespaceConcepts, LayoutDocEntry::NamespaceExceptions, LayoutDocEntry::NamespaceInlineClasses, LayoutDocEntry::NamespaceInterfaces, LayoutDocEntry::NamespaceNestedConstantGroups, LayoutDocEntry::NamespaceNestedNamespaces, LayoutDocEntry::NamespaceStructs, OutputList::parseText(), MemberVector::sort(), OutputList::startContents(), startFile(), startMemberDeclarations(), startMemberDocumentation(), startTitle(), structs, LayoutDocEntrySection::title(), LayoutDocEntryMemberDecl::title(), title(), LayoutDocEntryMemberDef::title(), LayoutDocEntryMemberDecl::type, LayoutDocEntryMemberDef::type, writeAuthorSection(), writeBriefDescription(), writeClassDeclarations(), writeConcepts(), writeDetailedDescription(), writeInlineClasses(), writeMemberDeclarations(), writeMemberDocumentation(), writeMemberGroups(), writeMemberPages(), writeNamespaceDeclarations() , 以及 DefinitionMixin< NamespaceDefMutable >::writeNavigationPath().

◆ writeInlineClasses()

void NamespaceDefImpl::writeInlineClasses ( OutputList ol)
private

在文件 namespacedef.cpp775 行定义.

776 {
777  classes.writeDocumentation(ol,this);
778 }

引用了 classes , 以及 ClassLinkedRefMap::writeDocumentation().

被这些函数引用 writeDocumentation().

◆ writeMemberDeclarations()

void NamespaceDefImpl::writeMemberDeclarations ( OutputList ol,
MemberListType  lt,
const QCString title 
)
private

在文件 namespacedef.cpp1431 行定义.

1432 {
1433  MemberList * ml = getMemberList(lt);
1434  if (ml) ml->writeDeclarations(ol,0,this,0,0,title,QCString());
1435 }

引用了 getMemberList(), title() , 以及 MemberList::writeDeclarations().

被这些函数引用 writeDocumentation().

◆ writeMemberDocumentation()

void NamespaceDefImpl::writeMemberDocumentation ( OutputList ol,
MemberListType  lt,
const QCString title 
)
private

在文件 namespacedef.cpp1437 行定义.

1438 {
1439  MemberList * ml = getMemberList(lt);
1440  if (ml) ml->writeDocumentation(ol,displayName(),this,title);
1441 }

引用了 displayName(), getMemberList(), title() , 以及 MemberList::writeDocumentation().

被这些函数引用 writeDocumentation().

◆ writeMemberGroups()

void NamespaceDefImpl::writeMemberGroups ( OutputList ol)
private

在文件 namespacedef.cpp786 行定义.

787 {
788  /* write user defined member groups */
789  for (const auto &mg : m_memberGroups)
790  {
791  if ((!mg->allMembersInSameSection() || !m_subGrouping)
792  && mg->header()!="[NOHEADER]")
793  {
794  mg->writeDeclarations(ol,0,this,0,0);
795  }
796  }
797 }

引用了 m_memberGroups , 以及 m_subGrouping.

被这些函数引用 writeDocumentation().

◆ writeMemberPages()

void NamespaceDefImpl::writeMemberPages ( OutputList ol)
virtual

实现了 NamespaceDefMutable.

在文件 namespacedef.cpp1098 行定义.

1099 {
1100  ol.pushGeneratorState();
1102 
1103  for (const auto &ml : m_memberLists)
1104  {
1105  if (ml->listType()&MemberListType_documentationLists)
1106  {
1107  ml->writeDocumentationPage(ol,displayName(),this);
1108  }
1109  }
1110  ol.popGeneratorState();
1111 }

引用了 OutputList::disableAllBut(), displayName(), OutputGenerator::Html, m_memberLists, MemberListType_documentationLists, OutputList::popGeneratorState() , 以及 OutputList::pushGeneratorState().

被这些函数引用 writeDocumentation().

◆ writeNamespaceDeclarations()

void NamespaceDefImpl::writeNamespaceDeclarations ( OutputList ol,
const QCString title,
bool  isConstantGroup = false 
)
private

◆ writeQuickMemberLinks()

void NamespaceDefImpl::writeQuickMemberLinks ( OutputList ol,
const MemberDef currentMd 
) const
virtual

重载 DefinitionMixin< NamespaceDefMutable > .

在文件 namespacedef.cpp1113 行定义.

1114 {
1115  static bool createSubDirs=Config_getBool(CREATE_SUBDIRS);
1116 
1117  ol.writeString(" <div class=\"navtab\">\n");
1118  ol.writeString(" <table>\n");
1119 
1121  if (allMemberList)
1122  {
1123  for (const auto &md : *allMemberList)
1124  {
1125  if (md->getNamespaceDef()==this && md->isLinkable() && !md->isEnumValue())
1126  {
1127  if (md->isLinkableInProject())
1128  {
1129  if (md==currentMd) // selected item => highlight
1130  {
1131  ol.writeString(" <tr><td class=\"navtabHL\">");
1132  }
1133  else
1134  {
1135  ol.writeString(" <tr><td class=\"navtab\">");
1136  }
1137  ol.writeString("<a class=\"navtab\" ");
1138  ol.writeString("href=\"");
1139  if (createSubDirs) ol.writeString("../../");
1140  ol.writeString(addHtmlExtensionIfMissing(md->getOutputFileBase())+"#"+md->anchor());
1141  ol.writeString("\">");
1142  ol.writeString(convertToHtml(md->localName()));
1143  ol.writeString("</a>");
1144  ol.writeString("</td></tr>\n");
1145  }
1146  }
1147  }
1148  }
1149 
1150  ol.writeString(" </table>\n");
1151  ol.writeString(" </div>\n");
1152 }

引用了 addHtmlExtensionIfMissing(), Config_getBool, convertToHtml(), createSubDirs(), getMemberList(), MemberListType_allMembersList , 以及 OutputList::writeString().

◆ writeSummaryLinks()

void NamespaceDefImpl::writeSummaryLinks ( OutputList ol) const
privatevirtual

重载 DefinitionMixin< NamespaceDefMutable > .

在文件 namespacedef.cpp811 行定义.

812 {
813  ol.pushGeneratorState();
815  bool first=TRUE;
816  SrcLangExt lang = getLanguage();
817  for (const auto &lde : LayoutDocManager::instance().docEntries(LayoutDocManager::Namespace))
818  {
820  {
821  const LayoutDocEntrySection *ls = (const LayoutDocEntrySection*)lde.get();
822  QCString label = "nested-classes";
823  ol.writeSummaryLink(QCString(),label,ls->title(lang),first);
824  first=FALSE;
825  }
827  {
828  const LayoutDocEntrySection *ls = (const LayoutDocEntrySection*)lde.get();
829  QCString label = "interfaces";
830  ol.writeSummaryLink(QCString(),label,ls->title(lang),first);
831  first=FALSE;
832  }
833  else if (lde->kind()==LayoutDocEntry::NamespaceStructs && structs.declVisible())
834  {
835  const LayoutDocEntrySection *ls = (const LayoutDocEntrySection*)lde.get();
836  QCString label = "structs";
837  ol.writeSummaryLink(QCString(),label,ls->title(lang),first);
838  first=FALSE;
839  }
841  {
842  const LayoutDocEntrySection *ls = (const LayoutDocEntrySection*)lde.get();
843  QCString label = "exceptions";
844  ol.writeSummaryLink(QCString(),label,ls->title(lang),first);
845  first=FALSE;
846  }
847  else if (lde->kind()==LayoutDocEntry::NamespaceNestedNamespaces && namespaces.declVisible(false))
848  {
849  const LayoutDocEntrySection *ls = (const LayoutDocEntrySection*)lde.get();
850  QCString label = "namespaces";
851  ol.writeSummaryLink(QCString(),label,ls->title(lang),first);
852  first=FALSE;
853  }
855  {
856  const LayoutDocEntrySection *ls = (const LayoutDocEntrySection*)lde.get();
857  QCString label = "constantgroups";
858  ol.writeSummaryLink(QCString(),label,ls->title(lang),first);
859  first=FALSE;
860  }
861  else if (lde->kind()==LayoutDocEntry::NamespaceConcepts && m_concepts.declVisible())
862  {
863  const LayoutDocEntrySection *ls = (const LayoutDocEntrySection*)lde.get();
864  QCString label = "concepts";
865  ol.writeSummaryLink(QCString(),label,ls->title(lang),first);
866  first=FALSE;
867  }
868  else if (lde->kind()== LayoutDocEntry::MemberDecl)
869  {
870  const LayoutDocEntryMemberDecl *lmd = (const LayoutDocEntryMemberDecl*)lde.get();
871  MemberList * ml = getMemberList(lmd->type);
872  if (ml && ml->declVisible())
873  {
875  first=FALSE;
876  }
877  }
878  }
879  if (!first)
880  {
881  ol.writeString(" </div>\n");
882  }
883  ol.popGeneratorState();
884 }

引用了 classes, ClassLinkedRefMap::declVisible(), NamespaceLinkedRefMap::declVisible(), ConceptLinkedRefMap::declVisible(), MemberList::declVisible(), OutputList::disableAllBut(), exceptions, FALSE, DefinitionMixin< NamespaceDefMutable >::getLanguage(), getMemberList(), OutputGenerator::Html, LayoutDocManager::instance(), interfaces, MemberList::listType(), MemberList::listTypeAsString(), m_concepts, LayoutDocEntry::MemberDecl, LayoutDocManager::Namespace, LayoutDocEntry::NamespaceClasses, LayoutDocEntry::NamespaceConcepts, LayoutDocEntry::NamespaceExceptions, LayoutDocEntry::NamespaceInterfaces, LayoutDocEntry::NamespaceNestedConstantGroups, LayoutDocEntry::NamespaceNestedNamespaces, namespaces, LayoutDocEntry::NamespaceStructs, OutputList::popGeneratorState(), OutputList::pushGeneratorState(), structs, LayoutDocEntrySection::title(), LayoutDocEntryMemberDecl::title(), TRUE, LayoutDocEntryMemberDecl::type, OutputList::writeString() , 以及 OutputList::writeSummaryLink().

◆ writeTagFile()

void NamespaceDefImpl::writeTagFile ( TextStream tagFile)
virtual

实现了 NamespaceDefMutable.

在文件 namespacedef.cpp557 行定义.

558 {
559  tagFile << " <compound kind=\"namespace\">\n";
560  tagFile << " <name>" << convertToXML(name()) << "</name>\n";
561  tagFile << " <filename>" << addHtmlExtensionIfMissing(getOutputFileBase()) << "</filename>\n";
562  QCString idStr = id();
563  if (!idStr.isEmpty())
564  {
565  tagFile << " <clangid>" << convertToXML(idStr) << "</clangid>\n";
566  }
567  for (const auto &lde : LayoutDocManager::instance().docEntries(LayoutDocManager::Namespace))
568  {
569  switch (lde->kind())
570  {
572  {
573  for (const auto &nd : namespaces)
574  {
575  if (nd->isLinkableInProject())
576  {
577  tagFile << " <namespace>" << convertToXML(nd->name()) << "</namespace>\n";
578  }
579  }
580  }
581  break;
583  {
584  writeClassesToTagFile(tagFile, classes);
585  }
586  break;
588  {
590  }
591  break;
593  {
594  writeClassesToTagFile(tagFile, structs);
595  }
596  break;
598  {
600  }
601  break;
603  {
604  writeConceptsToTagFile(tagFile);
605  }
606  break;
608  {
609  const LayoutDocEntryMemberDecl *lmd = (const LayoutDocEntryMemberDecl*)lde.get();
610  MemberList * ml = getMemberList(lmd->type);
611  if (ml)
612  {
613  ml->writeTagFile(tagFile);
614  }
615  }
616  break;
618  {
619  for (const auto &mg : m_memberGroups)
620  {
621  mg->writeTagFile(tagFile);
622  }
623  }
624  break;
625  default:
626  break;
627  }
628  }
629  writeDocAnchorsToTagFile(tagFile);
630  tagFile << " </compound>\n";
631 }

引用了 addHtmlExtensionIfMissing(), classes, convertToXML(), exceptions, getMemberList(), getOutputFileBase(), DefinitionMixin< NamespaceDefMutable >::id(), LayoutDocManager::instance(), interfaces, QCString::isEmpty(), m_memberGroups, LayoutDocEntry::MemberDecl, LayoutDocEntry::MemberGroups, DefinitionMixin< NamespaceDefMutable >::name(), LayoutDocManager::Namespace, LayoutDocEntry::NamespaceClasses, LayoutDocEntry::NamespaceConcepts, LayoutDocEntry::NamespaceExceptions, LayoutDocEntry::NamespaceInterfaces, LayoutDocEntry::NamespaceNestedNamespaces, namespaces, LayoutDocEntry::NamespaceStructs, structs, LayoutDocEntryMemberDecl::type, writeClassesToTagFile(), writeConceptsToTagFile(), DefinitionMixin< NamespaceDefMutable >::writeDocAnchorsToTagFile() , 以及 MemberList::writeTagFile().

类成员变量说明

◆ classes

ClassLinkedRefMap NamespaceDefImpl::classes
private

◆ exceptions

ClassLinkedRefMap NamespaceDefImpl::exceptions
private

◆ fileName

QCString NamespaceDefImpl::fileName
private

在文件 namespacedef.cpp140 行定义.

被这些函数引用 getOutputFileBase(), NamespaceDefImpl() , 以及 setFileName().

◆ files

FileList NamespaceDefImpl::files
private

在文件 namespacedef.cpp141 行定义.

被这些函数引用 insertUsedFile().

◆ interfaces

ClassLinkedRefMap NamespaceDefImpl::interfaces
private

◆ m_allMembers

MemberLinkedRefMap NamespaceDefImpl::m_allMembers
private

在文件 namespacedef.cpp147 行定义.

被这些函数引用 getMemberByName() , 以及 insertMember().

◆ m_concepts

ConceptLinkedRefMap NamespaceDefImpl::m_concepts
private

◆ m_inline

bool NamespaceDefImpl::m_inline = false
private

在文件 namespacedef.cpp160 行定义.

被这些函数引用 isInline(), NamespaceDefImpl() , 以及 setInline().

◆ m_innerCompounds

LinkedRefMap<const Definition> NamespaceDefImpl::m_innerCompounds
private

在文件 namespacedef.cpp145 行定义.

被这些函数引用 addInnerCompound(), findInnerCompound() , 以及 numDocMembers().

◆ m_isPublished

bool NamespaceDefImpl::m_isPublished = false
private

在文件 namespacedef.cpp158 行定义.

被这些函数引用 addNamespaceAttributes().

◆ m_memberGroups

◆ m_memberLists

◆ m_subGrouping

bool NamespaceDefImpl::m_subGrouping = false
private

在文件 namespacedef.cpp156 行定义.

被这些函数引用 addMembersToMemberGroup(), NamespaceDefImpl(), subGrouping() , 以及 writeMemberGroups().

◆ m_type

enum { ... } NamespaceDefImpl::m_type

被这些函数引用 isConstantGroup(), isLibrary(), isModule() , 以及 NamespaceDefImpl().

◆ m_usingDeclList

LinkedRefMap<const ClassDef> NamespaceDefImpl::m_usingDeclList
private

在文件 namespacedef.cpp144 行定义.

被这些函数引用 addUsingDeclaration(), findInnerCompound() , 以及 getUsedClasses().

◆ m_usingDirList

LinkedRefMap<const NamespaceDef> NamespaceDefImpl::m_usingDirList
private

在文件 namespacedef.cpp143 行定义.

被这些函数引用 addUsingDirective(), combineUsingRelations(), findInnerCompound() , 以及 getUsedNamespaces().

◆ metaData

QCString NamespaceDefImpl::metaData
private

在文件 namespacedef.cpp159 行定义.

被这些函数引用 setMetaData() , 以及 writeBriefDescription().

◆ namespaces

NamespaceLinkedRefMap NamespaceDefImpl::namespaces
private

◆ structs

ClassLinkedRefMap NamespaceDefImpl::structs
private

该类的文档由以下文件生成:
DefinitionMixin< NamespaceDefMutable >::briefFile
virtual QCString briefFile() const
Definition: definitionimpl.h:171
LayoutDocEntry::GroupPageDocs
@ GroupPageDocs
Definition: layout.h:65
NamespaceDefImpl::writeInlineClasses
void writeInlineClasses(OutputList &ol)
Definition: namespacedef.cpp:775
LinkedRefMap::add
bool add(const char *k, T *obj)
Adds an object reference to the ordered vector if it was not added already.
Definition: linkedmap.h:284
OutputList::disableAllBut
void disableAllBut(OutputGenerator::OutputType o)
Definition: outputlist.cpp:76
DefinitionMixin< NamespaceDefMutable >::isReference
virtual bool isReference() const
Definition: definitionimpl.h:183
startTitle
void startTitle(OutputList &ol, const QCString &fileName, const DefinitionMutable *def)
Definition: index.cpp:219
Translator::trNamespaceReference
virtual QCString trNamespaceReference(const QCString &namespaceName)=0
LinkedRefMap::empty
bool empty() const
Definition: linkedmap.h:374
OutputList::startLabels
void startLabels()
Definition: outputlist.h:472
NamespaceDefImpl::namespaces
NamespaceLinkedRefMap namespaces
Definition: namespacedef.cpp:155
OutputList::endGroupHeader
void endGroupHeader(int extraLevels=0)
Definition: outputlist.h:171
NamespaceDefImpl::writeAuthorSection
void writeAuthorSection(OutputList &ol)
Definition: namespacedef.cpp:799
LayoutDocEntryMemberDecl::type
MemberListType type
Definition: layout.h:101
LayoutDocEntryMemberDecl
Represents of a member declaration list with configurable title and subtitle.
Definition: layout.h:94
LayoutDocEntry::NamespaceNestedNamespaces
@ NamespaceNestedNamespaces
Definition: layout.h:52
LinkedRefMap< const NamespaceDef >
NamespaceDefImpl::m_memberLists
MemberLists m_memberLists
Definition: namespacedef.cpp:148
MemberType_Variable
@ MemberType_Variable
Definition: types.h:278
MemberListType_docDictionaryMembers
@ MemberListType_docDictionaryMembers
Definition: types.h:193
ConceptLinkedRefMap::writeDeclaration
void writeDeclaration(OutputList &ol, const QCString &header, bool localNames) const
Definition: conceptdef.cpp:662
endTitle
void endTitle(OutputList &ol, const QCString &fileName, const QCString &name)
Definition: index.cpp:228
toMemberDefMutable
MemberDefMutable * toMemberDefMutable(Definition *d)
Definition: memberdef.cpp:6125
NamespaceDefImpl::m_concepts
ConceptLinkedRefMap m_concepts
Definition: namespacedef.cpp:154
NamespaceDefImpl::writeMemberDocumentation
void writeMemberDocumentation(OutputList &ol, MemberListType lt, const QCString &title)
Definition: namespacedef.cpp:1437
LayoutDocEntry::GroupConcepts
@ GroupConcepts
Definition: layout.h:63
Definition
The common base class of all entity definitions found in the sources.
Definition: definition.h:76
MemberListType_docEnumMembers
@ MemberListType_docEnumMembers
Definition: types.h:167
LayoutDocEntry::GroupFiles
@ GroupFiles
Definition: layout.h:64
DefinitionMixin< NamespaceDefMutable >::xrefListItems
virtual const RefItemVector & xrefListItems() const
Definition: definitionimpl.h:192
stripScope
QCString stripScope(const QCString &name)
Definition: util.cpp:3815
LayoutDocEntry::NamespaceInlineClasses
@ NamespaceInlineClasses
Definition: layout.h:54
NamespaceDef
An abstract interface of a namespace symbol.
Definition: namespacedef.h:54
MemberType_EnumValue
@ MemberType_EnumValue
Definition: types.h:281
LayoutDocEntry::MemberDef
@ MemberDef
Definition: layout.h:38
LayoutDocEntry::FileClasses
@ FileClasses
Definition: layout.h:57
CodeSymbolType::Namespace
@ Namespace
ClassLinkedRefMap::writeDeclaration
void writeDeclaration(OutputList &ol, const ClassDef::CompoundType *filter, const QCString &header, bool localNames) const
Definition: classlist.cpp:53
OutputList::docify
void docify(const QCString &s)
Definition: outputlist.h:137
LayoutDocEntry::ConceptDefinition
@ ConceptDefinition
Definition: layout.h:49
DefinitionMixin< NamespaceDefMutable >::writeDocAnchorsToTagFile
virtual void writeDocAnchorsToTagFile(TextStream &fs) const
Definition: definitionimpl.h:268
NamespaceDefImpl::endMemberDeclarations
void endMemberDeclarations(OutputList &ol)
Definition: namespacedef.cpp:742
NamespaceDefImpl::endMemberDocumentation
void endMemberDocumentation(OutputList &ol)
Definition: namespacedef.cpp:756
NamespaceDefImpl::interfaces
ClassLinkedRefMap interfaces
Definition: namespacedef.cpp:151
MemberLists::get
const std::unique_ptr< MemberList > & get(MemberListType lt, MemberListContainer con)
Definition: memberlist.h:142
QCString::findRev
int findRev(char c, int index=-1, bool cs=TRUE) const
Definition: qcstring.cpp:86
MemberName::push_back
void push_back(Ptr &&p)
Definition: membername.h:68
NamespaceDefImpl::isModule
virtual bool isModule() const
Definition: namespacedef.cpp:86
DefinitionMixin< NamespaceDefMutable >::docFile
virtual QCString docFile() const
Definition: definitionimpl.h:164
NamespaceDefImpl::addUsingDirective
virtual void addUsingDirective(const NamespaceDef *nd)
Definition: namespacedef.cpp:1174
QCString::isEmpty
bool isEmpty() const
Returns TRUE iff the string is empty
Definition: qcstring.h:144
MemberListType_allMembersList
@ MemberListType_allMembersList
Definition: types.h:147
Translator::trPackage
virtual QCString trPackage(const QCString &name)=0
NamespaceDefImpl::writeClassDeclarations
void writeClassDeclarations(OutputList &ol, const QCString &title, const ClassLinkedRefMap &d)
Definition: namespacedef.cpp:765
OutputList::writeLabel
void writeLabel(const QCString &l, bool isLast)
Definition: outputlist.h:474
NamespaceDefImpl::title
virtual QCString title() const
Definition: namespacedef.cpp:1472
NamespaceDefImpl::writeClassesToTagFile
void writeClassesToTagFile(TextStream &, const ClassLinkedRefMap &d)
Definition: namespacedef.cpp:900
OutputList::startMemberSections
void startMemberSections()
Definition: outputlist.h:177
OutputList::writeString
void writeString(const QCString &text)
Definition: outputlist.h:111
LayoutDocEntryMemberDef::title
QCString title(SrcLangExt lang) const
Definition: layout.cpp:1680
MemberVector::sort
void sort()
Definition: memberlist.h:58
LayoutDocEntry::ClassInheritanceGraph
@ ClassInheritanceGraph
Definition: layout.h:44
DefinitionMixin< NamespaceDefMutable >::getDefLine
virtual int getDefLine() const
Definition: definitionimpl.h:174
ClassDef::Interface
@ Interface
Definition: classdef.h:110
NamespaceDefImpl::m_usingDirList
LinkedRefMap< const NamespaceDef > m_usingDirList
Definition: namespacedef.cpp:143
CodeSymbolType::Package
@ Package
MemberVector::push_back
void push_back(const MemberDef *md)
Definition: memberlist.h:42
DefinitionMixin< NamespaceDefMutable >::id
virtual QCString id() const
Definition: definitionimpl.h:200
SrcLangExt
SrcLangExt
Language as given by extension
Definition: types.h:41
LayoutDocEntry::MemberDeclStart
@ MemberDeclStart
Definition: layout.h:37
NamespaceDefImpl::files
FileList files
Definition: namespacedef.cpp:141
LinkedMap::add
T * add(const char *k, Args &&... args)
Adds a new object to the ordered vector if it was not added already.
Definition: linkedmap.h:103
MemberListType_docSequenceMembers
@ MemberListType_docSequenceMembers
Definition: types.h:191
ClassLinkedRefMap::writeDocumentation
void writeDocumentation(OutputList &ol, const Definition *container=0) const
Definition: classlist.cpp:74
Doxygen::globalScope
static NamespaceDefMutable * globalScope
Definition: doxygen.h:102
NamespaceDefImpl::writeNamespaceDeclarations
void writeNamespaceDeclarations(OutputList &ol, const QCString &title, bool isConstantGroup=false)
Definition: namespacedef.cpp:780
NamespaceDefImpl::structs
ClassLinkedRefMap structs
Definition: namespacedef.cpp:152
MemberType_Enumeration
@ MemberType_Enumeration
Definition: types.h:280
DefinitionMixin< NamespaceDefMutable >::getOuterScope
virtual Definition * getOuterScope() const
Definition: definitionimpl.h:194
NamespaceDefImpl::isLinkableInProject
virtual bool isLinkableInProject() const
Definition: namespacedef.cpp:1444
toConceptDef
ConceptDef * toConceptDef(Definition *d)
Definition: conceptdef.cpp:676
MemberType_Typedef
@ MemberType_Typedef
Definition: types.h:279
Definition::isHidden
virtual bool isHidden() const =0
NamespaceDefImpl::insertNamespace
virtual void insertNamespace(const NamespaceDef *nd)
Definition: namespacedef.cpp:394
LayoutDocEntry::NamespaceClasses
@ NamespaceClasses
Definition: layout.h:53
MemberListType_docDefineMembers
@ MemberListType_docDefineMembers
Definition: types.h:164
LayoutDocEntry::GroupClasses
@ GroupClasses
Definition: layout.h:63
DefinitionMixin< NamespaceDefMutable >::getLanguage
virtual SrcLangExt getLanguage() const
Definition: definitionimpl.h:189
MemberDefMutable::setSectionList
virtual void setSectionList(const Definition *container, const MemberList *sl)=0
MemberListType_decDictionaryMembers
@ MemberListType_decDictionaryMembers
Definition: types.h:192
NamespaceDefImpl::m_memberGroups
MemberGroupList m_memberGroups
Definition: namespacedef.cpp:149
err
void err(const char *fmt,...)
Definition: message.cpp:203
SrcLangExt_Java
@ SrcLangExt_Java
Definition: types.h:45
OutputList::endLabels
void endLabels()
Definition: outputlist.h:476
QCString::at
char & at(size_t i)
Returns a reference to the character at index i.
Definition: qcstring.h:477
DefinitionMixin< NamespaceDefMutable >::name
virtual QCString name() const
Definition: definitionimpl.h:155
NamespaceDefImpl::writeMemberDeclarations
void writeMemberDeclarations(OutputList &ol, MemberListType lt, const QCString &title)
Definition: namespacedef.cpp:1431
DefinitionMixin< NamespaceDefMutable >::getDefFileName
virtual QCString getDefFileName() const
Definition: definitionimpl.h:172
NamespaceDefImpl::m_isPublished
bool m_isPublished
Definition: namespacedef.cpp:158
LayoutDocEntry::ClassIncludes
@ ClassIncludes
Definition: layout.h:43
LayoutDocEntry::FileNamespaces
@ FileNamespaces
Definition: layout.h:57
LayoutDocEntryMemberDef::type
MemberListType type
Definition: layout.h:116
MemberDefMutable
Definition: memberdef.h:296
LayoutDocEntry::FileConcepts
@ FileConcepts
Definition: layout.h:57
DefinitionMixin< NamespaceDefMutable >::briefLine
virtual int briefLine() const
Definition: definitionimpl.h:167
OutputList::endTypewriter
void endTypewriter()
Definition: outputlist.h:167
NamespaceDefImpl::writeBriefDescription
void writeBriefDescription(OutputList &ol)
Definition: namespacedef.cpp:677
NamespaceDefImpl::writeMemberPages
virtual void writeMemberPages(OutputList &ol)
Definition: namespacedef.cpp:1098
endFileWithNavPath
void endFileWithNavPath(const Definition *d, OutputList &ol)
Definition: index.cpp:274
LayoutDocEntry::MemberDefEnd
@ MemberDefEnd
Definition: layout.h:38
LayoutDocEntry::DirSubDirs
@ DirSubDirs
Definition: layout.h:68
DefinitionMixin< NamespaceDefMutable >::hasBriefDescription
virtual bool hasBriefDescription() const
Definition: definitionimpl.h:199
OutputList::writeDoc
void writeDoc(DocRoot *root, const Definition *ctx, const MemberDef *md, int id=0)
Definition: outputlist.cpp:169
NamespaceDefImpl::displayName
virtual QCString displayName(bool=TRUE) const
Definition: namespacedef.cpp:1236
MemberList::declVisible
bool declVisible() const
Definition: memberlist.cpp:279
NamespaceDefImpl::addMemberToList
void addMemberToList(MemberListType lt, MemberDef *md)
Definition: namespacedef.cpp:1371
NamespaceDefImpl::isLibrary
virtual bool isLibrary() const
Definition: namespacedef.cpp:87
MemberListContainer::Namespace
@ Namespace
LayoutDocEntry::NamespaceNestedConstantGroups
@ NamespaceNestedConstantGroups
Definition: layout.h:52
OutputList::startTypewriter
void startTypewriter()
Definition: outputlist.h:165
LayoutDocEntry::GroupInlineClasses
@ GroupInlineClasses
Definition: layout.h:63
OutputList::writeSummaryLink
void writeSummaryLink(const QCString &file, const QCString &anchor, const QCString &title, bool first)
Definition: outputlist.h:359
OutputList::endTextBlock
void endTextBlock(bool paraBreak=FALSE)
Definition: outputlist.h:411
MemberListType_declarationLists
@ MemberListType_declarationLists
Definition: types.h:104
MemberName
Definition: membername.h:24
DefinitionMixin< NamespaceDefMutable >::isHidden
virtual bool isHidden() const
Definition: definitionimpl.h:180
OutputGenerator::RTF
@ RTF
Definition: outputgen.h:333
MemberListType_decSequenceMembers
@ MemberListType_decSequenceMembers
Definition: types.h:190
ConceptLinkedRefMap::declVisible
bool declVisible() const
Definition: conceptdef.cpp:648
LayoutDocEntry::ClassCollaborationGraph
@ ClassCollaborationGraph
Definition: layout.h:45
DefinitionMixin< NamespaceDefMutable >::qualifiedName
virtual QCString qualifiedName() const
Definition: definitionimpl.h:158
LayoutDocEntryMemberDecl::title
QCString title(SrcLangExt lang) const
Definition: layout.cpp:1668
toNamespaceDefMutable
NamespaceDefMutable * toNamespaceDefMutable(Definition *d)
Definition: namespacedef.cpp:1579
NamespaceDefMutable::combineUsingRelations
virtual void combineUsingRelations(NamespaceDefSet &visitedNamespace)=0
LayoutDocManager::Namespace
@ Namespace
Definition: layout.h:203
NamespaceDefImpl::insertConcept
virtual void insertConcept(const ConceptDef *cd)
Definition: namespacedef.cpp:389
createMemberDefAlias
MemberDef * createMemberDefAlias(const Definition *newScope, const MemberDef *aliasMd)
Definition: memberdef.cpp:781
MemberList::listTypeAsString
static QCString listTypeAsString(MemberListType type)
Definition: memberlist.cpp:882
Definition::qualifiedName
virtual QCString qualifiedName() const =0
LayoutDocEntry::FileStructs
@ FileStructs
Definition: layout.h:57
LayoutDocEntryMemberDef
Represents of a member definition list with configurable title.
Definition: layout.h:110
OutputList::endQuickIndices
void endQuickIndices()
Definition: outputlist.h:349
addHtmlExtensionIfMissing
QCString addHtmlExtensionIfMissing(const QCString &fName)
Definition: util.cpp:5275
MemberType_Function
@ MemberType_Function
Definition: types.h:277
MemberList::writeTagFile
void writeTagFile(TextStream &)
Definition: memberlist.cpp:940
LayoutDocEntry::FileIncludes
@ FileIncludes
Definition: layout.h:58
NamespaceDefImpl::m_inline
bool m_inline
Definition: namespacedef.cpp:160
OutputGenerator::Latex
@ Latex
Definition: outputgen.h:333
DefinitionMixin< NamespaceDefMutable >::briefDescription
virtual QCString briefDescription(bool abbreviate=FALSE) const
Definition: definitionimpl.h:165
NamespaceDefImpl::isConstantGroup
virtual bool isConstantGroup() const
Definition: namespacedef.cpp:85
Definition::TypeNamespace
@ TypeNamespace
Definition: definition.h:89
MemberListType_decVarMembers
@ MemberListType_decVarMembers
Definition: types.h:154
Doxygen::functionNameLinkedMap
static MemberNameLinkedMap * functionNameLinkedMap
Definition: doxygen.h:94
OutputList::startTextBlock
void startTextBlock(bool dense=FALSE)
Definition: outputlist.h:409
OutputList::disable
void disable(OutputGenerator::OutputType o)
Definition: outputlist.cpp:100
NamespaceDefImpl::setFileName
virtual void setFileName(const QCString &fn)
Definition: namespacedef.cpp:302
MemberList::listType
MemberListType listType() const
Definition: memberlist.h:86
LayoutDocEntrySection
Definition: layout.h:84
LayoutDocEntry::MemberDeclEnd
@ MemberDeclEnd
Definition: layout.h:37
NamespaceDefImpl::hasDetailedDescription
virtual bool hasDetailedDescription() const
Definition: namespacedef.cpp:550
OutputList::writeAnchor
void writeAnchor(const QCString &fileName, const QCString &name)
Definition: outputlist.h:239
Translator::trMore
virtual QCString trMore()=0
NamespaceDefImpl::writeConcepts
void writeConcepts(OutputList &ol, const QCString &title)
Definition: namespacedef.cpp:770
Definition::TypeFile
@ TypeFile
Definition: definition.h:88
OutputList::endContents
void endContents()
Definition: outputlist.h:363
MemberList::numDocMembers
int numDocMembers() const
Definition: memberlist.h:92
LayoutDocEntry::MemberDefStart
@ MemberDefStart
Definition: layout.h:38
qstricmp
int qstricmp(const char *str1, const char *str2)
Definition: qcstring.cpp:433
LayoutDocEntry::DirFiles
@ DirFiles
Definition: layout.h:68
OutputList::lineBreak
void lineBreak(const QCString &style=QCString())
Definition: outputlist.h:300
theTranslator
Translator * theTranslator
Definition: language.cpp:156
NamespaceDefImpl::fileName
QCString fileName
Definition: namespacedef.cpp:140
Definition::name
virtual QCString name() const =0
NamespaceDefImpl::m_subGrouping
bool m_subGrouping
Definition: namespacedef.cpp:156
LayoutDocEntry::NamespaceExceptions
@ NamespaceExceptions
Definition: layout.h:53
OutputList::writeRuler
void writeRuler()
Definition: outputlist.h:237
LayoutDocEntry::FileConstantGroups
@ FileConstantGroups
Definition: layout.h:57
Definition::TypeConcept
@ TypeConcept
Definition: definition.h:95
MemberDef::getClassDef
virtual const ClassDef * getClassDef() const =0
Translator::trGeneratedAutomatically
virtual QCString trGeneratedAutomatically(const QCString &s)=0
validatingParseDoc
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)
Definition: docparser.cpp:7495
DefinitionMutable::setOuterScope
virtual void setOuterScope(Definition *d)=0
MemberListType_docFuncMembers
@ MemberListType_docFuncMembers
Definition: types.h:168
NamespaceDefImpl::CONSTANT_GROUP
@ CONSTANT_GROUP
Definition: namespacedef.cpp:157
LayoutDocEntry::GroupGraph
@ GroupGraph
Definition: layout.h:65
LayoutDocEntry::NamespaceStructs
@ NamespaceStructs
Definition: layout.h:53
OutputList::endParagraph
void endParagraph()
Definition: outputlist.h:109
startFile
void startFile(OutputList &ol, const QCString &name, const QCString &manName, const QCString &title, HighlightedItem hli, bool additionalIndices, const QCString &altSidebarName)
Definition: index.cpp:235
TRUE
#define TRUE
Definition: qcstring.h:36
NamespaceDefImpl::getOutputFileBase
virtual QCString getOutputFileBase() const
Definition: namespacedef.cpp:1185
SrcLangExt_Fortran
@ SrcLangExt_Fortran
Definition: types.h:53
LayoutDocEntry::GroupNestedGroups
@ GroupNestedGroups
Definition: layout.h:64
MemberList::writeDeclarations
void writeDeclarations(OutputList &ol, const ClassDef *cd, const NamespaceDef *nd, const FileDef *fd, const GroupDef *gd, const QCString &title, const QCString &subtitle, bool showEnumValues=FALSE, bool showInline=FALSE, const ClassDef *inheritedFrom=0, MemberListType lt=MemberListType_pubMethods) const
Writes the list of members to the output.
Definition: memberlist.cpp:526
ClassDef::Struct
@ Struct
Definition: classdef.h:108
OutputGenerator::Html
@ Html
Definition: outputgen.h:333
toClassDef
ClassDef * toClassDef(Definition *d)
Definition: classdef.cpp:4907
OutputList::enableAll
void enableAll()
Definition: outputlist.cpp:84
MemberListType_decEnumMembers
@ MemberListType_decEnumMembers
Definition: types.h:152
SrcLangExt_CSharp
@ SrcLangExt_CSharp
Definition: types.h:46
NamespaceDefImpl::LIBRARY
@ LIBRARY
Definition: namespacedef.cpp:157
LinkedRefMap::begin
iterator begin()
Definition: linkedmap.h:366
addRefItem
void addRefItem(const RefItemVector &sli, const QCString &key, const QCString &prefix, const QCString &name, const QCString &title, const QCString &args, const Definition *scope)
Definition: util.cpp:4880
DefinitionMixin< NamespaceDefMutable >::docLine
virtual int docLine() const
Definition: definitionimpl.h:163
NamespaceDefImpl::writeDetailedDescription
void writeDetailedDescription(OutputList &ol, const QCString &title)
Definition: namespacedef.cpp:633
Definition::TypeClass
@ TypeClass
Definition: definition.h:87
NamespaceDefImpl::m_allMembers
MemberLinkedRefMap m_allMembers
Definition: namespacedef.cpp:147
OutputList::startContents
void startContents()
Definition: outputlist.h:361
Definition::definitionType
virtual DefType definitionType() const =0
OutputList::startGroupHeader
void startGroupHeader(int extraLevels=0)
Definition: outputlist.h:169
MemberDefMutable::setNamespace
virtual void setNamespace(const NamespaceDef *nd)=0
Translator::trConstantGroupReference
virtual QCString trConstantGroupReference(const QCString &namespaceName)=0
NamespaceDefImpl::m_innerCompounds
LinkedRefMap< const Definition > m_innerCompounds
Definition: namespacedef.cpp:145
MemberListType_decDefineMembers
@ MemberListType_decDefineMembers
Definition: types.h:149
OutputList::endMemberSections
void endMemberSections()
Definition: outputlist.h:179
OutputList::popGeneratorState
void popGeneratorState()
Definition: outputlist.cpp:134
OutputList::startTextLink
void startTextLink(const QCString &file, const QCString &anchor)
Definition: outputlist.h:152
MemberType_Dictionary
@ MemberType_Dictionary
Definition: types.h:291
ClassDef::compoundType
virtual CompoundType compoundType() const =0
Returns the type of compound this is, i.e.
HLI_NamespaceVisible
@ HLI_NamespaceVisible
Definition: index.h:173
docFindSections
void docFindSections(const QCString &input, const Definition *d, const QCString &fileName)
Definition: docparser.cpp:7681
NamespaceDefImpl::MODULE
@ MODULE
Definition: namespacedef.cpp:157
NamespaceDefImpl::getMemberList
virtual MemberList * getMemberList(MemberListType lt) const
Definition: namespacedef.cpp:1419
MemberListType_decFuncMembers
@ MemberListType_decFuncMembers
Definition: types.h:153
DefinitionMixin< NamespaceDefMutable >::documentation
virtual QCString documentation() const
Definition: definitionimpl.h:162
Translator::trNamespace
virtual QCString trNamespace(bool first_capital, bool singular)=0
NamespaceDefImpl::m_usingDeclList
LinkedRefMap< const ClassDef > m_usingDeclList
Definition: namespacedef.cpp:144
DefinitionMixin< NamespaceDefMutable >::DefinitionMixin
DefinitionMixin(const QCString &defFileName, int defLine, int defColumn, const QCString &name, const char *b=0, const char *d=0, bool isSymbol=TRUE)
Definition: definitionimpl.h:146
QCString::mid
QCString mid(size_t index, size_t len=static_cast< size_t >(-1)) const
Definition: qcstring.h:224
RefItemVector
std::vector< RefItem * > RefItemVector
Definition: reflist.h:132
MemberList::setAnchors
void setAnchors()
Definition: memberlist.cpp:975
LayoutDocEntry::ClassAllMembersLink
@ ClassAllMembersLink
Definition: layout.h:45
NamespaceDefImpl::classes
ClassLinkedRefMap classes
Definition: namespacedef.cpp:150
Config_getBool
#define Config_getBool(name)
Definition: config.h:33
NamespaceDefImpl::startMemberDocumentation
void startMemberDocumentation(OutputList &ol)
Definition: namespacedef.cpp:747
LayoutDocEntry::GroupDirs
@ GroupDirs
Definition: layout.h:64
toNamespaceDef
NamespaceDef * toNamespaceDef(Definition *d)
Definition: namespacedef.cpp:1541
MemberList::writeDocumentation
void writeDocumentation(OutputList &ol, const QCString &scopeName, const Definition *container, const QCString &title, bool showEnumValues=FALSE, bool showInline=FALSE) const
Definition: memberlist.cpp:658
LayoutDocEntry::DetailedDesc
@ DetailedDesc
Definition: layout.h:39
MemberListType_documentationLists
@ MemberListType_documentationLists
Definition: types.h:105
NamespaceDefImpl::addUsingDeclaration
virtual void addUsingDeclaration(const ClassDef *cd)
Definition: namespacedef.cpp:1180
MemberListType_docVarMembers
@ MemberListType_docVarMembers
Definition: types.h:169
LayoutDocManager::instance
static LayoutDocManager & instance()
Returns a reference to this singleton.
Definition: layout.cpp:1574
LayoutDocEntry::FileInterfaces
@ FileInterfaces
Definition: layout.h:57
NamespaceDefImpl::addMembersToMemberGroup
virtual void addMembersToMemberGroup()
Definition: namespacedef.cpp:400
DefinitionMixin< NamespaceDefMutable >::hasDocumentation
virtual bool hasDocumentation() const
Definition: definitionimpl.h:176
NamespaceDefImpl::NAMESPACE
@ NAMESPACE
Definition: namespacedef.cpp:157
OutputList::writeSynopsis
void writeSynopsis()
Definition: outputlist.h:337
MemberListType_decTypedefMembers
@ MemberListType_decTypedefMembers
Definition: types.h:151
OutputList::parseText
void parseText(const QCString &textStr)
Definition: outputlist.cpp:179
NamespaceDefImpl::addNamespaceAttributes
void addNamespaceAttributes(OutputList &ol)
Definition: namespacedef.cpp:886
NamespaceLinkedRefMap::declVisible
bool declVisible(bool isContantGroup) const
Definition: namespacedef.cpp:1284
MemberType_Sequence
@ MemberType_Sequence
Definition: types.h:290
qPrint
const char * qPrint(const char *s)
Definition: qcstring.h:589
Translator::trModule
virtual QCString trModule(bool first_capital, bool singular)=0
SrcLangExt_IDL
@ SrcLangExt_IDL
Definition: types.h:44
LayoutDocEntry::MemberGroups
@ MemberGroups
Definition: layout.h:36
Config_getString
#define Config_getString(name)
Definition: config.h:32
LayoutDocEntry::ClassInlineClasses
@ ClassInlineClasses
Definition: layout.h:43
LinkedRefMap::end
iterator end()
Definition: linkedmap.h:367
OutputList::generateDoc
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)
Definition: outputlist.cpp:142
addGroupListToTitle
void addGroupListToTitle(OutputList &ol, const Definition *d)
Definition: util.cpp:4929
NamespaceDefImpl::metaData
QCString metaData
Definition: namespacedef.cpp:159
convertNameToFile
QCString convertNameToFile(const QCString &name, bool allowDots, bool allowUnderscore)
Definition: util.cpp:3604
err_full
void err_full(const QCString &file, int line, const char *fmt,...)
Definition: message.cpp:212
ClassLinkedRefMap::declVisible
bool declVisible(const ClassDef::CompoundType *filter=0) const
Definition: classlist.cpp:29
OutputList::pushGeneratorState
void pushGeneratorState()
Definition: outputlist.cpp:126
Translator::trModuleReference
virtual QCString trModuleReference(const QCString &namespaceName)=0
convertToXML
QCString convertToXML(const QCString &s, bool keepEntities)
Definition: util.cpp:3948
NamespaceDefMutable
Definition: namespacedef.h:106
FileDef
A model of a file symbol.
Definition: filedef.h:73
NamespaceDefImpl::insertClass
virtual void insertClass(const ClassDef *cd)
Definition: namespacedef.cpp:366
DefinitionMixin< NamespaceDefMutable >::setReference
virtual void setReference(const QCString &r)
Definition: definitionimpl.h:214
toFileDef
FileDef * toFileDef(Definition *d)
Definition: filedef.cpp:1778
MemberType_Define
@ MemberType_Define
Definition: types.h:276
LayoutDocEntry::BriefDesc
@ BriefDesc
Definition: layout.h:39
DefinitionMixin< NamespaceDefMutable >::isArtificial
virtual bool isArtificial() const
Definition: definitionimpl.h:181
LayoutDocEntry::NamespaceConcepts
@ NamespaceConcepts
Definition: layout.h:53
NamespaceDefImpl::writeMemberGroups
void writeMemberGroups(OutputList &ol)
Definition: namespacedef.cpp:786
stripExtension
QCString stripExtension(const QCString &fName)
Definition: util.cpp:5295
LayoutDocEntry::DirGraph
@ DirGraph
Definition: layout.h:68
DefinitionMixin< NamespaceDefMutable >::writeNavigationPath
virtual void writeNavigationPath(OutputList &ol) const
Definition: definitionimpl.h:258
NamespaceDefImpl::writeConceptsToTagFile
void writeConceptsToTagFile(TextStream &)
Definition: namespacedef.cpp:912
LayoutDocEntry::FileIncludeGraph
@ FileIncludeGraph
Definition: layout.h:58
LayoutDocEntry::FileIncludedByGraph
@ FileIncludedByGraph
Definition: layout.h:59
Doxygen::suppressDocWarnings
static bool suppressDocWarnings
Definition: doxygen.h:112
LayoutDocEntry::ClassUsedFiles
@ ClassUsedFiles
Definition: layout.h:46
LayoutDocEntry::FileSourceLink
@ FileSourceLink
Definition: layout.h:59
LinkedRefMap::find
const T * find(const std::string &key) const
find an object given the key.
Definition: linkedmap.h:243
LinkedRefMap< const ClassDef >::Ptr
const ClassDef * Ptr
Definition: linkedmap.h:234
ClassDef::Exception
@ Exception
Definition: classdef.h:113
LayoutDocEntry::ClassNestedClasses
@ ClassNestedClasses
Definition: layout.h:44
MemberDefMutable::setFileDef
virtual void setFileDef(const FileDef *fd)=0
createSubDirs
void createSubDirs(const Dir &d)
Definition: util.cpp:3677
Definition::localName
virtual QCString localName() const =0
LayoutDocEntry::FileExceptions
@ FileExceptions
Definition: layout.h:57
OutputList::enable
void enable(OutputGenerator::OutputType o)
Definition: outputlist.cpp:108
NamespaceLinkedRefMap::writeDeclaration
void writeDeclaration(OutputList &ol, const QCString &title, bool isConstantGroup=false, bool localName=FALSE)
Definition: namespacedef.cpp:1314
LayoutDocEntry::NamespaceInterfaces
@ NamespaceInterfaces
Definition: layout.h:53
MemberList
A list of MemberDef objects as shown in documentation sections.
Definition: memberlist.h:81
LayoutDocEntry::FileInlineClasses
@ FileInlineClasses
Definition: layout.h:60
LayoutDocEntry::GroupNamespaces
@ GroupNamespaces
Definition: layout.h:63
ClassLinkedRefMap
Definition: classlist.h:30
NamespaceDefImpl::startMemberDeclarations
void startMemberDeclarations(OutputList &ol)
Definition: namespacedef.cpp:737
LinkedRefMap::size
size_t size() const
Definition: linkedmap.h:375
MemberListType_docTypedefMembers
@ MemberListType_docTypedefMembers
Definition: types.h:166
OutputList::endTextLink
void endTextLink()
Definition: outputlist.h:154
MemberDef::memberType
virtual MemberType memberType() const =0
NamespaceDefImpl::isInline
virtual bool isInline() const
Definition: namespacedef.cpp:88
convertToHtml
QCString convertToHtml(const QCString &s, bool keepEntities)
Definition: util.cpp:4063
NamespaceDefImpl::m_type
enum NamespaceDefImpl::@2 m_type
LayoutDocEntry::MemberDecl
@ MemberDecl
Definition: layout.h:37
OutputList::startParagraph
void startParagraph(const QCString &classDef=QCString())
Definition: outputlist.h:107
NamespaceDefMutable::insertMember
virtual void insertMember(MemberDef *md)=0
LayoutDocEntry::AuthorSection
@ AuthorSection
Definition: layout.h:40
LayoutDocEntrySection::title
QCString title(SrcLangExt lang) const
Definition: layout.cpp:1661
createDocParser
std::unique_ptr< IDocParser > createDocParser()
Definition: docparser.cpp:179
FileDef::insertMember
virtual void insertMember(MemberDef *md)=0
FALSE
#define FALSE
Definition: qcstring.h:33
NamespaceDefImpl::exceptions
ClassLinkedRefMap exceptions
Definition: namespacedef.cpp:153
Translator::trAuthor
virtual QCString trAuthor(bool first_capital, bool singular)=0
makeDisplayName
static QCString makeDisplayName(const NamespaceDef *nd, bool includeScope)
Definition: namespacedef.cpp:38
SrcLangExt_Slice
@ SrcLangExt_Slice
Definition: types.h:59
OutputGenerator::Man
@ Man
Definition: outputgen.h:333
QCString
This is an alternative implementation of QCString.
Definition: qcstring.h:108