The ClassLinkedRefMap Class Reference

Declaration

class ClassLinkedRefMap { ... }

Included Headers

#include <src/classlist.h>

Base class

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

Public Member Functions Index

bool	declVisible (const ClassDef::CompoundType *filter=nullptr) const
void	writeDeclaration (OutputList &ol, const ClassDef::CompoundType *filter, const QCString &header, bool localNames) const
void	writeDocumentation (OutputList &ol, const Definition *container=nullptr) const

Definition at line 30 of file classlist.h.

Public Member Functions

declVisible()

bool ClassLinkedRefMap::declVisible (const ClassDef::CompoundType * filter=nullptr)

Declaration at line 33 of file classlist.h, definition at line 29 of file classlist.cpp.

29bool ClassLinkedRefMap::declVisible(const ClassDef::CompoundType *filter) const

30{

31 bool hideUndocClasses = Config_getBool(HIDE_UNDOC_CLASSES);

32 bool extractLocalClasses = Config_getBool(EXTRACT_LOCAL_CLASSES);

33 for (const auto &cd : *this)

34 {

35 if (!cd->isAnonymous() &&

36 (filter==nullptr || *filter==cd->compoundType())

37 )

38 {

39 bool isLink = cd->isLinkable();

40 if (isLink ||

41 (!hideUndocClasses &&

42 (!cd->isLocal() || extractLocalClasses)

43 )

44 )

45 {

46 return true;

47 }

48 }

49 }

50 return false;

51}

Reference Config_getBool.

writeDeclaration()

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

Declaration at line 34 of file classlist.h, definition at line 53 of file classlist.cpp.

53void ClassLinkedRefMap::writeDeclaration(OutputList &ol,const ClassDef::CompoundType *filter,

54 const QCString &header,bool localNames) const

55{

56 bool extractPrivate = Config_getBool(EXTRACT_PRIVATE);

57 bool found=FALSE;

58 for (const auto &cd : *this)

59 {

60 //printf(" ClassLinkedRefMap::writeDeclaration for %s\n",cd->name().data());

61 if (!cd->isAnonymous() &&

62 !cd->isExtension() &&

63 (cd->protection()!=Protection::Private || extractPrivate) &&

64 (filter==nullptr || *filter==cd->compoundType())

65 )

66 {

67 //printf("writeDeclarationLink()\n");

68 cd->writeDeclarationLink(ol,found,header,localNames);

69 }

70 }

71 if (found) ol.endMemberList();

72}

References Config_getBool, OutputList::endMemberList and FALSE.

Referenced by FileDefImpl::writeClassDeclarations and NamespaceDefImpl::writeClassDeclarations.

writeDocumentation()

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

Declaration at line 35 of file classlist.h, definition at line 74 of file classlist.cpp.

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

75{

76 bool fortranOpt = Config_getBool(OPTIMIZE_FOR_FORTRAN);

77

78 bool inlineGroupedClasses = Config_getBool(INLINE_GROUPED_CLASSES);

79 bool inlineSimpleClasses = Config_getBool(INLINE_SIMPLE_STRUCTS);

80 if (!inlineGroupedClasses && !inlineSimpleClasses) return;

81

82 bool found=FALSE;

83

84 for (const auto &cd : *this)

85 {

86 //printf("%s:writeDocumentation() %p linkable=%d embedded=%d container=%p partOfGroups=%zu\n",

87 // cd->name().data(),cd->getOuterScope(),cd->isLinkableInProject(),cd->isEmbeddedInOuterScope(),

88 // container,cd->partOfGroups()->size());

89

90 if (!cd->isAnonymous() &&

91 cd->isLinkableInProject() &&

92 cd->isEmbeddedInOuterScope() &&

93 !cd->isAlias() &&

94 (container==nullptr || cd->partOfGroups().empty()) // if container==nullptr -> show as part of the group docs, otherwise only show if not part of a group

95 )

96 {

97 //printf(" showing class %s\n",cd->name().data());

98 if (!found)

99 {

100 ol.writeRuler();

101 ol.startGroupHeader("inline_classes");

102 ol.parseText(fortranOpt?theTranslator->trTypeDocumentation():

103 theTranslator->trClassDocumentation());

104 ol.endGroupHeader();

105 found=TRUE;

106 }

107 cd->writeInlineDocumentation(ol);

108 }

109 }

110}

References Config_getBool, OutputList::endGroupHeader, FALSE, OutputList::parseText, Definition::partOfGroups, OutputList::startGroupHeader, theTranslator, TRUE and OutputList::writeRuler.

---

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

• classlist.cpp
• classlist.h

---

Generated via doxygen2docusaurus by Doxygen 1.14.0.