diff options
author | Paul Wicking <paul.wicking@qt.io> | 2018-09-27 16:07:34 +0200 |
---|---|---|
committer | Paul Wicking <paul.wicking@qt.io> | 2018-10-01 10:01:00 +0000 |
commit | 91bde278ea2e883b4a46cafb1afc1781c71c1590 (patch) | |
tree | ead666ba943561e27fe7147ddf163b320d674f7f | |
parent | e8b01250fdbef269379df8c2481c9482317e8220 (diff) |
Doc: Fix QDoc warnings
Change-Id: I19545953bde10d4ccc2f37843dcda2569dc77df4
Reviewed-by: Martin Smith <martin.smith@qt.io>
-rw-r--r-- | examples/quick/tableview/gameoflife/doc/src/gameoflife.qdoc | 2 | ||||
-rw-r--r-- | examples/quick/tableview/pixelator/doc/src/pixelator.qdoc | 24 | ||||
-rw-r--r-- | src/qml/jsapi/qjsengine.cpp | 2 | ||||
-rw-r--r-- | src/qml/types/qqmldelegatecomponent.cpp | 2 | ||||
-rw-r--r-- | src/quick/doc/snippets/qml/mousearea/mousearea-snippet.qml | 4 | ||||
-rw-r--r-- | src/quick/doc/src/guidelines/qtquick-bestpractices.qdoc | 4 | ||||
-rw-r--r-- | src/quick/handlers/qquickhoverhandler.cpp | 2 |
7 files changed, 20 insertions, 20 deletions
diff --git a/examples/quick/tableview/gameoflife/doc/src/gameoflife.qdoc b/examples/quick/tableview/gameoflife/doc/src/gameoflife.qdoc index b2391d43ba..069513636a 100644 --- a/examples/quick/tableview/gameoflife/doc/src/gameoflife.qdoc +++ b/examples/quick/tableview/gameoflife/doc/src/gameoflife.qdoc @@ -26,7 +26,7 @@ ****************************************************************************/ /*! \title Qt Quick TableView examples - Conway’s Game of Life - \example gameoflife + \example tableview/gameoflife \brief The \e{Conway’s Game of Life} example shows how the QML TableView type can be used to display a C++ model that the user can pan around. diff --git a/examples/quick/tableview/pixelator/doc/src/pixelator.qdoc b/examples/quick/tableview/pixelator/doc/src/pixelator.qdoc index 4f8d519060..9e199a5347 100644 --- a/examples/quick/tableview/pixelator/doc/src/pixelator.qdoc +++ b/examples/quick/tableview/pixelator/doc/src/pixelator.qdoc @@ -26,7 +26,7 @@ ****************************************************************************/ /*! \title Qt Quick TableViews examples - Pixelator - \example pixelator + \example tableview/pixelator \brief The Pixelator example shows how a QML TableView and a delegate can be used for custom table models. @@ -35,36 +35,36 @@ \include examples-run.qdocinc - \snippet pixelator/imagemodel.h model + \snippet tableview/pixelator/imagemodel.h model We only require a simple, read-only table model. Thus, we need to implement functions to indicate the dimensions of the image and supply data to the TableView. - We use the \l{Qt property system}{Qt Property System} and a source property + We use the \l{The Property System}{Qt Property System} and a source property as \c QString to set the path of the image. - \snippet pixelator/imagemodel.cpp setsource + \snippet tableview/pixelator/imagemodel.cpp setsource Here we load the image when the source path is set. When the source path has changed, we need to call \c beginResetModel() before. After the image has been loaded, we need to call \c endResetModel(). - \snippet pixelator/imagemodel.cpp rowcolcount + \snippet tableview/pixelator/imagemodel.cpp rowcolcount The row and column count is set to image height and width, respectively. - \snippet pixelator/imagemodel.cpp data + \snippet tableview/pixelator/imagemodel.cpp data This overloaded function allows us to access the pixel data from the image. When we call this function with the display role, we return the pixel's gray value. - \snippet pixelator/main.cpp registertype + \snippet tableview/pixelator/main.cpp registertype We need to register our model in the QML type system to be able to use it from the QML side. - \snippet pixelator/main.qml pixelcomponent + \snippet tableview/pixelator/main.qml pixelcomponent Each pixel in the \c TableView is displayed via a delegate component. It contains an item that has an implicit height and width defining the @@ -72,22 +72,22 @@ It also has a property for the gray value of the pixel that is retrieved from the model. - \snippet pixelator/main.qml rectshape + \snippet tableview/pixelator/main.qml rectshape Inside the \c Item, there is a rounded \c Rectangle with the size and radius according to the pixel's gray value. - \snippet pixelator/main.qml interaction + \snippet tableview/pixelator/main.qml interaction For a little bit of interaction, we place a \c MouseArea inside the \c Item and change the Rectangle's color on mouse over. - \snippet pixelator/main.qml animation + \snippet tableview/pixelator/main.qml animation The \c Rectangle also has a short color animation to fade between the colors when it is changed. - \snippet pixelator/main.qml tableview + \snippet tableview/pixelator/main.qml tableview The \c TableView spans over the whole window and has an instance of our custom \c ImageModel attached. diff --git a/src/qml/jsapi/qjsengine.cpp b/src/qml/jsapi/qjsengine.cpp index 4aa7c4b45d..b5eadf483a 100644 --- a/src/qml/jsapi/qjsengine.cpp +++ b/src/qml/jsapi/qjsengine.cpp @@ -545,7 +545,7 @@ static QUrl moduleUrlForFileName(const QString &fileName) Subsequent imports of the same module will return the previously imported instance. Modules are singletons and remain around until the engine is destroyed. - The specified \a fileName will internally be normalized using \a QFileInfo::canonicalFilePath(). + The specified \a fileName will internally be normalized using \l QFileInfo::canonicalFilePath(). That means that multiple imports of the same file on disk using different relative paths will load the file only once. diff --git a/src/qml/types/qqmldelegatecomponent.cpp b/src/qml/types/qqmldelegatecomponent.cpp index fa7e994afd..007e8e2ec6 100644 --- a/src/qml/types/qqmldelegatecomponent.cpp +++ b/src/qml/types/qqmldelegatecomponent.cpp @@ -75,7 +75,7 @@ QVariant QQmlAbstractDelegateComponent::value(QQmlAdaptorModel *adaptorModel, in \qmltype DelegateChoice \instantiates QQmlDelegateChoice \inqmlmodule Qt.labs.qmlmodels - \brief Encapsulates a delegate and when to use it + \brief Encapsulates a delegate and when to use it. The DelegateChoice type wraps a delegate and defines the circumstances in which it should be chosen. diff --git a/src/quick/doc/snippets/qml/mousearea/mousearea-snippet.qml b/src/quick/doc/snippets/qml/mousearea/mousearea-snippet.qml index 0306c2de0f..13ef779d08 100644 --- a/src/quick/doc/snippets/qml/mousearea/mousearea-snippet.qml +++ b/src/quick/doc/snippets/qml/mousearea/mousearea-snippet.qml @@ -90,7 +90,7 @@ Rectangle { Rectangle { width: 100; height: 100 - //! [mouse handlers] + //! [signal handlers] MouseArea { anchors.fill: parent onClicked: console.log("area clicked") @@ -98,7 +98,7 @@ Rectangle { onEntered: console.log("mouse entered the area") onExited: console.log("mouse left the area") } - //! [mouse handlers] + //! [signal handlers] } } //end of column diff --git a/src/quick/doc/src/guidelines/qtquick-bestpractices.qdoc b/src/quick/doc/src/guidelines/qtquick-bestpractices.qdoc index f5599e404a..dd7f21e81a 100644 --- a/src/quick/doc/src/guidelines/qtquick-bestpractices.qdoc +++ b/src/quick/doc/src/guidelines/qtquick-bestpractices.qdoc @@ -28,7 +28,7 @@ /*! \page qtquick-bestpractices.html \title Best Practices for QML and Qt Quick -\brief Lists best practices for working with QML and Qt Quick +\brief Lists best practices for working with QML and Qt Quick. \ingroup best-practices Despite all of the benefits that QML and Qt Quick offer, they can be @@ -121,7 +121,7 @@ of resources. However, whenever a new file is added to \c RESOURCES using this approach, it causes \e all of the other files in \c RESOURCES to be recompiled as well. This can be inefficient, especially for large sets of files. In this case, a better approach is to separate each type of resource into its -own \l {Resource Collection Files (.qrc)}{.qrc} file. For example, the snippet +own \l [Qt Core] {Resource Collection Files}{.qrc} file. For example, the snippet above could be changed to the following: \badcode diff --git a/src/quick/handlers/qquickhoverhandler.cpp b/src/quick/handlers/qquickhoverhandler.cpp index fbf71ea3fc..61955cad03 100644 --- a/src/quick/handlers/qquickhoverhandler.cpp +++ b/src/quick/handlers/qquickhoverhandler.cpp @@ -48,7 +48,7 @@ Q_LOGGING_CATEGORY(lcHoverHandler, "qt.quick.handler.hover") \instantiates QQuickHoverHandler \inqmlmodule QtQuick \ingroup qtquick-input-handlers - \brief Handler for mouse and tablet hover + \brief Handler for mouse and tablet hover. HoverHandler detects a hovering cursor. Since touchscreens don't generally offer hover events, in practice it detects a hovering mouse or tablet stylus. |