qdoc: Add status information to the requisites table for types

QDoc provides various ways to document the status of an entity;
\deprecated, \preliminary, and \modulestate commands. These
commands produce a brief sentence describing the status, however,
for C++ and QML types, a logical place for this information is
also the 'requisites' table at the start of the page.

Having the status information in the table makes it more
apparent for the reader that they're looking at documentation
for a deprecated or preliminary type. For HTML generator, this
commit also adds a <span> element that allows additional
visuals via CSS (e.g. an icon) for a specific status.

Pick-to: 6.5
Fixes: QTBUG-113026
Change-Id: If38a6d51631277a0d98b2cb702acf2598b694643
Reviewed-by: Luca Di Sera <luca.disera@qt.io>

1 files changed, 8 insertions, 0 deletions

diff --git a/src/qdoc/qdoc/docbookgenerator.cpp b/src/qdoc/qdoc/docbookgenerator.cpp
index cc75cac07..648a0a43d 100644
--- a/src/qdoc/qdoc/docbookgenerator.cpp
+++ b/src/qdoc/qdoc/docbookgenerator.cpp
@@ -2825,6 +2825,10 @@ void DocBookGenerator::generateRequisites(const Aggregate *aggregate)
         generateEndRequisite();
     }
 
+    // Status.
+    if (auto status = formatStatus(aggregate, m_qdb); status)
+        generateRequisite("Status", status.value());
+
     // Write the elements as a list if not empty.
     delete m_writer;
     m_writer = oldWriter;
@@ -2928,6 +2932,10 @@ void DocBookGenerator::generateQmlRequisites(const QmlTypeNode *qcn)
         generateEndRequisite();
     }
 
+    // Status.
+    if (auto status = formatStatus(qcn, m_qdb); status)
+        generateRequisite("Status:", status.value());
+
     m_writer->writeEndElement(); // variablelist
     newLine();
 }