feat: add HIDE_INLINE_NAMESPACES config option

doxygen · May 22, 2023 · fea7b7f · fea7b7f
1 parent c57b8f1
commit fea7b7f
Show file tree

Hide file tree

Showing 6 changed files with 28 additions and 8 deletions.
diff --git a/src/classdef.cpp b/src/classdef.cpp
@@ -2379,6 +2379,7 @@ void ClassDefImpl::writeDeclarationLink(OutputList &ol,bool &found,const QCStrin
   //bool fortranOpt = Config_getBool(OPTIMIZE_FOR_FORTRAN);
   //bool vhdlOpt    = Config_getBool(OPTIMIZE_OUTPUT_VHDL);
   bool sliceOpt   = Config_getBool(OPTIMIZE_OUTPUT_SLICE);
+  bool hideInlineNamespaces = Config_getBool(HIDE_INLINE_NAMESPACES);
   SrcLangExt lang = getLanguage();
   if (visibleInParentsDeclList())
   {
@@ -2431,7 +2432,7 @@ void ClassDefImpl::writeDeclarationLink(OutputList &ol,bool &found,const QCStrin
     QCString cname = displayName(!localNames);
 
     Definition* outDef = getOuterScope();
-    if (outDef->definitionType() == Definition::DefType::TypeNamespace)
+    if (hideInlineNamespaces && outDef && outDef->definitionType() == Definition::DefType::TypeNamespace)
     {
       NamespaceDef* outDefReal = reinterpret_cast<NamespaceDef*>(outDef);
       if (outDefReal->isInline())

diff --git a/src/config.xml b/src/config.xml
@@ -1258,6 +1258,15 @@ Go to the <a href="commands.html">next</a> section or return to the
  Set the \c SHOW_NAMESPACES tag to \c NO to disable the generation of the
  Namespaces page. This will remove the Namespaces entry from the Quick Index
  and from the Folder Tree View (if specified).
+]]>
+      </docs>
+    </option>
+    <option type='bool' id='HIDE_INLINE_NAMESPACES' defval='1'>
+      <docs>
+<![CDATA[
+ Set the \c HIDE_INLINE_NAMESPACES tag to \c NO to show inline namespaces and
+ classes inside inline namespaces in Class, Namespace, File page, search index,
+ and from the Folder Tree View (if specified).
 ]]>
       </docs>
     </option>

diff --git a/src/definition.cpp b/src/definition.cpp
@@ -1302,7 +1302,8 @@ QCString DefinitionImpl::qualifiedName() const
   std::lock_guard<std::recursive_mutex> lock(g_qualifiedNameMutex);
   if (!m_impl->qualifiedName.isEmpty())
   {
-    if (m_impl->def->definitionType() == Definition::DefType::TypeNamespace)
+    bool hideInlineNamespaces = Config_getBool(HIDE_INLINE_NAMESPACES);
+    if (hideInlineNamespaces && m_impl->def->definitionType() == Definition::DefType::TypeNamespace)
     {
       DefinitionMutable* x = m_impl->def->toDefinitionMutable_();
       Definition* y = toDefinition(x);
@@ -1473,7 +1474,8 @@ QCString DefinitionImpl::navigationPathAsString() const
   {
     result+=(toFileDef(m_impl->def))->getDirDef()->navigationPathAsString();
   }
-  if (m_impl->def->definitionType() == Definition::DefType::TypeNamespace)
+  bool hideInlineNamespaces = Config_getBool(HIDE_INLINE_NAMESPACES);
+  if (hideInlineNamespaces && m_impl->def->definitionType() == Definition::DefType::TypeNamespace)
   {
     DefinitionMutable* x = m_impl->def->toDefinitionMutable_();
     Definition* y = toDefinition(x);
@@ -1886,7 +1888,8 @@ QCString DefinitionImpl::externalReference(const QCString &relPath) const
 const QCString &DefinitionImpl::name() const
 {
   Definition* outerDef = getOuterScope();
-  if (outerDef && outerDef->definitionType() == Definition::DefType::TypeNamespace)
+  bool hideInlineNamespaces = Config_getBool(HIDE_INLINE_NAMESPACES);
+  if (hideInlineNamespaces && outerDef && outerDef->definitionType() == Definition::DefType::TypeNamespace)
   {
     NamespaceDef* outerDefReal = reinterpret_cast<NamespaceDef*>(outerDef);
     if (outerDefReal->isInline())

diff --git a/src/index.cpp b/src/index.cpp
@@ -1756,8 +1756,8 @@ static void writeNamespaceTreeElement(const NamespaceDef *nd,FTVHelp *ftv,
     bool isDir = hasChildren || visibleMembers>0;
     if ((isLinkable) || isDir)
     {
-      // feature: skip inline namespace
-      if (nd->isModule() && nd->isInline()) return;
+      bool hideInlineNamespaces = Config_getBool(HIDE_INLINE_NAMESPACES);
+      if (hideInlineNamespaces && nd->isModule() && nd->isInline()) return;
       ftv->addContentsItem(hasChildren,nd->localName(),ref,file,QCString(),FALSE,nd->partOfGroups().empty(),nd);
 
       if (addToIndex)

diff --git a/src/namespacedef.cpp b/src/namespacedef.cpp
@@ -1360,10 +1360,16 @@ void NamespaceLinkedRefMap::writeDeclaration(OutputList &ol,const QCString &titl
   ol.parseText(title);
   ol.endMemberHeader();
   ol.startMemberList();
+  bool hideInlineNamespaces = Config_getBool(HIDE_INLINE_NAMESPACES);
   for (const auto &nd : *this)
   {
-    if (nd->isLinkable() && nd->hasDocumentation() && !nd->isInline())
+    if (nd->isLinkable() && nd->hasDocumentation())
     {
+      if (hideInlineNamespaces && nd->isInline())
+      {
+        continue;
+      }
+
       SrcLangExt lang = nd->getLanguage();
       if (lang==SrcLangExt_IDL && (isConstantGroup != nd->isConstantGroup()))
           continue; // will be output in another pass, see layout_default.xml

diff --git a/src/searchindex_js.cpp b/src/searchindex_js.cpp
@@ -242,14 +242,15 @@ static void addMemberToSearchIndex(const MemberDef *md)
 
 void createJavaScriptSearchIndex()
 {
+  bool hideInlineNamespaces = Config_getBool(HIDE_INLINE_NAMESPACES);
   // index classes
   for (const auto &cd : *Doxygen::classLinkedMap)
   {
     std::string letter = convertUTF8ToLower(getUTF8CharAt(cd->localName().str(),0));
     if (cd->isLinkable())
     {
       Definition* outerDef = cd->getOuterScope();
-      if (outerDef && outerDef->definitionType() == Definition::DefType::TypeNamespace)
+      if (hideInlineNamespaces && outerDef && outerDef->definitionType() == Definition::DefType::TypeNamespace)
       {
         NamespaceDef* outerDefReal = reinterpret_cast<NamespaceDef*>(outerDef);
         if (outerDefReal->isInline())