diff options
-rw-r--r-- | src/qdoc/codeparser.cpp | 10 | ||||
-rw-r--r-- | src/qdoc/cppcodeparser.cpp | 23 | ||||
-rw-r--r-- | src/qdoc/cppcodeparser.h | 1 | ||||
-rw-r--r-- | src/qdoc/doc/qdoc-manual-cmdindex.qdoc | 1 | ||||
-rw-r--r-- | src/qdoc/doc/qdoc-manual-contextcmds.qdoc | 81 | ||||
-rw-r--r-- | src/qdoc/doc/qdoc-manual-markupcmds.qdoc | 120 | ||||
-rw-r--r-- | src/qdoc/doc/qdoc-minimum-qdocconf.qdoc | 2 | ||||
-rw-r--r-- | src/qdoc/generator.cpp | 27 | ||||
-rw-r--r-- | src/qdoc/helpprojectwriter.cpp | 4 | ||||
-rw-r--r-- | src/qdoc/htmlgenerator.cpp | 112 | ||||
-rw-r--r-- | src/qdoc/htmlgenerator.h | 1 | ||||
-rw-r--r-- | src/qdoc/node.h | 1 | ||||
-rw-r--r-- | src/qdoc/qdocindexfiles.cpp | 7 | ||||
-rw-r--r-- | src/qdoc/sections.cpp | 12 | ||||
-rw-r--r-- | src/qdoc/sections.h | 2 |
15 files changed, 30 insertions, 374 deletions
diff --git a/src/qdoc/codeparser.cpp b/src/qdoc/codeparser.cpp index 0e58606f4..373fc4d40 100644 --- a/src/qdoc/codeparser.cpp +++ b/src/qdoc/codeparser.cpp @@ -40,7 +40,6 @@ QT_BEGIN_NAMESPACE -#define COMMAND_COMPAT Doc::alias(QLatin1String("compat")) #define COMMAND_DEPRECATED Doc::alias(QLatin1String("deprecated")) // ### don't document #define COMMAND_INGROUP Doc::alias(QLatin1String("ingroup")) #define COMMAND_INMODULE Doc::alias(QLatin1String("inmodule")) // ### don't document @@ -191,8 +190,7 @@ static QSet<QString> commonMetaCommands_; const QSet<QString>& CodeParser::commonMetaCommands() { if (commonMetaCommands_.isEmpty()) { - commonMetaCommands_ << COMMAND_COMPAT - << COMMAND_DEPRECATED + commonMetaCommands_ << COMMAND_DEPRECATED << COMMAND_INGROUP << COMMAND_INMODULE << COMMAND_INQMLMODULE @@ -226,11 +224,7 @@ void CodeParser::processCommonMetaCommand(const Location& location, const ArgLocPair& arg, Node* node) { - if (command == COMMAND_COMPAT) { - location.warning(tr("\\compat command used, but Qt3 compatibility is no longer supported")); - node->setStatus(Node::Compat); - } - else if (command == COMMAND_DEPRECATED) { + if (command == COMMAND_DEPRECATED) { node->setStatus(Node::Obsolete); } else if ((command == COMMAND_INGROUP) || (command == COMMAND_INPUBLICGROUP)) { diff --git a/src/qdoc/cppcodeparser.cpp b/src/qdoc/cppcodeparser.cpp index 3471e2cc1..b700823e5 100644 --- a/src/qdoc/cppcodeparser.cpp +++ b/src/qdoc/cppcodeparser.cpp @@ -823,29 +823,6 @@ bool CppCodeParser::skipTo(int target) return tok == target; } -/*! - If the current token is one of the keyword thingees that - are used in Qt, skip over it to the next token and return - true. Otherwise just return false without reading the - next token. - */ -bool CppCodeParser::matchCompat() -{ - switch (tok) { - case Tok_QT_COMPAT: - case Tok_QT_COMPAT_CONSTRUCTOR: - case Tok_QT_DEPRECATED: - case Tok_QT_MOC_COMPAT: - case Tok_QT3_SUPPORT: - case Tok_QT3_SUPPORT_CONSTRUCTOR: - case Tok_QT3_MOC_SUPPORT: - readToken(); - return true; - default: - return false; - } -} - bool CppCodeParser::matchModuleQualifier(QString& name) { bool matches = (lexeme() == QString('.')); diff --git a/src/qdoc/cppcodeparser.h b/src/qdoc/cppcodeparser.h index a1bc5079e..7ecd666cb 100644 --- a/src/qdoc/cppcodeparser.h +++ b/src/qdoc/cppcodeparser.h @@ -114,7 +114,6 @@ protected: private: bool match(int target); bool skipTo(int target); - bool matchCompat(); bool matchModuleQualifier(QString& name); bool matchTemplateAngles(CodeChunk *type = 0); bool matchDataType(CodeChunk *type, QString *var = 0, bool qProp = false); diff --git a/src/qdoc/doc/qdoc-manual-cmdindex.qdoc b/src/qdoc/doc/qdoc-manual-cmdindex.qdoc index 85f5f75d9..c9ae9eb5f 100644 --- a/src/qdoc/doc/qdoc-manual-cmdindex.qdoc +++ b/src/qdoc/doc/qdoc-manual-cmdindex.qdoc @@ -49,7 +49,6 @@ \li \l {class-command} {\\class} \li \l {code-command} {\\code} \li \l {codeline-command} {\\codeline} - \li \l {compat-command} {\\compat} \li \l {contentspage-command} {\\contentspage} \li \l {default-command} {\\default} \li \l {div-command} {\\div} diff --git a/src/qdoc/doc/qdoc-manual-contextcmds.qdoc b/src/qdoc/doc/qdoc-manual-contextcmds.qdoc index 63d502395..7c9a6fce6 100644 --- a/src/qdoc/doc/qdoc-manual-contextcmds.qdoc +++ b/src/qdoc/doc/qdoc-manual-contextcmds.qdoc @@ -47,7 +47,6 @@ \list \li \l {abstract-command} {\\abstract} - \li \l {compat-command}{\\compat}, \li \l {contentspage-command}{\\contentspage}, \li \l {indexpage-command}{\\indexpage}, \li \l {ingroup-command}{\\ingroup}, @@ -211,8 +210,7 @@ These commands are for indicating that a documented element has some special status. The element could be marked as about to be - made obsolete, or that it is provided for compatibility with an - earlier version, or is simply not to be included in the public + made obsolete, or that it is simply not to be included in the public interface. The \l {since-command}{\\since} command is for specifying the version number in which a function or class first appeared. The \l {qmlabstract-command} {\\qmlabstract} command is @@ -237,83 +235,6 @@ generated. It the abstract QML type is not marked internal, it will have a reference page in the documentation. - \target compat-command - \section1 \\compat - - The \\compat command is for indicating that a class or function is - part of the support library provided to keep old source code - working. - - The command must stand on its own line. - - Usually an equivalent function or class is provided as an - alternative. - - If the command is used in the documentation of a class, the - command expands to a warning that the referenced class is part of - the support library. The warning is located at the top of the - documentation page. - - \code - \beginqdoc - \class MyQt3SupportClass - \compat - \endqdoc - \endcode - - QDoc renders this at the top of the MyQt3SupportClass class - reference page. - - \quotation - \b {This class is part of the Qt 3 support - library.} It is provided to keep old source code - working. We strongly advise against using it in new - code. See the \l - {http://doc.qt.io/qt-4.8/porting4.html} {Porting - Guide} for more information. - \endquotation - - If the command is used when documenting a function, QDoc will - create and link to a separate page documenting Qt 3 support - members when generating the reference documentation for the - associated class. - - \code - \beginqdoc - \fn MyClass::MyQt3SupportMemberFunction - \compat - - Use MyNewFunction() instead. - \endqdoc - \endcode - - QDoc renders this in \c{myclass-qt3.html} as: - - \quotation - \raw HTML - <h1>Qt 3 Support Members for MyClass</h1> - \endraw - - \b {The following class members are part of the Qt 3 - support layer.} They are provided to help you port old code to - Qt 4. We advise against using them in new code. - - ... - - \list - \li void MyQt3SupportMemberFunction() - \li ... - \endlist - - \raw HTML - <hr /> - <h2>Member Function Documentation</h2> - <h3>void MyQt3SupportMemberFunction ()</h3> - <p>Use MyNewFunction() instead.</p> - \endraw - ... - \endquotation - \target default-command \section1 \\default diff --git a/src/qdoc/doc/qdoc-manual-markupcmds.qdoc b/src/qdoc/doc/qdoc-manual-markupcmds.qdoc index 618e5cc54..475eaa9db 100644 --- a/src/qdoc/doc/qdoc-manual-markupcmds.qdoc +++ b/src/qdoc/doc/qdoc-manual-markupcmds.qdoc @@ -3452,10 +3452,9 @@ \brief Alphabetical list of classes. - This is a list of all Qt classes. For a list of the classes - provided for compatibility with Qt3, see \l{Qt3 Support - Classes}. For classes that have been deprecated, see the - \l{Obsolete Classes} list. + This is a list of all Qt classes. For classes that + have been deprecated, see the \l{Obsolete Classes} + list. \generatelist classes Q * / @@ -3507,30 +3506,6 @@ \note Support for this argument was introduced in QDoc 5.6. - \section2 \c compatclasses - - The \c compatclasses argument generates a list in alphabetical - order of the support classes. It is normally used only to - generate the Qt3 Support Classes page this way: - - \code - / *! - \page compatclasses.html - \title Qt3 Support Classes - \ingroup classlists - - \brief Enable porting of code from Qt 3 to Qt 4. - - These are the classes that Qt provides for compatibility with Qt - 3. Most of these are provided by the Qt3Support module. - - \generatelist compatclasses - * / - \endcode - - A support class is identified in the \\class comment with the \l - {compat-command} {\\compat} command. - \section2 \c {examplefiles [regular_expression]} The \c examplefiles argument lists the files that are part of @@ -3702,95 +3677,6 @@ {\\if...\\endif} commands, but is useful when there is only two alternatives. - \code - / *! - The Qt 3 support library is provided to keep old - source code working. - - In addition to the \c Qt3Support classes, Qt 4 provides - compatibility functions when it's possible for an old - API to cohabit with the new one. - - \if !defined(QT3_SUPPORT) - \if defined(QT3_SUPPORTWARNINGS) - The compiler emits a warning when a - compatibility function is called. (This works - only with GCC 3.2+ and MSVC 7.) - \else - To use the Qt 3 support library, you need to - have the line QT += qt3support in your .pro - file (qmake automatically define the - QT3_SUPPORT symbol, turning on compatibility - function support). - - You can also define the symbol manually (for example, - if you don't want to link against the \c - Qt3Support library), or you can define \c - QT3_SUPPORT_WARNINGS instead, telling the - compiler to emit a warning when a compatibility - function is called. (This works only with GCC - 3.2+ and MSVC 7.) - \endif - \endif - * / - \endcode - - If the \c QT3_SUPPORT is defined, the comment will be rendered - like this: - - \quotation - The Qt 3 support library is provided to keep old source - code working. - - In addition to the Qt3Support classes, Qt 4 provides - compatibility functions when it's possible for an old - API to cohabit with the new one. - \endquotation - - If \c QT3_SUPPORT is not defined but \c QT3_SUPPORT_WARNINGS is - defined, the comment will be rendered like this: - - \quotation - The Qt 3 support library is provided to keep old source - code working. - - In addition to the Qt3Support classes, Qt 4 provides - compatibility functions when it's possible for an old - API to cohabit with the new one. - - The compiler emits a warning when a compatibility - function is called. (This works only with GCC 3.2+ and - MSVC 7.) - \endquotation - - If none of the symbols are defined, the comment will be - rendered as - - \quotation - The Qt 3 support library is provided to keep old - source code working. - - In addition to the \c Qt3Support classes, Qt 4 provides - compatibility functions when it's possible for an old - API to cohabit with the new one. - - To use the Qt 3 support library, you need to have the - line QT += qt3support in your .pro file (qmake - automatically define the QT3_SUPPORT symbol, turning on - compatibility function support). - - You can also define the symbol manually (e.g., if you - don't want to link against the \c Qt3Support library), - or you can define \c QT3_SUPPORT_WARNINGS instead, - telling the compiler to emit a warning when a - compatibility function is called. (This works only with - GCC 3.2+ and MSVC 7.) - \endquotation - - See also \l{if-command} {\\if}, \l{endif-command} {\\endif}, \l - {defines-variable} {defines} and \l {falsehoods-variable} - {falsehoods}. - \target include-command \section1 \\include diff --git a/src/qdoc/doc/qdoc-minimum-qdocconf.qdoc b/src/qdoc/doc/qdoc-minimum-qdocconf.qdoc index a64f5c890..0955a414d 100644 --- a/src/qdoc/doc/qdoc-minimum-qdocconf.qdoc +++ b/src/qdoc/doc/qdoc-minimum-qdocconf.qdoc @@ -52,7 +52,7 @@ find the meaning. include(compat.qdocconf) \endcode -For compatibility with older versions of Qt, it is recommended +For compatibility with older versions of QDoc, it is recommended to include compat.qdocconf. \code diff --git a/src/qdoc/generator.cpp b/src/qdoc/generator.cpp index b9292dbbb..b50bba612 100644 --- a/src/qdoc/generator.cpp +++ b/src/qdoc/generator.cpp @@ -668,21 +668,10 @@ QString Generator::fullDocumentLocation(const Node *node, bool useSubdir) break; } - // Various objects can be compat (deprecated) or obsolete. - // Is this even correct? if (!node->isClass() && !node->isNamespace()) { - switch (node->status()) { - case Node::Compat: - parentName.replace(QLatin1Char('.') + currentGenerator()->fileExtension(), - "-compat." + currentGenerator()->fileExtension()); - break; - case Node::Obsolete: + if (node->status() == Node::Obsolete) parentName.replace(QLatin1Char('.') + currentGenerator()->fileExtension(), "-obsolete." + currentGenerator()->fileExtension()); - break; - default: - ; - } } return fdl + parentName.toLower() + anchorRef; @@ -1389,20 +1378,6 @@ void Generator::generateStatus(const Node *node, CodeMarker *marker) << "We strongly advise against " << "using it in new code." << Atom::ParaRight; break; - case Node::Compat: - // reimplemented in HtmlGenerator subclass - if (node->isAggregate()) { - text << Atom::ParaLeft - << Atom(Atom::FormattingLeft, ATOM_FORMATTING_BOLD) - << "This " - << typeString(node) - << " is part of the Qt compatibility layer." - << Atom(Atom::FormattingRight, ATOM_FORMATTING_BOLD) - << " It is provided to keep old source code working. " - << "We strongly advise against using it in new code." - << Atom::ParaRight; - } - break; case Node::Internal: default: break; diff --git a/src/qdoc/helpprojectwriter.cpp b/src/qdoc/helpprojectwriter.cpp index 3ab92b641..672469fbb 100644 --- a/src/qdoc/helpprojectwriter.cpp +++ b/src/qdoc/helpprojectwriter.cpp @@ -571,10 +571,6 @@ void HelpProjectWriter::addMembers(HelpProject &project, QXmlStreamWriter &write QString membersPath = href + QStringLiteral("-members.html"); writeSection(writer, membersPath, tr("List of all members")); } - if (project.memberStatus[node].contains(Node::Compat)) { - QString compatPath = href + QStringLiteral("-compat.html"); - writeSection(writer, compatPath, tr("Compatibility members")); - } if (project.memberStatus[node].contains(Node::Obsolete)) { QString obsoletePath = href + QStringLiteral("-obsolete.html"); writeSection(writer, obsoletePath, tr("Obsolete members")); diff --git a/src/qdoc/htmlgenerator.cpp b/src/qdoc/htmlgenerator.cpp index e477b5789..0b6961b2f 100644 --- a/src/qdoc/htmlgenerator.cpp +++ b/src/qdoc/htmlgenerator.cpp @@ -1460,13 +1460,6 @@ void HtmlGenerator::generateCppReferencePage(Node* node, CodeMarker* marker) << "Obsolete members</a></li>\n"; } - QString compatLink = generateLowStatusMemberFile(aggregate, - marker, - Sections::Compat); - if (!compatLink.isEmpty()) - out() << "<li><a href=\"" << compatLink << "\">" - << "Compatibility members</a></li>\n"; - out() << "</ul>\n"; generateThreadSafeness(aggregate, marker); @@ -1789,13 +1782,6 @@ void HtmlGenerator::generateDocumentNode(DocumentNode* dn, CodeMarker* marker) << "Obsolete members</a></li>\n"; } - QString compatLink = generateLowStatusMemberFile(dn, - marker, - Sections::Compat); - if (!compatLink.isEmpty()) - out() << "<li><a href=\"" << compatLink << "\">" - << "Compatibility members</a></li>\n"; - out() << "</ul>\n"; } @@ -2727,14 +2713,8 @@ QString HtmlGenerator::generateLowStatusMemberFile(Aggregate *aggregate, QString title; QString fileName; - if (status == Sections::Compat) { - title = "Compatibility Members for " + aggregate->name(); - fileName = fileBase(aggregate) + "-compat." + fileExtension(); - } - else { - title = "Obsolete Members for " + aggregate->name(); - fileName = fileBase(aggregate) + "-obsolete." + fileExtension(); - } + title = "Obsolete Members for " + aggregate->name(); + fileName = fileBase(aggregate) + "-obsolete." + fileExtension(); if (status == Sections::Obsolete) { QString link; if (useOutputSubdirs() && !Generator::outputSubdir().isEmpty()) @@ -2748,22 +2728,12 @@ QString HtmlGenerator::generateLowStatusMemberFile(Aggregate *aggregate, generateSidebar(); generateTitle(title, Text(), SmallSubTitle, aggregate, marker); - if (status == Sections::Compat) { - out() << "<p><b>The following members of class " - << "<a href=\"" << linkForNode(aggregate, 0) << "\">" - << protectEnc(aggregate->name()) << "</a>" - << " are part of the " - "Qt compatibility layer.</b> We advise against " - "using them in new code.</p>\n"; - } - else { - out() << "<p><b>The following members of class " - << "<a href=\"" << linkForNode(aggregate, 0) << "\">" - << protectEnc(aggregate->name()) << "</a>" - << " are obsolete.</b> " - << "They are provided to keep old source code working. " - << "We strongly advise against using them in new code.</p>\n"; - } + out() << "<p><b>The following members of class " + << "<a href=\"" << linkForNode(aggregate, 0) << "\">" + << protectEnc(aggregate->name()) << "</a>" + << " are obsolete.</b> " + << "They are provided to keep old source code working. " + << "We strongly advise against using them in new code.</p>\n"; for (i = 0; i < sections.size(); ++i) { out() << "<h2>" << protectEnc(sections.at(i).name_) << "</h2>\n"; @@ -3777,22 +3747,9 @@ QString HtmlGenerator::protect(const QString &string, const QString &outputEncod QString HtmlGenerator::fileBase(const Node *node) const { - QString result; - - result = Generator::fileBase(node); - - if (!node->isAggregate()) { - switch (node->status()) { - case Node::Compat: - result += QLatin1String("-compat"); - break; - case Node::Obsolete: - result += QLatin1String("-obsolete"); - break; - default: - ; - } - } + QString result = Generator::fileBase(node); + if (!node->isAggregate() && node->status() == Node::Obsolete) + result += QLatin1String("-obsolete"); return result; } @@ -4006,16 +3963,8 @@ void HtmlGenerator::generateFullName(const Node *apparentNode, const Node *relat actualNode = apparentNode; out() << "<a href=\"" << linkForNode(actualNode, relative); if (true || relative == 0 || relative->status() != actualNode->status()) { - switch (actualNode->status()) { - case Node::Obsolete: + if (actualNode->status() == Node::Obsolete) out() << "\" class=\"obsolete"; - break; - case Node::Compat: - out() << "\" class=\"compat"; - break; - default: - ; - } } out() << "\">"; out() << protectEnc(apparentNode->fullName(relative)); @@ -4169,23 +4118,6 @@ const QPair<QString,QString> HtmlGenerator::anchorForNode(const Node *node) return anchorPair; } -void HtmlGenerator::generateStatus(const Node *node, CodeMarker *marker) -{ - Text text; - - switch (node->status()) { - case Node::Obsolete: - if (node->isAggregate()) - Generator::generateStatus(node, marker); - break; - case Node::Compat: - // Porting to Qt 4 no longer supported - break; - default: - Generator::generateStatus(node, marker); - } -} - #ifdef GENERATE_MAC_REFS /* No longer valid. @@ -4208,22 +4140,12 @@ void HtmlGenerator::beginLink(const QString &link, const Node *node, const Node if (showBrokenLinks) out() << "<i>"; } - else if (node == 0 || - (relative != 0 && node->status() == relative->status())) { + else if (node == 0 || (relative != 0 && node->status() == relative->status())) + out() << "<a href=\"" << link_ << "\">"; + else if (node->status() == Node::Obsolete) + out() << "<a href=\"" << link_ << "\" class=\"obsolete\">"; + else out() << "<a href=\"" << link_ << "\">"; - } - else { - switch (node->status()) { - case Node::Obsolete: - out() << "<a href=\"" << link_ << "\" class=\"obsolete\">"; - break; - case Node::Compat: - out() << "<a href=\"" << link_ << "\" class=\"compat\">"; - break; - default: - out() << "<a href=\"" << link_ << "\">"; - } - } inLink_ = true; } diff --git a/src/qdoc/htmlgenerator.h b/src/qdoc/htmlgenerator.h index df949261e..fdd7986b9 100644 --- a/src/qdoc/htmlgenerator.h +++ b/src/qdoc/htmlgenerator.h @@ -209,7 +209,6 @@ private: const Aggregate *relative, CodeMarker *marker); void generateLink(const Atom *atom, CodeMarker *marker); - void generateStatus(const Node *node, CodeMarker *marker); inline bool hasBrief(const Node *node); QString registerRef(const QString& ref); diff --git a/src/qdoc/node.h b/src/qdoc/node.h index a5ae1d3a9..47c447d36 100644 --- a/src/qdoc/node.h +++ b/src/qdoc/node.h @@ -110,7 +110,6 @@ public: enum Access { Public, Protected, Private }; enum Status { - Compat, Obsolete, Deprecated, Preliminary, diff --git a/src/qdoc/qdocindexfiles.cpp b/src/qdoc/qdocindexfiles.cpp index 42c2cbc1d..b5d10485f 100644 --- a/src/qdoc/qdocindexfiles.cpp +++ b/src/qdoc/qdocindexfiles.cpp @@ -599,9 +599,7 @@ void QDocIndexFiles::readIndexSection(QXmlStreamReader& reader, node->setThreadSafeness(Node::UnspecifiedSafeness); QString status = attributes.value(QLatin1String("status")).toString(); - if (status == QLatin1String("compat")) - node->setStatus(Node::Compat); - else if (status == QLatin1String("obsolete")) + if (status == QLatin1String("obsolete")) node->setStatus(Node::Obsolete); else if (status == QLatin1String("deprecated")) node->setStatus(Node::Obsolete); @@ -921,9 +919,6 @@ bool QDocIndexFiles::generateIndexSection(QXmlStreamWriter& writer, QString status; switch (node->status()) { - case Node::Compat: - status = "compat"; - break; case Node::Obsolete: status = "obsolete"; break; diff --git a/src/qdoc/sections.cpp b/src/qdoc/sections.cpp index c91ae72ef..a38c3f7d5 100644 --- a/src/qdoc/sections.cpp +++ b/src/qdoc/sections.cpp @@ -203,16 +203,10 @@ void Sections::insert(FastSection &fs, Node *node, Style style, Status status) } if (!irrelevant) { - if (status == Compat) { - irrelevant = (node->status() != Node::Compat); - } - else if (status == Obsolete) { + if (status == Obsolete) irrelevant = (node->status() != Node::Obsolete); - } - else { - irrelevant = (node->status() == Node::Compat || - node->status() == Node::Obsolete); - } + else + irrelevant = (node->status() == Node::Obsolete); } if (!irrelevant) { diff --git a/src/qdoc/sections.h b/src/qdoc/sections.h index fbb573173..e660f233a 100644 --- a/src/qdoc/sections.h +++ b/src/qdoc/sections.h @@ -102,7 +102,7 @@ class Sections { public: enum Style { Summary, Detailed, Subpage, Accessors }; - enum Status { Compat, Obsolete, Okay }; + enum Status { Obsolete, Okay }; Sections() { } ~Sections() { } |