From aea74dcaee2d6930e4d69cbda83088703b45816e Mon Sep 17 00:00:00 2001
From: Martin Smith <martin.smith@digia.com>
Date: Tue, 14 Apr 2015 11:27:59 +0200
Subject: qdoc: Properly document "private" signals
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

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ö <topi.reinio@digia.com>
---
 src/tools/qdoc/cppcodeparser.cpp | 5 +++++
 1 file changed, 5 insertions(+)

(limited to 'src/tools/qdoc/cppcodeparser.cpp')

diff --git a/src/tools/qdoc/cppcodeparser.cpp b/src/tools/qdoc/cppcodeparser.cpp
index 4fbe20b09e8..f12fb702270 100644
--- a/src/tools/qdoc/cppcodeparser.cpp
+++ b/src/tools/qdoc/cppcodeparser.cpp
@@ -1329,6 +1329,11 @@ bool CppCodeParser::matchParameter(FunctionNode *func)
     QString name;
     CodeChunk defaultValue;
 
+    if (match(Tok_QPrivateSignal)) {
+        func->setPrivateSignal();
+        return true;
+    }
+
     if (!matchDataType(&dataType, &name)) {
         return false;
     }
-- 
cgit v1.2.3