ModuleLinkedRefMap Class Reference

#include <src/moduledef.h>

Inheritance diagram for ModuleLinkedRefMap:

Collaboration diagram for ModuleLinkedRefMap:

Public Member Functions
bool	declVisible () const
void	writeDeclaration (OutputList &ol, const QCString &header, bool localNames) const
Public Member Functions inherited from LinkedRefMap< ModuleDef >
const ModuleDef *	find (const std::string &key) const
	find an object given the key.
const ModuleDef *	find (const QCString &key) const
	find an object given the key.
const ModuleDef *	find (const char *key) const
	find an object given the key.
ModuleDef *	find (const char *key)
	non-const wrapper for find() const
ModuleDef *	find (const QCString &key)
ModuleDef *	find (const std::string &key)
	non-const wrapper for find() const
bool	add (const char *k, ModuleDef *obj)
	Adds an object reference to the ordered vector if it was not added already.
bool	add (const QCString &k, ModuleDef *obj)
bool	prepend (const char *k, ModuleDef *obj)
	Prepends an object reference to the ordered vector if it was not added already.
bool	prepend (const QCString &key, ModuleDef *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 ()

Additional Inherited Members
Public Types inherited from LinkedRefMap< ModuleDef >
using	Ptr
using	Vec
using	iterator
using	const_iterator
using	reverse_iterator
using	const_reverse_iterator

Detailed Description

Definition at line 99 of file moduledef.h.

Member Function Documentation

declVisible()

bool ModuleLinkedRefMap::declVisible

(

)

const

Definition at line 1145 of file moduledef.cpp.

{
  bool hideUndocClasses = Config_getBool(HIDE_UNDOC_CLASSES);
  for (const auto &mod : *this)
  {
    bool isLink = mod->isLinkable();
    if (isLink || !hideUndocClasses)
    {
      return true;
    }
  }
  return false;
}

References Config_getBool.

writeDeclaration()

void ModuleLinkedRefMap::writeDeclaration	(	OutputList &	ol,
		const QCString &	header,
		bool	localNames ) const

Definition at line 1159 of file moduledef.cpp.

{
  bool found=FALSE;
  for (const auto &mod : *this)
  {
    toModuleDefImpl(mod)->writeDeclarationLink(ol,found,header,localNames);
  }
  if (found) ol.endMemberList();
}

References OutputList::endMemberList(), FALSE, found, toModuleDefImpl(), and ModuleDefImpl::writeDeclarationLink().

---

The documentation for this class was generated from the following files:

• src/moduledef.h
• src/moduledef.cpp