qdoc: Refactor automatic note generation for function nodes

Function nodes may have a number of automatically generated notes
added to the documentation; as they share the same formatting,
collect them into a single virtual function in Generator, and
override it in DocBookGenerator.

Call the virtual function in Generator::generateBody() after
generating the text for the Doc instance. As we append the
notes to the body, the order in which the notes appear
may change slightly (if a function comment generates multiple
notes).

Add \note commands in the tests in preparation for a follow-up
commit that utilizes the refactored code.

Task-number: QTBUG-37355
Change-Id: Id92926e53b61e03a2d2feceda70987191b708975
Reviewed-by: Topi Reiniö <topi.reinio@qt.io>

1 files changed, 1 insertions, 3 deletions

diff --git a/src/qdoc/docbookgenerator.h b/src/qdoc/docbookgenerator.h
index 9a223f4af..5eea595f7 100644
--- a/src/qdoc/docbookgenerator.h
+++ b/src/qdoc/docbookgenerator.h
@@ -81,6 +81,7 @@ protected:
     bool generateStatus(const Node *node);
     bool generateThreadSafeness(const Node *node);
     bool generateSince(const Node *node);
+    void generateAddendum(const Node *node, Generator::Addendum type, CodeMarker *marker = nullptr) override;
     using Generator::generateBody;
     void generateBody(const Node *node);
 
@@ -133,9 +134,6 @@ private:
     void generateExampleFilePage(const Node *en, const QString &file,
                                  CodeMarker *marker = nullptr) override;
     void generateOverloadedSignal(const Node *node);
-    void generatePrivateSignalNote();
-    void generateInvokableNote(const Node *node);
-    void generateAssociatedPropertyNotes(const FunctionNode *fn);
     bool generateQmlText(const Text &text, const Node *relative, CodeMarker *marker = nullptr,
                          const QString &qmlName = QString()) override;
     void generateRequiredLinks(const Node *node);