From 33a34960328cce7a6994d2ea771c82da7bfdb598 Mon Sep 17 00:00:00 2001
From: Jesper Thomschutz <jesper.thomschutz@nokia.com>
Date: Tue, 24 Aug 2010 15:25:45 +0200
Subject: Doc: Fixed qdoc warnings.
Reviewed-by: Trust Me
(cherry picked from commit cb086eb5340c4c41efaf45373aa05c37e8aa974a)
Conflicts:
doc/src/index.qdoc
src/dbus/qdbusconnection.cpp
src/declarative/util/qdeclarativeanimation.cpp
src/gui/s60framework/qs60mainapplication.cpp
src/gui/s60framework/qs60mainappui.cpp
src/network/access/qnetworkrequest.cpp
---
doc/src/declarative/declarativeui.qdoc | 2 +-
doc/src/declarative/qtdeclarative.qdoc | 2 +-
doc/src/examples/qml-examples.qdoc | 2 +-
doc/src/examples/simpletreemodel.qdoc | 4 +--
doc/src/examples/spinboxdelegate.qdoc | 4 +--
doc/src/external-resources.qdoc | 2 +-
doc/src/index.qdoc | 2 +-
doc/src/modules.qdoc | 1 -
doc/src/overviews.qdoc | 3 +--
doc/src/qt-webpages.qdoc | 5 ++++
src/dbus/qdbusconnection.cpp | 5 ++++
src/declarative/qml/qdeclarativeimageprovider.cpp | 8 +++---
src/declarative/util/qdeclarativeanimation.cpp | 2 +-
src/declarative/util/qdeclarativetransition.cpp | 2 +-
src/gui/graphicsview/qgraphicsitem.cpp | 18 ++++++++++++++
src/gui/graphicsview/qgraphicstransform.cpp | 21 ++++++++++++++++
src/gui/s60framework/qs60mainapplication.cpp | 4 +--
src/gui/s60framework/qs60mainappui.cpp | 30 +++++++++++------------
src/network/access/qnetworkrequest.cpp | 20 +++++++++------
tools/qdoc3/test/qt-html-templates.qdocconf | 7 ++----
20 files changed, 97 insertions(+), 47 deletions(-)
diff --git a/doc/src/declarative/declarativeui.qdoc b/doc/src/declarative/declarativeui.qdoc
index b25d000..ce35f26 100644
--- a/doc/src/declarative/declarativeui.qdoc
+++ b/doc/src/declarative/declarativeui.qdoc
@@ -27,7 +27,7 @@
/*!
\title Qt Quick
-\page declarativeui.html
+\page qtquick.html
\brief Qt Quick provides a declarative framework for building highly
dynamic, custom user interfaces.
diff --git a/doc/src/declarative/qtdeclarative.qdoc b/doc/src/declarative/qtdeclarative.qdoc
index 413eb59..b4f4c83 100644
--- a/doc/src/declarative/qtdeclarative.qdoc
+++ b/doc/src/declarative/qtdeclarative.qdoc
@@ -48,7 +48,7 @@
\endcode
For more information on the Qt Declarative module, see the
- \l{declarativeui.html}{Qt Quick} documentation.
+ \l{Qt Quick} documentation.
*/
diff --git a/doc/src/examples/qml-examples.qdoc b/doc/src/examples/qml-examples.qdoc
index 68b66e1..fb219fd 100644
--- a/doc/src/examples/qml-examples.qdoc
+++ b/doc/src/examples/qml-examples.qdoc
@@ -559,7 +559,7 @@
\example declarative/ui-components/dialcontrol
This example shows how to create a dial-type control. It combines
- \l Image elements with \l Rotation transforms and \l SpringAnimatino behaviors
+ \l Image elements with \l Rotation transforms and \l SpringAnimation behaviors
to produce an interactive speedometer-type dial.
\image qml-dialcontrol-example.png
diff --git a/doc/src/examples/simpletreemodel.qdoc b/doc/src/examples/simpletreemodel.qdoc
index c34f4af..790d5fa 100644
--- a/doc/src/examples/simpletreemodel.qdoc
+++ b/doc/src/examples/simpletreemodel.qdoc
@@ -32,7 +32,7 @@
The Simple Tree Model example shows how to create a basic, read-only
hierarchical model to use with Qt's standard view classes. For a
description of simple non-hierarchical list and table models, see the
- \l{model-view-programming.html}{Model/View Programming} overview.
+ \l{Model/View Programming} overview.
\image simpletreemodel-example.png
@@ -40,7 +40,7 @@
information in a data source, using an abstract model of the data to
simplify and standardize the way it is accessed. Simple models represent
data as a table of items, and allow views to access this data via an
- \l{model-view-model.html}{index-based} system. More generally, models can
+ \l{Model/View Programming#Models}{index-based} system. More generally, models can
be used to represent data in the form of a tree structure by allowing each
item to act as a parent to a table of child items.
diff --git a/doc/src/examples/spinboxdelegate.qdoc b/doc/src/examples/spinboxdelegate.qdoc
index 49e3295..48e4bfa 100644
--- a/doc/src/examples/spinboxdelegate.qdoc
+++ b/doc/src/examples/spinboxdelegate.qdoc
@@ -42,8 +42,8 @@
\image spinboxdelegate-example.png
This concepts behind this example are covered in the
- \l{model-view-delegate.html}{Delegate Classes} chapter of the
- \l{model-view-programming.html}{Model/View Programming} overview.
+ \l{Model/View Programming#Delegate Classes}{Delegate Classes} chapter of the
+ \l{Model/View Programming} overview.
\section1 SpinBoxDelegate Class Definition
diff --git a/doc/src/external-resources.qdoc b/doc/src/external-resources.qdoc
index 61c9da2..de6bafb 100644
--- a/doc/src/external-resources.qdoc
+++ b/doc/src/external-resources.qdoc
@@ -416,5 +416,5 @@
/*!
\externalpage http://opensource.org/licenses/bsd-license.php
- \title BSD License
+ \title New and Modified BSD Licenses
*/
diff --git a/doc/src/index.qdoc b/doc/src/index.qdoc
index e45892f..bd8e4ad 100644
--- a/doc/src/index.qdoc
+++ b/doc/src/index.qdoc
@@ -72,7 +72,7 @@
<li><a href="technology-apis.html">Qt and Key Technologies</a></li>
<li><a href="best-practices.html">Best Practices Guides</a></li>
</ul>
- </div>
+ </div>
<div class="sectionlist">
<ul>
<li><a href="qtquick.html">Qt Quick</a></li>
diff --git a/doc/src/modules.qdoc b/doc/src/modules.qdoc
index a81bfb2..c51fcad 100644
--- a/doc/src/modules.qdoc
+++ b/doc/src/modules.qdoc
@@ -116,7 +116,6 @@
/*!
\module QtMultimedia
- \page qtmultimedia-module.html
\title QtMultimedia Module
\contentspage All Modules
\previouspage QtCore
diff --git a/doc/src/overviews.qdoc b/doc/src/overviews.qdoc
index a1773a3..c7b88cf 100644
--- a/doc/src/overviews.qdoc
+++ b/doc/src/overviews.qdoc
@@ -55,8 +55,7 @@
These pages are about Qt's traditional set of GUI components for
building both native look ^ feel and custom UI's for the desktop
- environment. Use \l {declarativeui.html} {Qt Quick} for building
- UI's for mobile devices.
+ environment. Use \l{Qt Quick} for building UI's for mobile devices.
\generatelist {related}
*/
diff --git a/doc/src/qt-webpages.qdoc b/doc/src/qt-webpages.qdoc
index 89d564f..c8a43b7 100644
--- a/doc/src/qt-webpages.qdoc
+++ b/doc/src/qt-webpages.qdoc
@@ -234,3 +234,8 @@
\externalpage http://qt.gitorious.org
\title Public Qt Repository
*/
+
+/*!
+ \externalpage http://get.qt.nokia.com/nokiasmartinstaller/
+ \title Smart Installer
+*/
diff --git a/src/dbus/qdbusconnection.cpp b/src/dbus/qdbusconnection.cpp
index 6a46eac..1b65399 100644
--- a/src/dbus/qdbusconnection.cpp
+++ b/src/dbus/qdbusconnection.cpp
@@ -228,6 +228,11 @@ void QDBusConnectionManager::setConnection(const QString &name, QDBusConnectionP
\value ExportAllInvokables export all of this object's invokables
\value ExportAllContents export all of this object's contents
\value ExportChildObjects export this object's child objects
+
+ \value ExportScriptableInvokables export this object's scriptable methods
+ \value ExportNonScriptableInvokables export this object's non-scriptable methods
+ \value ExportAllInvokables export all of this object's methods
+
\sa registerObject(), QDBusAbstractAdaptor, {usingadaptors.html}{Using adaptors}
*/
diff --git a/src/declarative/qml/qdeclarativeimageprovider.cpp b/src/declarative/qml/qdeclarativeimageprovider.cpp
index 241df87..4743a1b 100644
--- a/src/declarative/qml/qdeclarativeimageprovider.cpp
+++ b/src/declarative/qml/qdeclarativeimageprovider.cpp
@@ -59,13 +59,13 @@ public:
\list
\o Loaded using QPixmaps rather than actual image files
- \o Loaded asynchronously in a separate thread, if imageType() is \l ImageType::Image
+ \o Loaded asynchronously in a separate thread, if imageType() is \l{QDeclarativeImageProvider::ImageType}{ImageType::Image}
\endlist
To specify that an image should be loaded by an image provider, use the
\bold {"image:"} scheme for the URL source of the image, followed by the
identifiers of the image provider and the requested image. For example:
-
+
\qml
Image { source: "image://myimageprovider/image.png" }
\endqml
@@ -83,7 +83,7 @@ public:
and "red", respectively:
\snippet examples/declarative/cppextensions/imageprovider/imageprovider-example.qml 0
-
+
When these images are loaded by QML, it looks for a matching image provider
and calls its requestImage() or requestPixmap() method (depending on its
imageType()) to load the image. The method is called with the \c id
@@ -136,7 +136,7 @@ public:
main thread. In this case, if \l {Image::}{asynchronous} is set to
\c true, the value is ignored and the image is loaded
synchronously.
-
+
\sa QDeclarativeEngine::addImageProvider()
*/
diff --git a/src/declarative/util/qdeclarativeanimation.cpp b/src/declarative/util/qdeclarativeanimation.cpp
index 14028de..927f081 100644
--- a/src/declarative/util/qdeclarativeanimation.cpp
+++ b/src/declarative/util/qdeclarativeanimation.cpp
@@ -1329,7 +1329,7 @@ void QDeclarativeVector3dAnimation::setTo(QVector3D t)
\snippet doc/src/snippets/declarative/rotationanimation.qml 0
- Notice the RotationAnimation did not need to set a \l {PropertyAnimation::}{target}
+ Notice the RotationAnimation did not need to set a \l target
value. As a convenience, when used in a transition, RotationAnimation will rotate all
properties named "rotation" or "angle". You can override this by providing
your own properties via \l {PropertyAnimation::properties}{properties} or
diff --git a/src/declarative/util/qdeclarativetransition.cpp b/src/declarative/util/qdeclarativetransition.cpp
index 7042d0c..aa1426c 100644
--- a/src/declarative/util/qdeclarativetransition.cpp
+++ b/src/declarative/util/qdeclarativetransition.cpp
@@ -63,7 +63,7 @@ QT_BEGIN_NAMESPACE
to (50, 50). The added Transition specifies that when the rectangle
changes between the default and the "moved" state, any changes
to the \c x and \c y properties should be animated, using an \c Easing.InOutQuad.
-
+
\snippet doc/src/snippets/declarative/transition.qml 0
Notice the example does not require \l{PropertyAnimation::}{to} and
diff --git a/src/gui/graphicsview/qgraphicsitem.cpp b/src/gui/graphicsview/qgraphicsitem.cpp
index 6f0b48c..b70c0f2 100644
--- a/src/gui/graphicsview/qgraphicsitem.cpp
+++ b/src/gui/graphicsview/qgraphicsitem.cpp
@@ -7961,6 +7961,24 @@ void QGraphicsItemPrivate::resetHeight()
*/
/*!
+ \property QGraphicsObject::children
+ \since 4.7
+ \internal
+*/
+
+/*!
+ \property QGraphicsObject::width
+ \since 4.7
+ \internal
+*/
+
+/*!
+ \property QGraphicsObject::height
+ \since 4.7
+ \internal
+*/
+
+/*!
\class QAbstractGraphicsShapeItem
\brief The QAbstractGraphicsShapeItem class provides a common base for
all path items.
diff --git a/src/gui/graphicsview/qgraphicstransform.cpp b/src/gui/graphicsview/qgraphicstransform.cpp
index 7b69317..bd3f2ef 100644
--- a/src/gui/graphicsview/qgraphicstransform.cpp
+++ b/src/gui/graphicsview/qgraphicstransform.cpp
@@ -583,6 +583,27 @@ void QGraphicsRotation::applyTo(QMatrix4x4 *matrix) const
\sa QGraphicsRotation::axis
*/
+/*!
+ \fn QGraphicsScale::xScaleChanged()
+ \since 4.7
+
+ This signal is emitted whenever the \l xScale property changes.
+*/
+
+/*!
+ \fn QGraphicsScale::yScaleChanged()
+ \since 4.7
+
+ This signal is emitted whenever the \l yScale property changes.
+*/
+
+/*!
+ \fn QGraphicsScale::zScaleChanged()
+ \since 4.7
+
+ This signal is emitted whenever the \l zScale property changes.
+*/
+
#include "moc_qgraphicstransform.cpp"
QT_END_NAMESPACE
diff --git a/src/gui/s60framework/qs60mainapplication.cpp b/src/gui/s60framework/qs60mainapplication.cpp
index 5d4c54e..cbc0d5c 100644
--- a/src/gui/s60framework/qs60mainapplication.cpp
+++ b/src/gui/s60framework/qs60mainapplication.cpp
@@ -145,7 +145,7 @@ void QS60MainApplication::PreDocConstructL()
}
/*!
- \internal
+ \internal
*/
CDictionaryStore *QS60MainApplication::OpenIniFileLC(RFs &aFs) const
{
@@ -153,7 +153,7 @@ CDictionaryStore *QS60MainApplication::OpenIniFileLC(RFs &aFs) const
}
/*!
- \internal
+ \internal
*/
void QS60MainApplication::NewAppServerL(CApaAppServer *&aAppServer)
{
diff --git a/src/gui/s60framework/qs60mainappui.cpp b/src/gui/s60framework/qs60mainappui.cpp
index ea9dbb3..72cf577 100644
--- a/src/gui/s60framework/qs60mainappui.cpp
+++ b/src/gui/s60framework/qs60mainappui.cpp
@@ -282,7 +282,7 @@ void QS60MainAppUi::RestoreMenuL(CCoeControl *menuWindow, TInt resourceId, TMenu
}
/*!
- \internal
+ \internal
*/
void QS60MainAppUi::Exit()
{
@@ -290,7 +290,7 @@ void QS60MainAppUi::Exit()
}
/*!
- \internal
+ \internal
*/
void QS60MainAppUi::SetFadedL(TBool aFaded)
{
@@ -298,7 +298,7 @@ void QS60MainAppUi::SetFadedL(TBool aFaded)
}
/*!
- \internal
+ \internal
*/
TRect QS60MainAppUi::ApplicationRect() const
{
@@ -306,7 +306,7 @@ TRect QS60MainAppUi::ApplicationRect() const
}
/*!
- \internal
+ \internal
*/
void QS60MainAppUi::HandleScreenDeviceChangedL()
{
@@ -314,7 +314,7 @@ void QS60MainAppUi::HandleScreenDeviceChangedL()
}
/*!
- \internal
+ \internal
*/
void QS60MainAppUi::HandleApplicationSpecificEventL(TInt aType, const TWsEvent &aEvent)
{
@@ -322,7 +322,7 @@ void QS60MainAppUi::HandleApplicationSpecificEventL(TInt aType, const TWsEvent &
}
/*!
- \internal
+ \internal
*/
TTypeUid::Ptr QS60MainAppUi::MopSupplyObject(TTypeUid aId)
{
@@ -330,7 +330,7 @@ TTypeUid::Ptr QS60MainAppUi::MopSupplyObject(TTypeUid aId)
}
/*!
- \internal
+ \internal
*/
void QS60MainAppUi::ProcessCommandL(TInt aCommand)
{
@@ -338,7 +338,7 @@ void QS60MainAppUi::ProcessCommandL(TInt aCommand)
}
/*!
- \internal
+ \internal
*/
TErrorHandlerResponse QS60MainAppUi::HandleError (TInt aError, const SExtendedError &aExtErr, TDes &aErrorText, TDes &aContextText)
{
@@ -346,7 +346,7 @@ TErrorHandlerResponse QS60MainAppUi::HandleError (TInt aError, const SExtendedEr
}
/*!
- \internal
+ \internal
*/
void QS60MainAppUi::HandleViewDeactivation(const TVwsViewId &aViewIdToBeDeactivated, const TVwsViewId &aNewlyActivatedViewId)
{
@@ -354,7 +354,7 @@ void QS60MainAppUi::HandleViewDeactivation(const TVwsViewId &aViewIdToBeDeactiva
}
/*!
- \internal
+ \internal
*/
void QS60MainAppUi::PrepareToExit()
{
@@ -362,7 +362,7 @@ void QS60MainAppUi::PrepareToExit()
}
/*!
- \internal
+ \internal
*/
void QS60MainAppUi::HandleTouchPaneSizeChange()
{
@@ -370,7 +370,7 @@ void QS60MainAppUi::HandleTouchPaneSizeChange()
}
/*!
- \internal
+ \internal
*/
void QS60MainAppUi::HandleSystemEventL(const TWsEvent &aEvent)
{
@@ -378,7 +378,7 @@ void QS60MainAppUi::HandleSystemEventL(const TWsEvent &aEvent)
}
/*!
- \internal
+ \internal
*/
void QS60MainAppUi::Reserved_MtsmPosition()
{
@@ -386,7 +386,7 @@ void QS60MainAppUi::Reserved_MtsmPosition()
}
/*!
- \internal
+ \internal
*/
void QS60MainAppUi::Reserved_MtsmObject()
{
@@ -394,7 +394,7 @@ void QS60MainAppUi::Reserved_MtsmObject()
}
/*!
- \internal
+ \internal
*/
void QS60MainAppUi::HandleForegroundEventL(TBool aForeground)
{
diff --git a/src/network/access/qnetworkrequest.cpp b/src/network/access/qnetworkrequest.cpp
index 911eadc..8710cb6 100644
--- a/src/network/access/qnetworkrequest.cpp
+++ b/src/network/access/qnetworkrequest.cpp
@@ -174,12 +174,12 @@ QT_BEGIN_NAMESPACE
When using this flag with sequential upload data, the ContentLengthHeader
header must be set.
- \value HttpPipeliningAllowedAttribute
+ \value HttpPipeliningAllowedAttribute
Requests only, type: QVariant::Bool (default: false)
Indicates whether the QNetworkAccessManager code is
allowed to use HTTP pipelining with this request.
- \value HttpPipeliningWasUsedAttribute
+ \value HttpPipeliningWasUsedAttribute
Replies only, type: QVariant::Bool
Indicates whether the HTTP pipelining was used for receiving
this reply.
@@ -200,9 +200,9 @@ QT_BEGIN_NAMESPACE
See http://www.w3.org/TR/XMLHttpRequest2/#credentials-flag for more information.
- \since 4.7
+ (This value was introduced in 4.7.)
- \value CookieSaveControlAttribute
+ \value CookieSaveControlAttribute
Requests only, type: QVariant::Int (default: QNetworkRequest::Automatic)
Indicates whether to save 'Cookie' headers received from the server in reply
to the request.
@@ -213,9 +213,9 @@ QT_BEGIN_NAMESPACE
See http://www.w3.org/TR/XMLHttpRequest2/#credentials-flag for more information.
- \since 4.7
+ (This value was introduced in 4.7.)
- \value AuthenticationReuseControlAttribute
+ \value AuthenticationReuseAttribute
Requests only, type: QVariant::Int (default: QNetworkRequest::Automatic)
Indicates whether to use cached authorization credentials in the request,
if available. If this is set to QNetworkRequest::Manual and the authentication
@@ -228,7 +228,13 @@ QT_BEGIN_NAMESPACE
See http://www.w3.org/TR/XMLHttpRequest2/#credentials-flag for more information.
- \since 4.7
+ (This value was introduced in 4.7.)
+
+ \omitvalue MaximumDownloadBufferSizeAttribute
+ (This value was introduced in 4.7.)
+
+ \omitvalue DownloadBufferAttribute
+ (This value was introduced in 4.7.)
\value User
Special type. Additional information can be passed in
diff --git a/tools/qdoc3/test/qt-html-templates.qdocconf b/tools/qdoc3/test/qt-html-templates.qdocconf
index e439708..cda1786 100644
--- a/tools/qdoc3/test/qt-html-templates.qdocconf
+++ b/tools/qdoc3/test/qt-html-templates.qdocconf
@@ -4,9 +4,6 @@ HTML.stylesheets = style/style.css \
style/style_ie8.css \
style/style_ie6.css
-HTML.creatorpostheader = "**\n"
-HTML.creatorpostpostheader = "***\n"
-
HTML.postheader = " <div class=\"header\" id=\"qtdocheader\">\n" \
" <div class=\"content\"> \n" \
" <div id=\"nav-logo\">\n" \
@@ -48,7 +45,7 @@ HTML.postheader = " <div class=\"header\" id=\"qtdocheader\">\n" \
" <li><a href=\"#\">Qt Topics</a> \n" \
" <ul id=\"topmenuTopic\"> \n" \
" <li><a href=\"qt-basic-concepts.html\">Basic Qt architecture</a></li> \n" \
- " <li><a href=\"declarativeui.html\">Device UI's & Qt Quick</a></li> \n" \
+ " <li><a href=\"qtquick.html\">Device UI's & Qt Quick</a></li> \n" \
" <li><a href=\"qt-gui-concepts.html\">Desktop UI components</a></li> \n" \
" <li><a href=\"platform-specific.html\">Platform-specific info</a></li> \n" \
" <li><a href=\"best-practices.html\">How-To's and Best Practices</a></li> \n" \
@@ -100,7 +97,7 @@ HTML.postheader = " <div class=\"header\" id=\"qtdocheader\">\n" \
" <div id=\"list002\" class=\"list\">\n" \
" <ul id=\"ul002\" >\n" \
" <li class=\"defaultLink\"><a href=\"qt-basic-concepts.html\">Basic Qt architecture</a></li>\n" \
- " <li class=\"defaultLink\"><a href=\"declarativeui.html\">Device UI's & Qt Quick</a></li>\n" \
+ " <li class=\"defaultLink\"><a href=\"qtquick.html\">Device UI's & Qt Quick</a></li>\n" \
" <li class=\"defaultLink\"><a href=\"qt-gui-concepts.html\">Desktop UI components</a></li>\n" \
" <li class=\"defaultLink\"><a href=\"platform-specific.html\">Platform-specific info</a></li>\n" \
" </ul> \n" \
--
cgit v0.12