From 1afe110b8fe6da51ec23736fa3a105013255f904 Mon Sep 17 00:00:00 2001 From: Nico Vertriest Date: Wed, 21 Jan 2015 15:42:19 +0100 Subject: Doc: corrected link/autolink issues in corelib Task-number: QTBUG-43115 Change-Id: I31da92e3a7c4dd7b75ee283dbfecd77e284978ca Reviewed-by: Martin Smith --- src/corelib/kernel/qabstracteventdispatcher.cpp | 2 +- src/corelib/kernel/qcoreapplication.cpp | 4 ++-- src/corelib/kernel/qcoreevent.cpp | 10 +++++----- src/corelib/kernel/qmetatype.cpp | 2 ++ src/corelib/kernel/qpointer.cpp | 2 +- src/corelib/kernel/qtimer.cpp | 2 +- src/corelib/kernel/qvariant.cpp | 6 +++--- 7 files changed, 15 insertions(+), 13 deletions(-) (limited to 'src/corelib/kernel') diff --git a/src/corelib/kernel/qabstracteventdispatcher.cpp b/src/corelib/kernel/qabstracteventdispatcher.cpp index b365714365..bba6592b04 100644 --- a/src/corelib/kernel/qabstracteventdispatcher.cpp +++ b/src/corelib/kernel/qabstracteventdispatcher.cpp @@ -386,7 +386,7 @@ void QAbstractEventDispatcher::closingDown() \note The filter function set here receives native messages, that is, MSG or XEvent structs. - For maximum portability, you should always try to use QEvents + For maximum portability, you should always try to use QEvent objects and QObject::installEventFilter() whenever possible. \sa QObject::installEventFilter() diff --git a/src/corelib/kernel/qcoreapplication.cpp b/src/corelib/kernel/qcoreapplication.cpp index 6b0ebf8b8b..aea82fd48b 100644 --- a/src/corelib/kernel/qcoreapplication.cpp +++ b/src/corelib/kernel/qcoreapplication.cpp @@ -2399,7 +2399,7 @@ Q_GLOBAL_STATIC_WITH_ARGS(QMutex, libraryPathMutex, (QMutex::Recursive)) INSTALL/plugins, where \c INSTALL is the directory where Qt was installed). The directory of the application executable (NOT the working directory) is always added, as well as the colon separated - entries of the QT_PLUGIN_PATH environment variable. + entries of the \c QT_PLUGIN_PATH environment variable. If you want to iterate over the list, you can use the \l foreach pseudo-keyword: @@ -2544,7 +2544,7 @@ void QCoreApplication::removeLibraryPath(const QString &path) \note Native event filters will be disabled when the application the Qt::AA_MacPluginApplication attribute is set. - For maximum portability, you should always try to use QEvents + For maximum portability, you should always try to use QEvent and QObject::installEventFilter() whenever possible. \sa QObject::installEventFilter() diff --git a/src/corelib/kernel/qcoreevent.cpp b/src/corelib/kernel/qcoreevent.cpp index 85b7f51bd6..c0094fb7f2 100644 --- a/src/corelib/kernel/qcoreevent.cpp +++ b/src/corelib/kernel/qcoreevent.cpp @@ -58,7 +58,7 @@ QT_BEGIN_NAMESPACE send events using QCoreApplication::sendEvent() and QCoreApplication::postEvent() (spontaneous() returns \c false). - QObjects receive events by having their QObject::event() function + \l {QObject}{QObjects} receive events by having their QObject::event() function called. The function can be reimplemented in subclasses to customize event handling and add additional event types; QWidget::event() is a notable example. By default, events are @@ -102,13 +102,13 @@ QT_BEGIN_NAMESPACE \value ChildAdded An object gets a child (QChildEvent). \value ChildPolished A widget child gets polished (QChildEvent). \value ChildRemoved An object loses a child (QChildEvent). - \value Clipboard The clipboard contents have changed (QClipboardEvent). + \value Clipboard The clipboard contents have changed. \value Close Widget was closed (QCloseEvent). \value CloseSoftwareInputPanel A widget wants to close the software input panel (SIP). \value ContentsRectChange The margins of the widget's content rect changed. \value ContextMenu Context popup menu (QContextMenuEvent). \value CursorChange The widget's cursor has changed. - \value DeferredDelete The object will be deleted after it has cleaned up (QDeferredDeleteEvent). + \value DeferredDelete The object will be deleted after it has cleaned up (QDeferredDeleteEvent) \value DragEnter The cursor enters a widget during a drag and drop operation (QDragEnterEvent). \value DragLeave The cursor leaves a widget during a drag and drop operation (QDragLeaveEvent). \value DragMove A drag and drop operation is in progress (QDragMoveEvent). @@ -116,7 +116,7 @@ QT_BEGIN_NAMESPACE \value DynamicPropertyChange A dynamic property was added, changed, or removed from the object. \value EnabledChange Widget's enabled state has changed. \value Enter Mouse enters widget's boundaries (QEnterEvent). - \value EnterEditFocus An editor widget gains focus for editing. QT_KEYPAD_NAVIGATION must be defined. + \value EnterEditFocus An editor widget gains focus for editing. \c QT_KEYPAD_NAVIGATION must be defined. \value EnterWhatsThisMode Send to toplevel widgets when the application enters "What's This?" mode. \value Expose Sent to a window when its on-screen contents are invalidated and need to be flushed from the backing store. \value FileOpen File open request (QFileOpenEvent). @@ -177,7 +177,7 @@ QT_BEGIN_NAMESPACE \value MouseTrackingChange The mouse tracking state has changed. \value Move Widget's position changed (QMoveEvent). \value NativeGesture The system has detected a gesture (QNativeGestureEvent). - \value OrientationChange The screens orientation has changes (QScreenOrientationChangeEvent) + \value OrientationChange The screens orientation has changes (QScreenOrientationChangeEvent). \value Paint Screen update necessary (QPaintEvent). \value PaletteChange Palette of the widget changed. \value ParentAboutToChange The widget parent is about to change. diff --git a/src/corelib/kernel/qmetatype.cpp b/src/corelib/kernel/qmetatype.cpp index 311648c33a..74e53b5e86 100644 --- a/src/corelib/kernel/qmetatype.cpp +++ b/src/corelib/kernel/qmetatype.cpp @@ -188,6 +188,8 @@ struct DefinedTypesFilter { \enum QMetaType::Type These are the built-in types supported by QMetaType: + Read doc on QChar + Read doc on \l QChar \value Void \c void \value Bool \c bool diff --git a/src/corelib/kernel/qpointer.cpp b/src/corelib/kernel/qpointer.cpp index 1a7d0930de..c0da2c3cf0 100644 --- a/src/corelib/kernel/qpointer.cpp +++ b/src/corelib/kernel/qpointer.cpp @@ -55,7 +55,7 @@ \li When using QPointer on a QWidget (or a subclass of QWidget), previously the QPointer would be cleared by the QWidget destructor. Now, the QPointer - is cleared by the QObject destructor (since this is when QWeakPointers are + is cleared by the QObject destructor (since this is when QWeakPointer objects are cleared). Any QPointers tracking a widget will \b NOT be cleared before the QWidget destructor destroys the children for the widget being tracked. diff --git a/src/corelib/kernel/qtimer.cpp b/src/corelib/kernel/qtimer.cpp index 0803cf302e..99fe33ebc6 100644 --- a/src/corelib/kernel/qtimer.cpp +++ b/src/corelib/kernel/qtimer.cpp @@ -91,7 +91,7 @@ QT_BEGIN_NAMESPACE its work. This is the traditional way of implementing heavy work in GUI applications, but as multithreading is nowadays becoming available on more and more platforms, we expect that zero-millisecond - QTimers will gradually be replaced by \l{QThread}s. + QTimer objects will gradually be replaced by \l{QThread}s. \section1 Accuracy and Timer Resolution diff --git a/src/corelib/kernel/qvariant.cpp b/src/corelib/kernel/qvariant.cpp index f76201802b..3db19f1ee5 100644 --- a/src/corelib/kernel/qvariant.cpp +++ b/src/corelib/kernel/qvariant.cpp @@ -1274,13 +1274,13 @@ QVariant::QVariant(const char *val) /*! \fn QVariant::QVariant(const QMap &val) - Constructs a new variant with a map of QVariants, \a val. + Constructs a new variant with a map of \l {QVariant}s, \a val. */ /*! \fn QVariant::QVariant(const QHash &val) - Constructs a new variant with a hash of QVariants, \a val. + Constructs a new variant with a hash of \l {QVariant}s, \a val. */ /*! @@ -3333,7 +3333,7 @@ QDebug operator<<(QDebug dbg, const QVariant::Type p) Q_OBJECT macro. If the QVariant contains a sequential container and \c{T} is QVariantList, the - elements of the container will be converted into QVariants and returned as a QVariantList. + elements of the container will be converted into \l {QVariant}s and returned as a QVariantList. \snippet code/src_corelib_kernel_qvariant.cpp 9 -- cgit v1.2.3