Merge branch 'albert-github-feature/issue_11755'

Author: doxygen

src/definition.cpp

@@ -1469,7 +1469,9 @@ void DefinitionImpl::writeToc(OutputList &ol, const LocalToc &localToc) const
                        docTitle,
                        DocOptions()
                        .setIndexWords(true)
-                       .setSingleLine(true));
+                       .setSingleLine(true)
+                       .setSectionLevel(si->type().level())
+                      );
         ol.endTocEntry(si);
       }
     }

src/docbookgen.cpp

@@ -726,11 +726,11 @@ DB_GEN_C
     m_pageLinks += link;
 }
 
-void DocbookGenerator::writeDoc(const IDocNodeAST *ast,const Definition *ctx,const MemberDef *,int)
+void DocbookGenerator::writeDoc(const IDocNodeAST *ast,const Definition *ctx,const MemberDef *,int,int sectionLevel)
 {
 DB_GEN_C
   auto astImpl = dynamic_cast<const DocNodeAST*>(ast);
-  if (astImpl)
+  if (astImpl && sectionLevel<=m_tocState.maxLevel)
   {
     DocbookDocVisitor visitor(m_t,*m_codeList,ctx?ctx->getDefFileExtension():QCString());
     std::visit(visitor,astImpl->root);

src/docbookgen.h

@@ -121,7 +121,7 @@ class DocbookGenerator : public OutputGenerator, public OutputGenIntf
     std::unique_ptr<OutputGenIntf> clone() override { return std::make_unique<DocbookGenerator>(*this); }
     void addCodeGen(OutputCodeList &list) override;
     void cleanup() override;
-    void writeDoc(const IDocNodeAST *node,const Definition *ctx,const MemberDef *md,int id) override;
+    void writeDoc(const IDocNodeAST *node,const Definition *ctx,const MemberDef *md,int id,int sectionLevel) override;
     void startFile(const QCString &name,bool isSource,const QCString &manName,const QCString &title,int id,int hierarchyLevel) override;
     void endFile() override;
 

src/docoptions.h

@@ -30,6 +30,7 @@ struct DocOptions
     bool linkFromIndex()     const { return m_linkFromIndex;   }
     bool markdownSupport()   const { return m_markdownSupport; }
     bool autolinkSupport()   const { return m_autolinkSupport; }
+    int sectionLevel()       const { return m_sectionLevel;    }
 
     // === setters for optional params
 
@@ -59,6 +60,10 @@ struct DocOptions
     DocOptions &setAutolinkSupport(bool b)
     { m_autolinkSupport=b; return *this; }
 
+    /// Restrict output up to the given section level
+    DocOptions &setSectionLevel(int l)
+    { m_sectionLevel=l; return *this; }
+
   private:
     // optional params with defaults
     bool m_indexWords = false;
@@ -68,6 +73,7 @@ struct DocOptions
     bool m_linkFromIndex = false;
     bool m_markdownSupport = Config_getBool(MARKDOWN_SUPPORT);
     bool m_autolinkSupport = Config_getBool(AUTOLINK_SUPPORT);
+    int  m_sectionLevel = -1;
 };
 
 #endif

src/htmlgen.cpp

@@ -2720,10 +2720,10 @@ void HtmlGenerator::endExamples()
   m_t << "</dl>\n";
 }
 
-void HtmlGenerator::writeDoc(const IDocNodeAST *ast,const Definition *ctx,const MemberDef *,int id)
+void HtmlGenerator::writeDoc(const IDocNodeAST *ast,const Definition *ctx,const MemberDef *,int id,int sectionLevel)
 {
   const DocNodeAST *astImpl = dynamic_cast<const DocNodeAST*>(ast);
-  if (astImpl)
+  if (astImpl && sectionLevel<=m_tocState.maxLevel)
   {
     m_codeList->setId(id);
     HtmlDocVisitor visitor(m_t,*m_codeList,ctx,fileName());

src/htmlgen.h

@@ -123,7 +123,7 @@ class HtmlGenerator : public OutputGenerator, public OutputGenIntf
     std::unique_ptr<OutputGenIntf> clone() override { return std::make_unique<HtmlGenerator>(*this); }
     void addCodeGen(OutputCodeList &list) override;
     void cleanup() override;
-    void writeDoc(const IDocNodeAST *node,const Definition *,const MemberDef *,int id) override;
+    void writeDoc(const IDocNodeAST *node,const Definition *,const MemberDef *,int id,int sectionLevel) override;
     void startFile(const QCString &name,bool isSource,const QCString &manName,const QCString &title,int id, int hierarchyLevel) override;
     void endFile() override;
 

src/latexgen.cpp

@@ -2138,7 +2138,7 @@ void LatexGenerator::exceptionEntry(const QCString &prefix,bool closeBracket)
   m_t << " ";
 }
 
-void LatexGenerator::writeDoc(const IDocNodeAST *ast,const Definition *ctx,const MemberDef *,int)
+void LatexGenerator::writeDoc(const IDocNodeAST *ast,const Definition *ctx,const MemberDef *,int,int)
 {
   const DocNodeAST *astImpl = dynamic_cast<const DocNodeAST*>(ast);
   if (astImpl)

src/latexgen.h

@@ -115,7 +115,7 @@ class LatexGenerator : public OutputGenerator, public OutputGenIntf
     std::unique_ptr<OutputGenIntf> clone() override { return std::make_unique<LatexGenerator>(*this); }
     void addCodeGen(OutputCodeList &list) override;
     void cleanup() override;
-    void writeDoc(const IDocNodeAST *node,const Definition *ctx,const MemberDef *,int id) override;
+    void writeDoc(const IDocNodeAST *node,const Definition *ctx,const MemberDef *,int id,int sectionLevel) override;
     void startFile(const QCString &name,bool isSource,const QCString &manName,const QCString &title,int id,int hierarchyLevel) override;
     void endFile() override;
 

src/mangen.cpp

@@ -760,7 +760,7 @@ void ManGenerator::endDescTable()
   endDescForItem();
 }
 
-void ManGenerator::writeDoc(const IDocNodeAST *ast,const Definition *ctx,const MemberDef *,int)
+void ManGenerator::writeDoc(const IDocNodeAST *ast,const Definition *ctx,const MemberDef *,int,int)
 {
   const DocNodeAST *astImpl = dynamic_cast<const DocNodeAST *>(ast);
   if (astImpl)

src/mangen.h

@@ -85,7 +85,7 @@ class ManGenerator : public OutputGenerator, public OutputGenIntf
     std::unique_ptr<OutputGenIntf> clone() override { return std::make_unique<ManGenerator>(*this); }
     void addCodeGen(OutputCodeList &list) override;
     void cleanup() override;
-    void writeDoc(const IDocNodeAST *ast,const Definition *,const MemberDef *,int) override;
+    void writeDoc(const IDocNodeAST *ast,const Definition *,const MemberDef *,int,int) override;
     void startFile(const QCString &name,bool isSource,const QCString &manName,const QCString &title,int id, int hierarchyLevel) override;
     void endFile() override;