NamespaceLinkedRefMap类 参考

#include <namespacedef.h>

类 NamespaceLinkedRefMap 继承关系图:

NamespaceLinkedRefMap 的协作图:

Public 成员函数
void	writeDeclaration (OutputList &ol, const QCString &title, bool isConstantGroup=false, bool localName=FALSE)
bool	declVisible (bool isContantGroup) const
Public 成员函数 继承自 LinkedRefMap< const NamespaceDef >
const const NamespaceDef *	find (const std::string &key) const
	find an object given the key. 更多...
const const NamespaceDef *	find (const QCString &key) const
	find an object given the key. 更多...
const const NamespaceDef *	find (const char *key) const
	find an object given the key. 更多...
const NamespaceDef *	find (const char *key)
	non-const wrapper for find() const 更多...
const NamespaceDef *	find (const QCString &key)
const NamespaceDef *	find (const std::string &key)
	non-const wrapper for find() const 更多...
bool	add (const char *k, const NamespaceDef *obj)
	Adds an object reference to the ordered vector if it was not added already. 更多...
bool	add (const QCString &k, const NamespaceDef *obj)
bool	prepend (const char *k, const NamespaceDef *obj)
	Prepends an object reference to the ordered vector if it was not added already. 更多...
bool	prepend (const QCString &key, const NamespaceDef *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 NamespaceDef >
using	Ptr = const NamespaceDef *
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

详细描述

在文件 namespacedef.h 第 45 行定义.

成员函数说明

declVisible()

bool NamespaceLinkedRefMap::declVisible

(

bool

isContantGroup

)

const

在文件 namespacedef.cpp 第 1284 行定义.

{
  bool found=false;
  for (const auto &nd : *this)
  {
    if (nd->isLinkable() && nd->hasDocumentation())
    {
      SrcLangExt lang = nd->getLanguage();
      if (SrcLangExt_IDL==lang)
      {
        if (isConstantGroup == nd->isConstantGroup())
        {
          found=true;
          break;
        }
      }
      else if (!isConstantGroup) // ensure we only get extra section in IDL
      {
        if (nd->isConstantGroup())
        {
          err("Internal inconsistency: constant group but not IDL?\n");
        }
        found=true;
        break;
      }
    }
  }
  return found;
}

引用了 err() , 以及 SrcLangExt_IDL.

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

writeDeclaration()

void NamespaceLinkedRefMap::writeDeclaration	(	OutputList &	ol,
		const QCString &	title,
		bool	isConstantGroup = false,
		bool	localName = FALSE
	)

在文件 namespacedef.cpp 第 1314 行定义.

{
 
 
  if (empty()) return; // no namespaces in the list
 
  if (Config_getBool(OPTIMIZE_OUTPUT_VHDL)) return;
 
  if (!declVisible(isConstantGroup)) return;
 
  // write list of namespaces
  ol.startMemberHeader(isConstantGroup ? "constantgroups" : "namespaces");
  //bool javaOpt    = Config_getBool(OPTIMIZE_OUTPUT_JAVA);
  //bool fortranOpt = Config_getBool(OPTIMIZE_FOR_FORTRAN);
  ol.parseText(title);
  ol.endMemberHeader();
  ol.startMemberList();
  for (const auto &nd : *this)
  {
    if (nd->isLinkable() && nd->hasDocumentation())
    {
      SrcLangExt lang = nd->getLanguage();
      if (lang==SrcLangExt_IDL && (isConstantGroup != nd->isConstantGroup()))
          continue; // will be output in another pass, see layout_default.xml
      ol.startMemberDeclaration();
      ol.startMemberItem(nd->getOutputFileBase(),0);
      QCString ct = nd->compoundTypeString();
      ol.docify(ct);
      ol.docify(" ");
      ol.insertMemberAlign();
      QCString name;
      if (localName)
      {
        name = nd->localName();
      }
      else
      {
        name = nd->displayName();
      }
      ol.writeObjectLink(nd->getReference(),nd->getOutputFileBase(),QCString(),name);
      ol.endMemberItem();
      if (!nd->briefDescription().isEmpty() && Config_getBool(BRIEF_MEMBER_DESC))
      {
        ol.startMemberDescription(nd->getOutputFileBase());
        ol.generateDoc(nd->briefFile(),nd->briefLine(),nd,0,nd->briefDescription(),FALSE,FALSE,
                       QCString(),TRUE,FALSE,Config_getBool(MARKDOWN_SUPPORT));
        ol.endMemberDescription();
      }
      ol.endMemberDeclaration(QCString(),QCString());
    }
  }
  ol.endMemberList();
}

引用了 Config_getBool, declVisible(), OutputList::docify(), LinkedRefMap< const NamespaceDef >::empty(), OutputList::endMemberDeclaration(), OutputList::endMemberDescription(), OutputList::endMemberHeader(), OutputList::endMemberItem(), OutputList::endMemberList(), FALSE, OutputList::generateDoc(), OutputList::insertMemberAlign(), OutputList::parseText(), SrcLangExt_IDL, OutputList::startMemberDeclaration(), OutputList::startMemberDescription(), OutputList::startMemberHeader(), OutputList::startMemberItem(), OutputList::startMemberList(), TRUE , 以及 OutputList::writeObjectLink().

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

---

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

• src/namespacedef.h
• src/namespacedef.cpp