summaryrefslogtreecommitdiffstats
path: root/src/tools/qdoc/node.cpp
diff options
context:
space:
mode:
authorMartin Smith <martin.smith@digia.com>2015-01-23 12:40:41 +0100
committerMartin Smith <martin.smith@digia.com>2015-02-03 11:52:06 +0000
commit7708c4b85465c08e6ba45a6485288f9459db6bb3 (patch)
treec02d4aea70d2a3d42f4fa5665c0c4440caf0d42c /src/tools/qdoc/node.cpp
parentc5db8fc74a9d437a4e7c0af077aed7c1f1bd4e26 (diff)
qdoc: Change uses of module and qmlModule
The uses of moduleName and qmlModuleName are changed to physicalModuleName and logicalModuleName respectively. A few other names are also changed in the same way. These changes are being done both to support documentation of javascript but also to emphasize that moduleName is really the name of the physical library module the entity is part of, and qmlModuleName is really the name of a collection of logical entities that is versionable and that may contain entities located in different physical modules. Change-Id: If49392aabf5950dc7b97c84f8134e9369e76dd1b Task-number: QTBUG-43715 Reviewed-by: Martin Smith <martin.smith@digia.com>
Diffstat (limited to 'src/tools/qdoc/node.cpp')
-rw-r--r--src/tools/qdoc/node.cpp58
1 files changed, 29 insertions, 29 deletions
diff --git a/src/tools/qdoc/node.cpp b/src/tools/qdoc/node.cpp
index 1bc1ebe92c..d9905baac3 100644
--- a/src/tools/qdoc/node.cpp
+++ b/src/tools/qdoc/node.cpp
@@ -1292,10 +1292,10 @@ void InnerNode::removeChild(Node *child)
been defined in the header file with a QT_MODULE macro or with an
\inmodule command in the documentation.
*/
-QString Node::moduleName() const
+QString Node::physicalModuleName() const
{
- if (!moduleName_.isEmpty())
- return moduleName_;
+ if (!physicalModuleName_.isEmpty())
+ return physicalModuleName_;
QString path = location().filePath();
QString pattern = QString("src") + QDir::separator();
@@ -1310,27 +1310,27 @@ QString Node::moduleName() const
if (finish == -1)
return QString();
- QString moduleName = moduleDir.left(finish);
+ QString physicalModuleName = moduleDir.left(finish);
- if (moduleName == "corelib")
+ if (physicalModuleName == "corelib")
return "QtCore";
- else if (moduleName == "uitools")
+ else if (physicalModuleName == "uitools")
return "QtUiTools";
- else if (moduleName == "gui")
+ else if (physicalModuleName == "gui")
return "QtGui";
- else if (moduleName == "network")
+ else if (physicalModuleName == "network")
return "QtNetwork";
- else if (moduleName == "opengl")
+ else if (physicalModuleName == "opengl")
return "QtOpenGL";
- else if (moduleName == "svg")
+ else if (physicalModuleName == "svg")
return "QtSvg";
- else if (moduleName == "sql")
+ else if (physicalModuleName == "sql")
return "QtSql";
- else if (moduleName == "qtestlib")
+ else if (physicalModuleName == "qtestlib")
return "QtTest";
else if (moduleDir.contains("webkit"))
return "QtWebKit";
- else if (moduleName == "xml")
+ else if (physicalModuleName == "xml")
return "QtXml";
else
return QString();
@@ -2146,7 +2146,7 @@ QmlTypeNode::QmlTypeNode(InnerNode *parent, const QString& name)
cnodeRequired_(false),
wrapper_(false),
cnode_(0),
- qmlModule_(0),
+ logicalModule_(0),
qmlBaseNode_(0)
{
int i = 0;
@@ -2209,14 +2209,14 @@ void QmlTypeNode::subclasses(const QString& base, NodeList& subs)
void QmlModuleNode::setQmlModuleInfo(const QString& arg)
{
QStringList blankSplit = arg.split(QLatin1Char(' '));
- qmlModuleName_ = blankSplit[0];
+ logicalModuleName_ = blankSplit[0];
if (blankSplit.size() > 1) {
QStringList dotSplit = blankSplit[1].split(QLatin1Char('.'));
- qmlModuleVersionMajor_ = dotSplit[0];
+ logicalModuleVersionMajor_ = dotSplit[0];
if (dotSplit.size() > 1)
- qmlModuleVersionMinor_ = dotSplit[1];
+ logicalModuleVersionMinor_ = dotSplit[1];
else
- qmlModuleVersionMinor_ = "0";
+ logicalModuleVersionMinor_ = "0";
}
}
@@ -2237,7 +2237,7 @@ QString QmlTypeNode::qmlFullBaseName() const
{
QString result;
if (qmlBaseNode_) {
- result = qmlBaseNode_->qmlModuleName() + "::" + qmlBaseNode_->name();
+ result = qmlBaseNode_->logicalModuleName() + "::" + qmlBaseNode_->name();
}
return result;
}
@@ -2247,9 +2247,9 @@ QString QmlTypeNode::qmlFullBaseName() const
module name from the QML module node. Otherwise, return the
empty string.
*/
-QString QmlTypeNode::qmlModuleName() const
+QString QmlTypeNode::logicalModuleName() const
{
- return (qmlModule_ ? qmlModule_->qmlModuleName() : QString());
+ return (logicalModule_ ? logicalModule_->logicalModuleName() : QString());
}
/*!
@@ -2257,9 +2257,9 @@ QString QmlTypeNode::qmlModuleName() const
module version from the QML module node. Otherwise, return
the empty string.
*/
-QString QmlTypeNode::qmlModuleVersion() const
+QString QmlTypeNode::logicalModuleVersion() const
{
- return (qmlModule_ ? qmlModule_->qmlModuleVersion() : QString());
+ return (logicalModule_ ? logicalModule_->logicalModuleVersion() : QString());
}
/*!
@@ -2267,9 +2267,9 @@ QString QmlTypeNode::qmlModuleVersion() const
module identifier from the QML module node. Otherwise, return
the empty string.
*/
-QString QmlTypeNode::qmlModuleIdentifier() const
+QString QmlTypeNode::logicalModuleIdentifier() const
{
- return (qmlModule_ ? qmlModule_->qmlModuleIdentifier() : QString());
+ return (logicalModule_ ? logicalModule_->logicalModuleIdentifier() : QString());
}
/*!
@@ -2358,13 +2358,13 @@ bool QmlPropertyNode::isWritable()
location().warning(tr("No Q_PROPERTY for QML property %1::%2::%3 "
"in C++ class documented as QML type: "
"(property not found in the C++ class or its base classes)")
- .arg(qmlModuleName()).arg(qmlTypeName()).arg(name()));
+ .arg(logicalModuleName()).arg(qmlTypeName()).arg(name()));
}
else
location().warning(tr("No Q_PROPERTY for QML property %1::%2::%3 "
"in C++ class documented as QML type: "
"(C++ class not specified or not found).")
- .arg(qmlModuleName()).arg(qmlTypeName()).arg(name()));
+ .arg(logicalModuleName()).arg(qmlTypeName()).arg(name()));
}
}
return true;
@@ -2443,8 +2443,8 @@ QString Node::fullDocumentName() const
if (!n->name().isEmpty() && !n->isQmlPropertyGroup())
pieces.insert(0, n->name());
- if (n->isQmlType() && !n->qmlModuleName().isEmpty()) {
- pieces.insert(0, n->qmlModuleName());
+ if (n->isQmlType() && !n->logicalModuleName().isEmpty()) {
+ pieces.insert(0, n->logicalModuleName());
break;
}