summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorTopi Reinio <topi.reinio@digia.com>2015-09-16 10:39:48 +0200
committerTopi Reiniƶ <topi.reinio@digia.com>2015-09-22 12:48:45 +0000
commit1f3529316dc0aeb85a13d2953fbb4a749dd1e550 (patch)
tree9b1da1f42cc8a7e7ec54131b33e645cac41d84dc
parent32930400e5c2c23665cc351fa0e65a4c0e8b05e3 (diff)
downloadqtdoc-1f3529316dc0aeb85a13d2953fbb4a749dd1e550.tar.gz
Doc: Fix a number of QDoc warnings
qtdoc/doc/src/internationalization/i18n.qdoc:37: warning: Multiple topic commands found in comment: \group and \page. qtdoc/doc/src/getting-started/controls-texteditor.qdoc:28: warning: Can't link to 'Qt Resource System' qtdoc/doc/src/getting-started/controls-texteditor.qdoc:142: warning: Can't link to 'Row Layout' qtdoc/doc/src/frameworks-technologies/threads.qdoc:114: warning: Can't link to 'QtConcurrent::filter()' qtdoc/doc/src/frameworks-technologies/threads.qdoc:114: warning: Can't link to 'QtConcurrent::map()' qtdoc/doc/src/frameworks-technologies/threads.qdoc:114: warning: Can't link to 'QtConcurrent::filteredReduced()' qtdoc/doc/src/frameworks-technologies/threads.qdoc:114: warning: Can't link to 'QtConcurrent::mappedReduced()' Change-Id: I56da1dea912bdcfd1b8dbde47e3f4b24a42c3b3f Reviewed-by: Venugopal Shivashankar <venugopal.shivashankar@digia.com>
-rw-r--r--doc/src/frameworks-technologies/threads.qdoc20
-rw-r--r--doc/src/getting-started/controls-texteditor.qdoc4
-rw-r--r--doc/src/internationalization/i18n.qdoc5
3 files changed, 15 insertions, 14 deletions
diff --git a/doc/src/frameworks-technologies/threads.qdoc b/doc/src/frameworks-technologies/threads.qdoc
index 618e16bb..6a4bb198 100644
--- a/doc/src/frameworks-technologies/threads.qdoc
+++ b/doc/src/frameworks-technologies/threads.qdoc
@@ -177,11 +177,11 @@
computation across all available processor cores, so applications written today
will continue to scale when deployed later on a system with more cores.
- This module also provides the QtConcurrent::run() function, which can run any
- function in another thread. However, QtConcurrent::run() only supports a subset
+ This module also provides the \l {QtConcurrent::run}() function, which can run any
+ function in another thread. However, \l {QtConcurrent::run}() only supports a subset
of features available to the map, filter and reduce functions. The QFuture
can be used to retrieve the function's return value and to check if the thread
- is running. However, a call to QtConcurrent::run() uses one thread only, cannot
+ is running. However, a call to \l{QtConcurrent::run}() uses one thread only, cannot
be paused/resumed/canceled, and cannot be queried for progress.
See the \l{Qt Concurrent} module documentation for details on the individual functions.
@@ -219,7 +219,7 @@
\li Feature
\li QThread
\li QRunnable and QThreadPool
- \li QtConcurrent::run()
+ \li \l {QtConcurrent::run}()
\li Qt Concurrent (Map, Filter, Reduce)
\li WorkerScript
\row
@@ -292,13 +292,13 @@
\li Place the function in a reimplementation of QRunnable::run() and
add the QRunnable to a QThreadPool. Write to a \l{Synchronizing
Threads}{thread-safe variable} to update progress. OR
- \li Run the function using QtConcurrent::run(). Write to a \l{Synchronizing
+ \li Run the function using \l {QtConcurrent::run}(). Write to a \l{Synchronizing
Threads}{thread-safe variable} to update progress.
\endlist
\row
\li One call
\li Run an existing function within another thread and get its return value.
- \li Run the function using QtConcurrent::run(). Have a QFutureWatcher emit
+ \li Run the function using \l{QtConcurrent::run}(). Have a QFutureWatcher emit
the \l{QFutureWatcher::}{finished()} signal when the function has
returned, and call QFutureWatcher::result() to get the function's return
value.
@@ -306,11 +306,11 @@
\li One call
\li Perform an operation on all items of a container, using all available
cores. For example, producing thumbnails from a list of images.
- \li Use Qt Concurrent's \l{QtConcurrent::}{filter()} function to select
- container elements, and the \l{QtConcurrent::}{map()} function to apply
+ \li Use Qt Concurrent's \l{QtConcurrent::filter}() function to select
+ container elements, and the \l{QtConcurrent::map}() function to apply
an operation to each element. To fold the output into a single result,
- use \l{QtConcurrent::}{filteredReduced()} and
- \l{QtConcurrent::}{mappedReduced()} instead.
+ use \l{QtConcurrent::filteredReduced}() and
+ \l{QtConcurrent::mappedReduced}() instead.
\row
\li One call/Permanent
\li Perfrom a long computation in a pure QML application, and update the GUI
diff --git a/doc/src/getting-started/controls-texteditor.qdoc b/doc/src/getting-started/controls-texteditor.qdoc
index 3a1580f1..a0c99ca6 100644
--- a/doc/src/getting-started/controls-texteditor.qdoc
+++ b/doc/src/getting-started/controls-texteditor.qdoc
@@ -128,7 +128,7 @@ We will use these images later in the guide.
Qt Creator then packages the images alongside your application in a single
binary. For more information about resource files, see the
\l{Managing Resource Files with the Qt Resource System} and the
-\l{Qt Resource System} pages.
+\l{The Qt Resource System} pages.
\section1 Example Files
@@ -244,7 +244,7 @@ In the \uicontrol Navigator window, make sure that the tool bar is a child of th
application window. To make the tool bar a child of the window, simply drag the tool bar
underneath the application window.
-Within the tool bar, we need a \e{row} layout. Drag the \l{Row Layout} into the
+Within the tool bar, we need a \e{row} layout. Drag the \e{Row Layout} into the
\uicontrol Navigator window and set it to be a child of the tool bar.
Similarly, set these layout properties:
diff --git a/doc/src/internationalization/i18n.qdoc b/doc/src/internationalization/i18n.qdoc
index 5b55202d..0bb967af 100644
--- a/doc/src/internationalization/i18n.qdoc
+++ b/doc/src/internationalization/i18n.qdoc
@@ -35,12 +35,11 @@
*/
/*!
- \page internationalization.html
+ \group internationalization
\title Internationalization with Qt
\brief Information about Qt's support for internationalization and multiple languages.
\nextpage Writing Source Code for Translation
- \group internationalization
\keyword internationalization
\keyword i18n
@@ -359,6 +358,8 @@
For details on OS X-specific translation, refer to the Qt for OS X issues
document \l{Qt for OS X - Specific Issues#Translating the Application Menu and Native Dialogs}{here}.
+
+ \section1 Related Pages
*/
/*!