qdoc: Properly document "private" signals

When a signal declaration is marked with QSignalPrivate,
This note is included in its documentation: "Note: This
is a private signal. It must not be emitted by the user."

For Notifier signals, [see note] is appended to the signature line,
and the Note is printed below the list.

Change-Id: Ie792894ace56cda47fd9a45af9c732f408ac45f6
Task-number: QTBUG-45535
Reviewed-by: Topi Reiniö <[email protected]>

1 files changed, 3 insertions, 0 deletions

diff --git a/src/tools/qdoc/node.h b/src/tools/qdoc/node.h
index fc9d33edc2d..85e724b9ca5 100644
--- a/src/tools/qdoc/node.h
+++ b/src/tools/qdoc/node.h
@@ -928,6 +928,8 @@ public:
     virtual QString logicalModuleIdentifier() const Q_DECL_OVERRIDE {
         return parent()->logicalModuleIdentifier();
     }
+    bool isPrivateSignal() const { return privateSignal_; }
+    void setPrivateSignal() { privateSignal_ = true; }
 
     void debug() const;
 
@@ -946,6 +948,7 @@ private:
     bool ove : 1;
     bool reimp: 1;
     bool attached_: 1;
+    bool privateSignal_: 1;
     QList<Parameter> params;
     const FunctionNode* rf;
     const PropertyNode* ap;