The NamespaceLinkedRefMap Class Reference

Declaration

class NamespaceLinkedRefMap { ... }

Included Headers

#include <src/namespacedef.h>

Base class

class	LinkedRefMap<T, Hash, KeyEqual, Map>
	Container class representing a vector of objects with keys. More...

Public Member Functions Index

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

Definition at line 45 of file namespacedef.h.

Public Member Functions

declVisible()

bool NamespaceLinkedRefMap::declVisible (bool isContantGroup)

Declaration at line 50 of file namespacedef.h, definition at line 1348 of file namespacedef.cpp.

1348bool NamespaceLinkedRefMap::declVisible(bool isConstantGroup) const

1349{

1350 bool found=false;

1351 for (const auto &nd : *this)

1352 {

1353 if (nd->isLinkable() && nd->hasDocumentation())

1354 {

1355 SrcLangExt lang = nd->getLanguage();

1356 if (SrcLangExt::IDL==lang)

1357 {

1358 if (isConstantGroup == nd->isConstantGroup())

1359 {

1360 found=true;

1361 break;

1362 }

1363 }

1364 else if (!isConstantGroup) // ensure we only get extra section in IDL

1365 {

1366 if (nd->isConstantGroup())

1367 {

1368 err("Internal inconsistency: constant group but not IDL?\n");

1369 }

1370 found=true;

1371 break;

1372 }

1373 }

1374 }

1375 return found;

1376}

Reference err.

Referenced by writeDeclaration.

writeDeclaration()

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

Declaration at line 48 of file namespacedef.h, definition at line 1378 of file namespacedef.cpp.

1378void NamespaceLinkedRefMap::writeDeclaration(OutputList &ol,const QCString &title,

1379 bool const isConstantGroup,bool localName)

1380{

1381

1382

1383 if (empty()) return; // no namespaces in the list

1384

1385 if (Config_getBool(OPTIMIZE_OUTPUT_VHDL)) return;

1386

1387 if (!declVisible(isConstantGroup)) return;

1388

1389 // write list of namespaces

1390 ol.startMemberHeader(isConstantGroup ? "constantgroups" : "namespaces");

1391 //bool javaOpt = Config_getBool(OPTIMIZE_OUTPUT_JAVA);

1392 //bool fortranOpt = Config_getBool(OPTIMIZE_FOR_FORTRAN);

1393 ol.parseText(title);

1394 ol.endMemberHeader();

1395 ol.startMemberList();

1396 for (const auto &nd : *this)

1397 {

1398 if (nd->isLinkable() && nd->hasDocumentation())

1399 {

1400 SrcLangExt lang = nd->getLanguage();

1401 if (lang==SrcLangExt::IDL && (isConstantGroup != nd->isConstantGroup()))

1402 continue; // will be output in another pass, see layout_default.xml

1403 ol.startMemberDeclaration();

1404 QCString name = localName ? nd->localName() : nd->displayName();

1405 QCString anc = nd->anchor();

1406 if (anc.isEmpty()) anc=name; else anc.prepend(name+"_");

1407 ol.startMemberItem(anc,OutputGenerator::MemberItemType::Normal);

1408 QCString ct = nd->compoundTypeString();

1409 ol.docify(ct);

1410 ol.docify(" ");

1411 ol.insertMemberAlign();

1412 ol.writeObjectLink(nd->getReference(),nd->getOutputFileBase(),QCString(),name);

1413 ol.endMemberItem(OutputGenerator::MemberItemType::Normal);

1414 if (!nd->briefDescription().isEmpty() && Config_getBool(BRIEF_MEMBER_DESC))

1415 {

1416 ol.startMemberDescription(nd->getOutputFileBase());

1417 ol.generateDoc(nd->briefFile(),nd->briefLine(),nd,nullptr,nd->briefDescription(),FALSE,FALSE,

1418 QCString(),TRUE,FALSE);

1419 ol.endMemberDescription();

1420 }

1421 ol.endMemberDeclaration(QCString(),QCString());

1422 }

1423 }

1424 ol.endMemberList();

1425}

References Config_getBool, declVisible, OutputList::docify, LinkedRefMap< const NamespaceDef >::empty, OutputList::endMemberDeclaration, OutputList::endMemberDescription, OutputList::endMemberHeader, OutputList::endMemberItem, OutputList::endMemberList, FALSE, OutputList::generateDoc, OutputList::insertMemberAlign, QCString::isEmpty, OutputGenerator::Normal, OutputList::parseText, QCString::prepend, OutputList::startMemberDeclaration, OutputList::startMemberDescription, OutputList::startMemberHeader, OutputList::startMemberItem, OutputList::startMemberList, TRUE and OutputList::writeObjectLink.

---

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

• namespacedef.cpp
• namespacedef.h

---

Generated via doxygen2docusaurus by Doxygen 1.14.0.