diff options
author | Martin Smith <martin.smith@digia.com> | 2015-03-20 14:19:47 +0100 |
---|---|---|
committer | Martin Smith <martin.smith@digia.com> | 2015-03-25 10:59:16 +0000 |
commit | 040e201ba2a17310ff533b25d0ef079deb2e3494 (patch) | |
tree | 259fb6fd6688aa2f8129546d685948c878992076 /src/tools/qdoc | |
parent | b1a9787f01c381f5a40000c57c1f5d13c6a44ce7 (diff) |
qdoc: Remove obsolete stuff from the qdoc manual
Remove the \service and \mainclass commands, and the ditamap stuff.
Also remove all reverences to these commands from qdoc itself.
Change-Id: I8d150acdd56d40e6a4198a021e50f5fe3f3b1194
Task-number: QTBUG-45143
Reviewed-by: Martin Smith <martin.smith@digia.com>
Diffstat (limited to 'src/tools/qdoc')
-rw-r--r-- | src/tools/qdoc/codeparser.cpp | 2 | ||||
-rw-r--r-- | src/tools/qdoc/doc/qdoc-manual-cmdindex.qdoc | 17 | ||||
-rw-r--r-- | src/tools/qdoc/doc/qdoc-manual-contextcmds.qdoc | 34 | ||||
-rw-r--r-- | src/tools/qdoc/doc/qdoc-manual-markupcmds.qdoc | 23 | ||||
-rw-r--r-- | src/tools/qdoc/doc/qdoc-manual-topiccmds.qdoc | 22 | ||||
-rw-r--r-- | src/tools/qdoc/generator.cpp | 1 | ||||
-rw-r--r-- | src/tools/qdoc/node.cpp | 5 | ||||
-rw-r--r-- | src/tools/qdoc/node.h | 4 | ||||
-rw-r--r-- | src/tools/qdoc/qdocindexfiles.cpp | 3 |
9 files changed, 7 insertions, 104 deletions
diff --git a/src/tools/qdoc/codeparser.cpp b/src/tools/qdoc/codeparser.cpp index 4f35672f82..a99a446cc2 100644 --- a/src/tools/qdoc/codeparser.cpp +++ b/src/tools/qdoc/codeparser.cpp @@ -256,7 +256,7 @@ void CodeParser::processCommonMetaCommand(const Location& location, qdb_->addToJsModule(arg.first, node); } else if (command == COMMAND_MAINCLASS) { - node->setStatus(Node::Main); + node->doc().location().warning(tr("'\\mainclass' is deprecated. Consider '\\ingroup mainclasses'")); } else if (command == COMMAND_OBSOLETE) { node->setStatus(Node::Obsolete); diff --git a/src/tools/qdoc/doc/qdoc-manual-cmdindex.qdoc b/src/tools/qdoc/doc/qdoc-manual-cmdindex.qdoc index 1a68347682..87416fcd14 100644 --- a/src/tools/qdoc/doc/qdoc-manual-cmdindex.qdoc +++ b/src/tools/qdoc/doc/qdoc-manual-cmdindex.qdoc @@ -40,7 +40,7 @@ \li \l {a-command} {\\a} \li \l {abstract-command} {\\abstract} \li \l {annotatedlist-command} {\\annotatedlist} - \li \l {b-command} {\\b} \span {class="newStuff"} + \li \l {b-command} {\\b} \li \l {b-command} {\\bold} \span {class="newStuff"} {(deprecated, use \\b)} \li \l {brief-command} {\\brief} \li \l {c-command} {\\c} @@ -52,10 +52,9 @@ \li \l {compat-command} {\\compat} \li \l {contentspage-command} {\\contentspage} \li \l {default-command} {\\default} - \li \l {ditamap-command} {\\ditamap} \span {class="newStuff"} \li \l {div-command} {\\div} \li \l {dots-command} {\\dots} - \li \l {e-command} {\\e} \span {class="newStuff"} + \li \l {e-command} {\\e} \li \l {else-command} {\\else} \li \l {endif-command} {\\endif} \li \l {enum-command} {\\enum} @@ -77,16 +76,14 @@ \li \l {inlineimage-command} {\\inlineimage} \li \l {inmodule-command} {\\inmodule} \li \l {inqmlmodule-command} {\\inqmlmodule} - \li \l {instantiates-command} {\\instantiates} \span {class="newStuff"} {(new 27/7/2012)} + \li \l {instantiates-command} {\\instantiates} \li \l {internal-command} {\\internal} \li \l {keyword-command} {\\keyword} \li \l {l-command} {\\l} \li \l {legalese-command} {\\legalese} - \li \l {li-command} {\\li} \span {class="newStuff"} + \li \l {li-command} {\\li} \li \l {list-command} {\\list} \li \l {macro-command} {\\macro} - \li \l {mainclass-command} {\\mainclass} - \li \l {mapref-command} {\\mapref} \span {class="newStuff"} \li \l {meta-command} {\\meta} \li \l {module-command} {\\module} \li \l {namespace-command} {\\namespace} @@ -113,7 +110,7 @@ \li \l {qmlattachedsignal-command} {\\qmlattachedsignal} \li \l {qmlbasictype-command} {\\qmlbasictype} \li \l {qmlclass-command} {\\qmlclass} \span {class="newStuff"} {(deprecated, use \\qmltype)} - \li \l {qmltype-command} {\\qmltype} \span {class="newStuff"} + \li \l {qmltype-command} {\\qmltype} \li \l {qmlmethod-command} {\\qmlmethod} \li \l {qmlproperty-command} {\\qmlproperty} \li \l {qmlsignal-command} {\\qmlsignal} @@ -121,7 +118,7 @@ \li \l {quotation-command} {\\quotation} \li \l {quotefile-command} {\\quotefile} \li \l {quotefromfile-command} {\\quotefromfile} - \li \l {raw-command} {\\raw} \span {class="newStuff"} {(avoid)} + \li \l {raw-command} {\\raw} \li \l {reentrant-command} {\\reentrant} \li \l {reimp-command} {\\reimp} \li \l {relates-command} {\\relates} @@ -131,7 +128,6 @@ \li \l {sectionTwo-command} {\\section2} \li \l {sectionThree-command} {\\section3} \li \l {sectionFour-command} {\\section4} - \li \l {service-command} {\\service} \li \l {since-command} {\\since} \li \l {skipline-command} {\\skipline} \li \l {skipto-command} {\\skipto} @@ -147,7 +143,6 @@ \li \l {target-command} {\\target} \li \l {threadsafe-command} {\\threadsafe} \li \l {title-command} {\\title} - \li \l {topicref-command} {\\topicref} \span {class="newStuff"} \li \l {tt-command} {\\tt} \li \l {typedef-command} {\\typedef} \li \l {uicontrol-command} {\\uicontrol} diff --git a/src/tools/qdoc/doc/qdoc-manual-contextcmds.qdoc b/src/tools/qdoc/doc/qdoc-manual-contextcmds.qdoc index 98321f9a39..77987d6d95 100644 --- a/src/tools/qdoc/doc/qdoc-manual-contextcmds.qdoc +++ b/src/tools/qdoc/doc/qdoc-manual-contextcmds.qdoc @@ -53,7 +53,6 @@ \li \l {inherits-command}{\\inherits}, \li \l {inmodule-command}{\\inmodule}, \li \l {internal-command}{\\internal}, - \li \l {mainclass-command}{\\mainclass}, \li \l {nextpage-command}{\\nextpage}, \li \l {nonreentrant-command}{\\nonreentrant}, \li \l {obsolete-command}{\\obsolete}, @@ -542,7 +541,6 @@ \reentrant \ingroup i18n \ingroup text - \mainclass QLocale is initialized with a language/country pair in its constructor and offers number-to-string and string-to-number @@ -887,38 +885,6 @@ \section1 Commands - \target mainclass-command - \section2 \\mainclass - - The \\mainclass command relates the documented class to - a group called mainclasses. - - The command must stand on its own line. - - \code - / *! - \class QWidget qwidget.h - \brief The QWidget class is the base class of - all user interface objects. - - \mainclass - - ... - * / - \endcode - - This will include the QWidget class in the \e mainclasses - group, which means, for example, that the class will appear on the - list created by calling the \l {generatelist-command} - {\\generatelist} command with the \c mainclasses argument: - - \l http://doc.qt.digia.com/4.0/mainclasses.html - - \note The Qt documentation no longer includes the \e mainclasses - page. - - See also \l {generatelist-command} {\\generatelist}. - \target ingroup-command \section2 \\ingroup diff --git a/src/tools/qdoc/doc/qdoc-manual-markupcmds.qdoc b/src/tools/qdoc/doc/qdoc-manual-markupcmds.qdoc index f341699ee8..d9b5a6f659 100644 --- a/src/tools/qdoc/doc/qdoc-manual-markupcmds.qdoc +++ b/src/tools/qdoc/doc/qdoc-manual-markupcmds.qdoc @@ -2109,7 +2109,6 @@ \ingroup tools \ingroup misc \ingroup shared - \mainclass \keyword regular expression @@ -3549,16 +3548,6 @@ * / \endcode - \section2 \c mainclasses - - The \c mainclasses argument tells QDoc to generate an alphabetical - list of the main classes. A class is marked as a main class by - including a \l {mainclass-command} {\\mainclass} command in the - \\class comment. - - \note The Qt documentation no longer includes a main classes page, - but you can generate one for your main classes if you want it. - \section2 \c overviews The \c overviews argument is used to tell QDoc to generate a list @@ -3607,18 +3596,6 @@ \ingroup qt-basic-concepts \endcode - \section2 \c service - - The \c service argument tells QDoc to generate an alphabetical - list of the services. Each service name is a link to the service's - reference documentation. - - A service is identified with the \l {service-command} {\\service} - command. - - \note This command and the \l {service-command} {\\service} - command are not used in the Qt documentation. - \target if-command \section1 \\if diff --git a/src/tools/qdoc/doc/qdoc-manual-topiccmds.qdoc b/src/tools/qdoc/doc/qdoc-manual-topiccmds.qdoc index 93cd25610d..4ebe0e6cb0 100644 --- a/src/tools/qdoc/doc/qdoc-manual-topiccmds.qdoc +++ b/src/tools/qdoc/doc/qdoc-manual-topiccmds.qdoc @@ -1054,28 +1054,6 @@ \l{QWidget::height} {height}, and \l{QWidget::size} {size}. \endquotation - \target service-command - \section1 \\service - - The \\service command tells QDoc that a class is a service class - and names the service. The command takes two arguments, the name - of the class and the name of the service. Currently, this command - is not used in the Qt documentation. - - \code - / *! - \service TimeService Time - ... - * / - class TimeService : public QCopObjectService - { - ... - } - \endcode - - See also \l {class-command} {\\class} and \l - {generatelist-command} {\\generatelist}. - \target qmlattachedproperty-command \section1 \\qmlattachedproperty diff --git a/src/tools/qdoc/generator.cpp b/src/tools/qdoc/generator.cpp index 0ecd5ed6e3..ac5a6295ae 100644 --- a/src/tools/qdoc/generator.cpp +++ b/src/tools/qdoc/generator.cpp @@ -1197,7 +1197,6 @@ void Generator::generateStatus(const Node *node, CodeMarker *marker) switch (node->status()) { case Node::Commendable: - case Node::Main: break; case Node::Preliminary: text << Atom::ParaLeft diff --git a/src/tools/qdoc/node.cpp b/src/tools/qdoc/node.cpp index b2f93cc131..7fb8f72c51 100644 --- a/src/tools/qdoc/node.cpp +++ b/src/tools/qdoc/node.cpp @@ -151,11 +151,6 @@ QString Node::fullName(const Node* relative) const { if (isDocumentNode()) return title(); - else if (isClass()) { - const ClassNode* cn = static_cast<const ClassNode*>(this); - if (!cn->serviceName().isEmpty()) - return cn->serviceName(); - } return plainFullName(relative); } diff --git a/src/tools/qdoc/node.h b/src/tools/qdoc/node.h index 7dd868c3c0..78f3d9eb6e 100644 --- a/src/tools/qdoc/node.h +++ b/src/tools/qdoc/node.h @@ -116,7 +116,6 @@ public: Deprecated, Preliminary, Commendable, - Main, Internal }; // don't reorder this enum @@ -523,8 +522,6 @@ public: const QList<RelatedClass> &ignoredBaseClasses() const { return ignoredBases_; } const QList<UsingClause>& usingClauses() const { return usingClauses_; } - QString serviceName() const { return sname; } - void setServiceName(const QString& value) { sname = value; } QmlTypeNode* qmlElement() { return qmlelement; } void setQmlElement(QmlTypeNode* qcn) { qmlelement = qcn; } virtual bool isAbstract() const Q_DECL_OVERRIDE { return abstract_; } @@ -539,7 +536,6 @@ private: QList<UsingClause> usingClauses_; bool abstract_; bool wrapper_; - QString sname; QString obsoleteLink_; QmlTypeNode* qmlelement; }; diff --git a/src/tools/qdoc/qdocindexfiles.cpp b/src/tools/qdoc/qdocindexfiles.cpp index 026c64b587..8961ff71ad 100644 --- a/src/tools/qdoc/qdocindexfiles.cpp +++ b/src/tools/qdoc/qdocindexfiles.cpp @@ -617,8 +617,6 @@ void QDocIndexFiles::readIndexSection(const QDomElement& element, node->setStatus(Node::Commendable); else if (status == "internal") node->setStatus(Node::Internal); - else if (status == "main") - node->setStatus(Node::Main); else node->setStatus(Node::Commendable); @@ -893,7 +891,6 @@ bool QDocIndexFiles::generateIndexSection(QXmlStreamWriter& writer, case Node::Internal: status = "internal"; break; - case Node::Main: default: status = "main"; break; |