summaryrefslogtreecommitdiffstats
path: root/src/tools
diff options
context:
space:
mode:
authorMartin Smith <martin.smith@digia.com>2013-03-05 14:08:26 +0100
committerThe Qt Project <gerrit-noreply@qt-project.org>2013-03-06 13:00:31 +0100
commit6d3ab0c96b4372ebde610fd59196de7d321ac14c (patch)
treecaa93917365f4f5a66ac5cc57d3c80d7290cf18a /src/tools
parent31c5b34e808db102bfc5364405711ec94fe51f0a (diff)
qdoc: Don't document QML signal handlers
qdoc now ignores QML signal handler comments and does not report errors for missing QML signal handler documentation. Task-number: QTBUG-29993 Change-Id: If2daae80944c8b85312d38d4ee8c07ebe1f79001 Reviewed-by: J-P Nurmi <jpnurmi@digia.com> Reviewed-by: Jerome Pasion <jerome.pasion@digia.com>
Diffstat (limited to 'src/tools')
-rw-r--r--src/tools/qdoc/qmlvisitor.cpp9
1 files changed, 8 insertions, 1 deletions
diff --git a/src/tools/qdoc/qmlvisitor.cpp b/src/tools/qdoc/qmlvisitor.cpp
index 058ab9a725..6d44b99af7 100644
--- a/src/tools/qdoc/qmlvisitor.cpp
+++ b/src/tools/qdoc/qmlvisitor.cpp
@@ -601,9 +601,15 @@ void QmlDocVisitor::endVisit(QQmlJS::AST::FunctionDeclaration* fd)
/*!
Begin the visit of the signal handler declaration \a sb, but only
if the nesting level is 1.
+
+ This visit is now deprecated. It has been decided to document
+ public signals. If a signal handler must be discussed in the
+ documentation, that discussion must take place in the comment
+ for the signal.
*/
-bool QmlDocVisitor::visit(QQmlJS::AST::UiScriptBinding* sb)
+bool QmlDocVisitor::visit(QQmlJS::AST::UiScriptBinding* )
{
+#if 0
if (nestingLevel > 1) {
return true;
}
@@ -617,6 +623,7 @@ bool QmlDocVisitor::visit(QQmlJS::AST::UiScriptBinding* sb)
}
}
}
+#endif
return true;
}