summaryrefslogtreecommitdiffstats
path: root/tools
diff options
context:
space:
mode:
authorMartin Smith <msmith@trolltech.com>2009-07-20 11:54:58 (GMT)
committerMartin Smith <msmith@trolltech.com>2009-07-20 11:55:23 (GMT)
commit5cc26e1fafb299a89daabb55f2aad66fa0a105c4 (patch)
tree0853e50dd301e3463c341ee7a0408169378d9057 /tools
parent9bd8df2b405ef517d2d1b209b8004aaaa4994242 (diff)
downloadQt-5cc26e1fafb299a89daabb55f2aad66fa0a105c4.zip
Qt-5cc26e1fafb299a89daabb55f2aad66fa0a105c4.tar.gz
Qt-5cc26e1fafb299a89daabb55f2aad66fa0a105c4.tar.bz2
doc: Print warning where \reimp is used where \internal should be used.
e.g. '\reimp' in myFunc() should be '\internal' because its base function is private or internal
Diffstat (limited to 'tools')
-rw-r--r--tools/qdoc3/cppcodeparser.cpp22
1 files changed, 13 insertions, 9 deletions
diff --git a/tools/qdoc3/cppcodeparser.cpp b/tools/qdoc3/cppcodeparser.cpp
index cb6caa9..dd10c1c 100644
--- a/tools/qdoc3/cppcodeparser.cpp
+++ b/tools/qdoc3/cppcodeparser.cpp
@@ -726,21 +726,25 @@ void CppCodeParser::processOtherMetaCommand(const Doc& doc,
tr("The function either doesn't exist in any base class "
"with the same signature or it exists but isn't virtual."));
}
-#if 0 // Ideally, we would enable this check to warn whenever \reimp is used
- // incorrectly, and only make the node internal if the function is a
- // reimplementation of another function in a base class.
+ /*
+ Ideally, we would enable this check to warn whenever
+ \reimp is used incorrectly, and only make the node
+ internal if the function is a reimplementation of
+ another function in a base class.
+ */
else if (from->access() == Node::Private
|| from->parent()->access() == Node::Private) {
- doc.location().warning(
- tr("Base function for '\\%1' in %2() is private or internal")
+ doc.location().warning(tr("'\\%1' in %2() should be '\\internal' because its base function is private or internal")
.arg(COMMAND_REIMP).arg(node->name()));
}
-#endif
- // Note: Setting the access to Private hides the documentation,
- // but setting the status to Internal makes the node available
- // in the XML output when the WebXMLGenerator is used.
+
#if 0
// Reimplemented functions now reported in separate sections.
+ /*
+ Note: Setting the access to Private hides the documentation,
+ but setting the status to Internal makes the node available
+ in the XML output when the WebXMLGenerator is used.
+ */
func->setAccess(Node::Private);
func->setStatus(Node::Internal);
#endif