diff options
author | Sze Howe Koh <szehowe.koh@gmail.com> | 2013-11-07 18:42:37 +0800 |
---|---|---|
committer | The Qt Project <gerrit-noreply@qt-project.org> | 2013-11-07 15:14:02 +0100 |
commit | 359f52443707f635b4493ffbbb561ad0402a24fc (patch) | |
tree | cb70ec4ce7802b6ccb1e7014391f9cee28003b41 | |
parent | 5f5e921723f32cb7801762ef1e4e45e8409f1d61 (diff) |
Doc: Fix broken links
Task-number: QTBUG-33360
Change-Id: Ia032feade78aa2c8f33c3afb0cd8b7237768c95a
Reviewed-by: Jerome Pasion <jerome.pasion@digia.com>
-rw-r--r-- | doc/src/getting-started/examples.qdoc | 2 | ||||
-rw-r--r-- | doc/src/getting-started/gettingstartedqml.qdoc | 2 | ||||
-rw-r--r-- | doc/src/platforms/platform-notes-android.qdoc | 2 | ||||
-rw-r--r-- | doc/src/platforms/wince-introduction.qdoc | 2 | ||||
-rw-r--r-- | doc/src/qmlapp/deployment.qdoc | 2 | ||||
-rw-r--r-- | doc/src/qmlapp/performance.qdoc | 6 | ||||
-rw-r--r-- | doc/src/source-breaks.qdoc | 81 | ||||
-rw-r--r-- | doc/src/whatsnew/whatsnew50.qdoc | 2 |
8 files changed, 51 insertions, 48 deletions
diff --git a/doc/src/getting-started/examples.qdoc b/doc/src/getting-started/examples.qdoc index 729e2db2c..604b1fe40 100644 --- a/doc/src/getting-started/examples.qdoc +++ b/doc/src/getting-started/examples.qdoc @@ -109,7 +109,7 @@ \li \l{Qt Test Tutorial}{Qt Test} - This tutorial gives a short introduction to how to use some of the features of Qt's unit-testing framework, Qt Test. It is divided into four chapters. - \li \l{qmake Tutorial}{qmake} - This tutorial teaches you how to use \c + \li \l{Getting Started}{qmake} - This tutorial teaches you how to use \c qmake. We recommend that you read the \l{qmake Manual}{qmake user guide} after completing this tutorial. \li \l{Qt Linguist Manual: Developers#Tutorials}{Qt Linguist} - A guided diff --git a/doc/src/getting-started/gettingstartedqml.qdoc b/doc/src/getting-started/gettingstartedqml.qdoc index dd890c345..bad3b6a0e 100644 --- a/doc/src/getting-started/gettingstartedqml.qdoc +++ b/doc/src/getting-started/gettingstartedqml.qdoc @@ -589,7 +589,7 @@ during state transitions. The easing curve we chose is \l{PropertyAnimation::easing.type}{\c Easing.OutExpo}, which slows the movement near the end of the animation. For more information, see QML's - \l {qdeclarativeanimation.html}{animation} article. + \l {Animation and Transitions in Qt Quick}{animation} article. \code transitions: [ diff --git a/doc/src/platforms/platform-notes-android.qdoc b/doc/src/platforms/platform-notes-android.qdoc index 287c6f0b7..3cb5b0b3b 100644 --- a/doc/src/platforms/platform-notes-android.qdoc +++ b/doc/src/platforms/platform-notes-android.qdoc @@ -116,7 +116,7 @@ \section1 OpenGL Special Considerations Qt for Android provides two separate platform plugins: One which is suited for traditional - \l{Qt Widget}{widget-based} apps that do not require OpenGL support, and one which will be used + \l{Qt Widgets}{widget-based} apps that do not require OpenGL support, and one which will be used when OpenGL is required. When building and deploying your app, Qt Creator will detect whether the OpenGL-enabled plugin is required by checking if your app depends on either the \l{Qt OpenGL} module or the \l{Qt Quick} module. diff --git a/doc/src/platforms/wince-introduction.qdoc b/doc/src/platforms/wince-introduction.qdoc index 9b48c8610..d3dccefca 100644 --- a/doc/src/platforms/wince-introduction.qdoc +++ b/doc/src/platforms/wince-introduction.qdoc @@ -92,7 +92,7 @@ \snippet snippets/code/doc_src_wince-introduction.qdoc 0 For more information on how to use qmake have a look at the \l - {qmake Tutorial}. + {Getting Started}{qmake Tutorial}. \section1 Running the application diff --git a/doc/src/qmlapp/deployment.qdoc b/doc/src/qmlapp/deployment.qdoc index e58bae4d7..c64e1ec95 100644 --- a/doc/src/qmlapp/deployment.qdoc +++ b/doc/src/qmlapp/deployment.qdoc @@ -90,7 +90,7 @@ It can be loaded in a Qt application's \c main.cpp file like this: This creates a QWindow-based view that displays the contents of \c application.qml. -The application's \c .pro \l{qmake Project Files}{project file} must specify +The application's \c .pro \l{Creating Project Files}{project file} must specify the \c declarative module for the \c QT variable. For example: \code diff --git a/doc/src/qmlapp/performance.qdoc b/doc/src/qmlapp/performance.qdoc index b8fb1c389..5d8aa853c 100644 --- a/doc/src/qmlapp/performance.qdoc +++ b/doc/src/qmlapp/performance.qdoc @@ -789,7 +789,7 @@ The QML engine does some tricky things to try to ensure that loading and initial components doesn't cause frames to be skipped. However, there is no better way to reduce startup time than to avoid doing work you don't need to do, and delaying the work until it is necessary. This may be achieved by using either \l Loader or creating components -\l {qtqml-javascript-dynamicobjects.html}{dynamically}. +\l {Dynamic QML Object Creation from JavaScript}{dynamically}. \section3 Using Loader @@ -808,8 +808,8 @@ The Loader is an element which allows dynamic loading and unloading of component Developers can use the Qt.createComponent() function to create a component dynamically at runtime from within JavaScript, and then call createObject() to instantiate it. Depending on the ownership semantics specified in the call, the developer may have to delete the -created object manually. See \l{qtqml-javascript-dynamicobjects.html} -{Dynamic Object Management in QML} for more information. +created object manually. See \l{Dynamic QML Object Creation from JavaScript} for more +information. \section2 Destroy Unused Elements diff --git a/doc/src/source-breaks.qdoc b/doc/src/source-breaks.qdoc index d8c5b6465..d3f893f5f 100644 --- a/doc/src/source-breaks.qdoc +++ b/doc/src/source-breaks.qdoc @@ -48,19 +48,19 @@ The following sections lists the API changes in each module and provides recomme \li \l{QString} and \l{QByteArray} constructors now use a negative size to indicate that the string passed is null-terminated (a null-terminated array of \l{QChar}, in the case of QString). In Qt 4, negative sizes were ignored, which resulted in empty \l{QString} and \l{QByteArray}. The size argument now has a default value of -1, replacing the separate constructors that did the same. - \li \c{QBool} is removed. In Qt 4, \l{QString::contains}, \l{QByteArray::contains}, and \l{QList::contains} + \li \c{QBool} is removed. In Qt 4, \l{QString::contains()}, \l{QByteArray::contains()}, and \l{QList::contains()} returns an internal \c{QBool} type so that the Qt3 code "if (a.contains() == 2)" would not compile anymore. If your code uses \c{QBool}, replace it with \c{bool}. \li \l{QMetaType} has undergone the following changes: \list - \li \c{QMetaType::construct} is renamed as \l{QMetaType::create}. + \li \c{QMetaType::construct()} is renamed as \l{QMetaType::create()}. \li \c{QMetaType::unregisterType()} is removed. \li \l{QMetaType} now records whether the type argument inherits QObject. Such information can be useful for scripting APIs, so that custom QObject subclasses are treated as QObject pointers. For example, in \l{Qt Script} this - means \l{QScriptValue.isQObject} can be true, where it was false before. - \li \c{QMetaType::QWidgetStar} is removed. Use \l{qMetaTypeId<QWidget*>()} - or \l{QVariant::canConvert<QWidget*>()} instead. + means \l{QScriptValue::isQObject()} can be true, where it was false before. + \li \c{QMetaType::QWidgetStar} is removed. Use \l{qMetaTypeId()}{qMetaTypeId<QWidget*>()} + or \l{QVariant::canConvert()}{QVariant::canConvert<QWidget*>()} instead. \li \c{Q_DECLARE_METATYPE(type)} now requires \c{type} to be fully defined. This means, \c{Q_DECLARE_METATYPE(QSharedPointer<t>)} and \c{Q_DECLARE_METATYPE(QWeakPointer<t>)} also need \c{type} to be fully defined. @@ -68,13 +68,13 @@ The following sections lists the API changes in each module and provides recomme \endlist \li \l{QMetaMethod} has undergone the following changes: \list - \li \c{QMetaMethod::signature()} is renamed as \l{QMetaMethod::methodSignature}, + \li \c{QMetaMethod::signature()} is renamed as \l{QMetaMethod::methodSignature()}, and the return type is changed to \l{QByteArray}. This change is to enable generating the signature string on demand, rather than storing it in the meta-data. - \li \l{QMetaMethod::typeName} no longer returns an empty string if the return + \li \l{QMetaMethod::typeName()} no longer returns an empty string if the return type is \c{void}, instead it returns \c{"void"}. The recommended way of checking whether a - method returns \c{void} is to compare the return value of \l{QMetaMethod::returnType} + method returns \c{void} is to compare the return value of \l{QMetaMethod::returnType()} with \l{QMetaType::Void}. \endlist \li The \l{QVariant} constructor which takes \l{Qt::GlobalColor} argument is removed. @@ -157,31 +157,31 @@ The following sections lists the API changes in each module and provides recomme creating uncertainty/bugs in using QString easily and (to a lesser extent) performance issues. \li \c{QTextCodec::codecForTr()} and \c{QTextCodec::setCodecForTr()} are removed. \endlist - \li \l{QObject::trUtf8} and \c{QCoreApplication::Encoding} enums are deprecated. Qt assumes + \li \l{QObject::trUtf8()} and \c{QCoreApplication::Encoding} are deprecated. Qt assumes that the source code is encoded in UTF-8. \li \l{QFile::setEncodingFunction()} and \l{QFile::setDecodingFunction()} are deprecated. - The \c{QFile::encodeName} and \c{QFile::decodeName} are now hard-coded to operate - on \l{QString::fromLocal8Bit} and \l{QString::toLocal8Bit} only. The old behavior is still possible using \l{QTextCodec::setCodecForLocale}, + The \l{QFile::encodeName()} and \l{QFile::decodeName()} functions are now hard-coded to operate + on \l{QString::fromLocal8Bit()} and \l{QString::toLocal8Bit()} only. The old behavior is still possible using \l{QTextCodec::setCodecForLocale()}, but it is recommended that the new code should not make assumptions about the file system encoding and older code should remove such assumptions. \li \c{QEvent::AccessibilityPrepare}, {QEvent::AccessibilityHelp}, and \c{QEvent::AccessibilityDescription} are removed. - \li The \c{QCoreApplication::setEventFilter} and the \c{QApplication::x11EventFilter/macEventFilter/qwsEventFilter/winEventFilter} are replaced - with \l{QCoreApplication::installNativeEventFilter} and \l{QCoreApplication::removeNativeEventFilter} for an API much closer to QEvent filtering. + \li \c{QCoreApplication::setEventFilter()} and \c{QApplication::x11EventFilter/macEventFilter/qwsEventFilter/winEventFilter} are replaced + with \l{QCoreApplication::installNativeEventFilter()} and \l{QCoreApplication::removeNativeEventFilter()} for an API much closer to QEvent filtering. \note The native events that can be filtered this way depend on the QPA backend chosen at runtime. On X11, XEvents are replaced with \c{xcb_generic_event_t} due to the switch to XCB, which requires porting the application code to XCB as well. - \li \l{Qt::qDebug()}, \l{Qt::qWarning()}, \l{Qt::qCritical()}, and \l{Qt::qFatal()} are changed to macros now to track the origin + \li \l{qDebug()}, \l{qWarning()}, \l{qCritical()}, and \l{qFatal()} are changed to macros now to track the origin of the message in source code. The information to be printed can be configured (for the default message handler) by setting the new \c{QT_MESSAGE_PATTERN} environment variable. - \l{Qt::qInstallMsgHandler()} is deprecated, so we recommend using \l{Qt::qInstallMessageHandler()} instead. + \l{qInstallMsgHandler()} is deprecated, so we recommend using \l{qInstallMessageHandler()} instead. \li \l{QPointer} is changed to use \l{QWeakPointer}. The old guard mechanism has been removed, which causes a slight change in behavior when using \l{QPointer}. In earlier Qt version, if a \l{QPointer} is used on a \l{QWidget} (or a subclass of QWidget), the \l{QPointer} was cleared by the \l{QWidget} destructor. In Qt 5, the \l{QPointer} is cleared by the \l{QObject} destructor along with - the \l{QWeakPointers}. Any \l{QPointers} tracking a widget is not cleared before the \l{QWidget} destructor destroys the children + the \l{QWeakPointer}s. Any \l{QPointer}s tracking a widget is not cleared before the \l{QWidget} destructor destroys the children for the widget being tracked. \li \l{QUrl} has been changed to operate only on percent-encoded forms. Fully-decoded forms where the percent character stands for itself, can no longer be encoded, as the getters and setters with "encoded" in the name are deprecated (except \l{QUrl::toEncoded()} and \l{QUrl::fromEncoded()}). - The most notable difference with this change is when dealing with \l{QUrl::toString}. In earlier Qt version, this function would return percent characters - in the URL, but now it returns "%25" like the \l{QUrl::toEncoded} does. + The most notable difference with this change is when dealing with \l{QUrl::toString()}. In earlier Qt version, this function would return percent characters + in the URL, but now it returns "%25" like the \l{QUrl::toEncoded()} does. \li \l{QUrl} no longer has functions that handle individual query items and query delimiters, such as \c addQueryItem() and \c queryPairDelimiter(). These have been moved to the new \l{QUrlQuery} class. \li \l{Qt::WFlags} is deprecated, use \l{Qt::WindowFlags} instead. @@ -198,9 +198,9 @@ The following sections lists the API changes in each module and provides recomme \li The "child" integer parameters are removed to bring it more closer to \c{IAccessible2}, and this means the following functions lose the integer parameter: \list - \li text(Text t, int child) is now \l{QAccessibleInterface::text(QAccessible::Text t)}{text(Text t)} + \li text(Text t, int child) is now \l{QAccessibleInterface::text()}{text(Text t)} \li rect(int child) is now \l{QAccessibleInterface::rect()}{rect()} - \li setText(Text t, int child, const QString &text) is now \l{QAccessibleInterface::setText(QAccessible::Text t, const QString &text)}{setText(Text t, const QString &text)} + \li setText(Text t, int child, const QString &text) is now \l{QAccessibleInterface::setText()}{setText(Text t, const QString &text)} \li role(int child) is now \l{QAccessibleInterface::role()}{role()} \li state(int child) is now \l{QAccessibleInterface::state()}{state()} \endlist @@ -244,7 +244,7 @@ The following sections lists the API changes in each module and provides recomme \section1 Changes to Qt Widgets \list - \li The signatures of \l{QItemEditorFactory::createEditor} and \l{QItemEditorFactory::valuePropertyName} + \li The signatures of \l{QItemEditorFactory::createEditor()} and \l{QItemEditorFactory::valuePropertyName()} are changed to take arguments of type \c{int} instead of \l{QVariant::Type}. \li \c{QInputContext} is removed as related getter and setter functions in \l{QWidget} and \l{QApplication} are removed. Input contexts are now platform-specific. @@ -257,20 +257,20 @@ The following sections lists the API changes in each module and provides recomme respective base classes. The removed classes are left as typedefs for binary compatibility. \li The following functions of \l{QHeaderView} are deprecated: \list - \li \c{void setMovable(bool movable)} - Use \l{QHeaderView::setSectionsMovable} instead. - \li \c{bool isMovable() const} - Use \l{QHeaderView::sectionsMovable} instead. - \li \c{void setClickable(bool clickable)} - Use \l{QHeaderView::setSectionsClickable} instead. - \li \c{bool isClickable() const} - Use \l{QHeaderView::sectionsClickable} instead. - \li \c{void setResizeMode(int logicalindex, ResizeMode mode)} - Use \l{QHeaderView::setSectionResizeMode} instead. - \li \c{* ResizeMode resizeMode(int logicalindex) const} - Use \l{QHeaderView::sectionResizeMode} instead. + \li \c{void setMovable(bool movable)} - Use \l{QHeaderView::setSectionsMovable()} instead. + \li \c{bool isMovable() const} - Use \l{QHeaderView::sectionsMovable()} instead. + \li \c{void setClickable(bool clickable)} - Use \l{QHeaderView::setSectionsClickable()} instead. + \li \c{bool isClickable() const} - Use \l{QHeaderView::sectionsClickable()} instead. + \li \c{void setResizeMode(int logicalindex, ResizeMode mode)} - Use \l{QHeaderView::setSectionResizeMode()} instead. + \li \c{ResizeMode resizeMode(int logicalindex) const} - Use \l{QHeaderView::sectionResizeMode()} instead. \endlist \li \l{QGraphicsItem} and its derived classes can no longer pass a \l{QGraphicsScene} to the item's constructor. - Construct the item without a scene and call \l{QGraphicsScene::addItem} to add the item to the scene. + Construct the item without a scene and call \l{QGraphicsScene::addItem()} to add the item to the scene. \li \l{QAbstractItemView} has undergone the following changes: \list \li The derived classes now emit the \c{clicked()} signal on the left mouse click only, instead of all mouse clicks. - \li The virtual \l{QAbstractItemView::dataChanged} function signature now includes the roles that has changed. - The signature is consistent with the \c{dataChanged} signal in the model. + \li The virtual \l{QAbstractItemView::dataChanged()} function signature now includes the roles that has changed. + The signature is consistent with the \c{dataChanged()} signal in the model. \endlist \li \c{QProxyModel} is removed. Use \l{QAbstractProxyModel} and the related classes instead. A copy of \c{QProxyModel} is available in the \l{http://qt-project.org/wiki/Qt-5-UI-Helpers}{Ui Helpers} repository. @@ -310,7 +310,7 @@ The following sections lists the API changes in each module and provides recomme \section1 Changes to Qt Print Support \list - \li The \l{QPageSetupDialog::PageSetupDialogOption} enum and the corresponding set and get functions, \c{QPageSetupDialog::options()} + \li The \c{QPageSetupDialog::PageSetupDialogOption} enum and the corresponding set and get functions, \c{QPageSetupDialog::options()} and \c{QPageSetupDialog::setOptions()} are removed. \li Support for printing PostScript files has been removed. \endlist @@ -332,13 +332,13 @@ The following sections lists the API changes in each module and provides recomme \section1 Changes to Qt SQL \list - \li \l{QSqlQueryModel::indexInQuery} is virtual now. - \li \l{QSqlQueryMode::setQuery} emits fewer signals. The \c{modelAboutToBeReset()} + \li \l{QSqlQueryModel::indexInQuery()} is virtual now. + \li \l{QSqlQueryModel::setQuery()} emits fewer signals. The \c{modelAboutToBeReset()} and \c{modelReset()} signals are sufficient to inform views that they must re-interrogate the model. - \li The \l{QSqlDriver::subscribeToNotification}, \l{QSqlDriver::unsubscribeFromNotification}, - \l{QSqlDriver::subscribedToNotifications}, \l{QSqlDriver::isIdentifierEscaped}, and - \l{QSqlDriver::stripDelimiters} functions are virtual now. The corresponding xxxImplementation + \li The \l{QSqlDriver::subscribeToNotification()}, \l{QSqlDriver::unsubscribeFromNotification()}, + \l{QSqlDriver::subscribedToNotifications()}, \l{QSqlDriver::isIdentifierEscaped()}, and + \l{QSqlDriver::stripDelimiters()} functions are virtual now. The corresponding \c xxxImplementation functions are also removed as the subclasses of \l{QSqlDriver} can re-implement those directly. \endlist @@ -362,7 +362,7 @@ The following sections lists the API changes in each module and provides recomme report a meaningful explanation in the test log. \li The \c{DEPENDS_ON} macro is removed as it misled some users to believe that they could make test functions depend on each other or impose an execution order on test functions. - \li The \l{QTest::qt_snprintf()} function is removed. This was an + \li The \c{QTest::qt_snprintf()} function is removed. This was an internal test library function that was exposed in the public API due to its use in a public macro. Any calls to this function must be replaced with \c{QByteArray::qsnprintf()}. @@ -381,7 +381,7 @@ The following sections lists the API changes in each module and provides recomme \list \li \c{qMacVersion()}: This global function is removed. Use \l{QSysInfo::macVersion()} or \l{QSysInfo::MacintoshVersion} instead. - \li \l{Qt::escape}{escape()}: This global function is deprecated. Use \l{QString::toHtmlEscaped()} instead. + \li \c{Qt::escape()}: This global function is deprecated. Use \l{QString::toHtmlEscaped()} instead. \li \c{qIsDetached<>}: This global function is removed as it is not relevant anymore for multi-threaded applications. There is no replacement for this function. \endlist @@ -393,5 +393,8 @@ The following sections lists the API changes in each module and provides recomme \endlist \section1 Related Topics -\l{New Classes and Functions in Qt 5}{New Classes and Functions in Qt 5} +\list +\li \l{New Classes and Functions in Qt 5.2} +\li \l{New Classes and Functions in Qt 5.1} +\endlist */ diff --git a/doc/src/whatsnew/whatsnew50.qdoc b/doc/src/whatsnew/whatsnew50.qdoc index 76c21ff93..947a2907f 100644 --- a/doc/src/whatsnew/whatsnew50.qdoc +++ b/doc/src/whatsnew/whatsnew50.qdoc @@ -63,7 +63,7 @@ Most of the useful l\{Qt OpenGL} classes have been polished and moved into \l{Qt GUI}. A few important ones are, QOpenGLFramebufferObject, QOpenGLShaderProgram, QOpenGLFunctions, and so on. For the complete list, - refer to \l{Qt GUI C++ API}. + refer to \l{Qt GUI C++ Classes}. This change introduces QOpenGLContext as a replacement for QGLContext. This replacement class is more generic and decoupled from QWindow, making it to |