ClassLinkedRefMap类 参考

#include <classlist.h>

类 ClassLinkedRefMap 继承关系图:

ClassLinkedRefMap 的协作图:

Public 成员函数
bool	declVisible (const ClassDef::CompoundType *filter=0) const
void	writeDeclaration (OutputList &ol, const ClassDef::CompoundType *filter, const QCString &header, bool localNames) const
void	writeDocumentation (OutputList &ol, const Definition *container=0) const
Public 成员函数 继承自 LinkedRefMap< const ClassDef >
const const ClassDef *	find (const std::string &key) const
	find an object given the key. 更多...
const const ClassDef *	find (const QCString &key) const
	find an object given the key. 更多...
const const ClassDef *	find (const char *key) const
	find an object given the key. 更多...
const ClassDef *	find (const char *key)
	non-const wrapper for find() const 更多...
const ClassDef *	find (const QCString &key)
const ClassDef *	find (const std::string &key)
	non-const wrapper for find() const 更多...
bool	add (const char *k, const ClassDef *obj)
	Adds an object reference to the ordered vector if it was not added already. 更多...
bool	add (const QCString &k, const ClassDef *obj)
bool	prepend (const char *k, const ClassDef *obj)
	Prepends an object reference to the ordered vector if it was not added already. 更多...
bool	prepend (const QCString &key, const ClassDef *obj)
bool	del (const QCString &key)
	Removes an object from the container and deletes it. 更多...
Ptr &	operator[] (size_t pos)
const Ptr &	operator[] (size_t pos) const
iterator	begin ()
const_iterator	begin () const
iterator	end ()
const_iterator	end () const
reverse_iterator	rbegin ()
const_reverse_iterator	rbegin () const
reverse_iterator	rend ()
const_reverse_iterator	rend () const
bool	empty () const
size_t	size () const
void	clear ()

额外继承的成员函数
Public 类型 继承自 LinkedRefMap< const ClassDef >
using	Ptr = const ClassDef *
using	Vec = std::vector< Ptr >
using	iterator = typename Vec::iterator
using	const_iterator = typename Vec::const_iterator
using	reverse_iterator = typename Vec::reverse_iterator
using	const_reverse_iterator = typename Vec::const_reverse_iterator

详细描述

在文件 classlist.h 第 30 行定义.

成员函数说明

declVisible()

bool ClassLinkedRefMap::declVisible

(

const ClassDef::CompoundType *

filter = 0

)

const

在文件 classlist.cpp 第 29 行定义.

{
  bool hideUndocClasses = Config_getBool(HIDE_UNDOC_CLASSES);
  bool extractLocalClasses = Config_getBool(EXTRACT_LOCAL_CLASSES);
  for (const auto &cd : *this)
  {
    if (!cd->isAnonymous() &&
        (filter==0 || *filter==cd->compoundType())
       )
    {
      bool isLink = cd->isLinkable();
      if (isLink ||
          (!hideUndocClasses &&
           (!cd->isLocal() || extractLocalClasses)
          )
         )
      {
        return true;
      }
    }
  }
  return false;
}

引用了 Config_getBool.

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

writeDeclaration()

void ClassLinkedRefMap::writeDeclaration	(	OutputList &	ol,
		const ClassDef::CompoundType *	filter,
		const QCString &	header,
		bool	localNames
	)		const

在文件 classlist.cpp 第 53 行定义.

{
  static bool extractPrivate = Config_getBool(EXTRACT_PRIVATE);
  bool found=FALSE;
  for (const auto &cd : *this)
  {
    //printf("  ClassLinkedRefMap::writeDeclaration for %s\n",cd->name().data());
    if (!cd->isAnonymous() &&
        !cd->isExtension() &&
        (cd->protection()!=Private || extractPrivate) &&
        (filter==0 || *filter==cd->compoundType())
       )
    {
      //printf("writeDeclarationLink()\n");
      cd->writeDeclarationLink(ol,found,header,localNames);
    }
  }
  if (found) ol.endMemberList();
}

引用了 Config_getBool, OutputList::endMemberList(), FALSE , 以及 Private.

被这些函数引用 NamespaceDefImpl::writeClassDeclarations(), FileDefImpl::writeClassDeclarations(), GroupDefImpl::writeClasses() , 以及 ClassDefImpl::writeNestedClasses().

writeDocumentation()

void ClassLinkedRefMap::writeDocumentation	(	OutputList &	ol,
		const Definition *	container = 0
	)		const

在文件 classlist.cpp 第 74 行定义.

{
  static bool fortranOpt = Config_getBool(OPTIMIZE_FOR_FORTRAN);
 
  static bool inlineGroupedClasses = Config_getBool(INLINE_GROUPED_CLASSES);
  static bool inlineSimpleClasses = Config_getBool(INLINE_SIMPLE_STRUCTS);
  if (!inlineGroupedClasses && !inlineSimpleClasses) return;
 
  bool found=FALSE;
 
  for (const auto &cd : *this)
  {
    //printf("%s:writeDocumentation() %p linkable=%d embedded=%d container=%p partOfGroups=%zu\n",
    //  cd->name().data(),cd->getOuterScope(),cd->isLinkableInProject(),cd->isEmbeddedInOuterScope(),
    //  container,cd->partOfGroups()->size());
 
    if (!cd->isAnonymous() &&
        cd->isLinkableInProject() &&
        cd->isEmbeddedInOuterScope() &&
        !cd->isAlias() &&
        (container==0 || cd->partOfGroups().empty()) // if container==0 -> show as part of the group docs, otherwise only show if not part of a group
       )
    {
      //printf("  showing class %s\n",cd->name().data());
      if (!found)
      {
        ol.writeRuler();
        ol.startGroupHeader();
        ol.parseText(fortranOpt?theTranslator->trTypeDocumentation():
            theTranslator->trClassDocumentation());
        ol.endGroupHeader();
        found=TRUE;
      }
      ClassDefMutable *cdm = toClassDefMutable(cd);
      if (cdm)
      {
        cdm->writeInlineDocumentation(ol);
      }
    }
  }
}

引用了 Config_getBool, OutputList::endGroupHeader(), FALSE, OutputList::parseText(), Definition::partOfGroups(), OutputList::startGroupHeader(), theTranslator, toClassDefMutable(), Translator::trClassDocumentation(), Translator::trTypeDocumentation(), TRUE, ClassDefMutable::writeInlineDocumentation() , 以及 OutputList::writeRuler().

被这些函数引用 NamespaceDefImpl::writeInlineClasses(), GroupDefImpl::writeInlineClasses(), FileDefImpl::writeInlineClasses() , 以及 ClassDefImpl::writeInlineClasses().

---

该类的文档由以下文件生成:

• src/classlist.h
• src/classlist.cpp