From 46959875cf7ddeb9bbcee883e4bfaef63992b870 Mon Sep 17 00:00:00 2001 From: Martin Smith Date: Fri, 23 May 2014 13:26:36 +0200 Subject: qdoc: Give documenter more control of linking MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit This update is preparation for implementing the actual task described in the bug. To implement it required converting the QML type node and the QML basic type node to be first order tree nodes instead of subtypes of the documentation node. This cleans up a lot of messy logic in some places. It was also necessary to split the getLink() function in the html output generator into two functions, one still called getLink(), which handles the \l command, and one called qetAutoLink() which is called for generating auto links. This should make qdoc run faster. The basic infrastructure was also added for parsing the string in the square brackets for the \l command. There will be a further update to complete this task. Note that some autolinks might not be generated due to this change. I haven't seen any yet, but I believe there will be some. This can be fixed later, if it is a problem. Task-number: QTBUG-39221 Change-Id: I8135229984398408205ba901b9ef95ceac74683c Reviewed-by: Topi Reiniö --- src/tools/qdoc/atom.cpp | 47 ++++++++++++++++++++++++++--------------------- 1 file changed, 26 insertions(+), 21 deletions(-) (limited to 'src/tools/qdoc/atom.cpp') diff --git a/src/tools/qdoc/atom.cpp b/src/tools/qdoc/atom.cpp index 6f9da3790d7..8816ea5d6f3 100644 --- a/src/tools/qdoc/atom.cpp +++ b/src/tools/qdoc/atom.cpp @@ -42,31 +42,12 @@ #include #include "atom.h" #include "location.h" +#include "qdocdatabase.h" #include +#include QT_BEGIN_NAMESPACE -QLatin1String Atom::BOLD_ ("bold"); -QLatin1String Atom::INDEX_ ("index"); -QLatin1String Atom::ITALIC_ ("italic"); -QLatin1String Atom::LINK_ ("link"); -QLatin1String Atom::PARAMETER_ ("parameter"); -QLatin1String Atom::SPAN_ ("span"); -QLatin1String Atom::SUBSCRIPT_ ("subscript"); -QLatin1String Atom::SUPERSCRIPT_ ("superscript"); -QLatin1String Atom::TELETYPE_ ("teletype"); -QLatin1String Atom::UICONTROL_ ("uicontrol"); -QLatin1String Atom::UNDERLINE_ ("underline"); - -QLatin1String Atom::BULLET_ ("bullet"); -QLatin1String Atom::TAG_ ("tag"); -QLatin1String Atom::VALUE_ ("value"); -QLatin1String Atom::LOWERALPHA_ ("loweralpha"); -QLatin1String Atom::LOWERROMAN_ ("lowerroman"); -QLatin1String Atom::NUMERIC_ ("numeric"); -QLatin1String Atom::UPPERALPHA_ ("upperalpha"); -QLatin1String Atom::UPPERROMAN_ ("upperroman"); - /*! \class Atom \brief The Atom class is the fundamental unit for representing documents internally. @@ -387,4 +368,28 @@ void Atom::dump() const str.toLatin1().data()); } +/*! + The only constructor for LinkAtom. It only create an Atom + of type Atom::Link with \a p1 being the link text. \a p2 + contains some search parameters. + */ +LinkAtom::LinkAtom(const QString& p1, const QString& p2) + : Atom(Link, p1), qml_(false), goal_(Node::NoType), domain_(0) +{ + QStringList params = p2.toLower().split(QLatin1Char(' ')); + foreach (const QString& p, params) { + if (p == "qml") + qml_ = true; + else { + if (!domain_) { + domain_ = QDocDatabase::qdocDB()->findTree(p); + if (domain_) + continue; + } + if (goal_ == Node::NoType) + goal_ = Node::goal(p); + } + } +} + QT_END_NAMESPACE -- cgit v1.2.3