summaryrefslogtreecommitdiffstats
path: root/src/declarative
diff options
context:
space:
mode:
authorMartin Smith <msmith@trolltech.com>2009-04-30 11:33:23 (GMT)
committerMartin Smith <msmith@trolltech.com>2009-04-30 11:33:23 (GMT)
commite2f9eb037dfd26e02cad8a31a499a9c92a315d8b (patch)
tree2a4f69656d8f7624dcbf79b420af6868f81bb843 /src/declarative
parent488d2f6012c13291d2a8fe7907c332e2ab1b1b15 (diff)
downloadQt-e2f9eb037dfd26e02cad8a31a499a9c92a315d8b.zip
Qt-e2f9eb037dfd26e02cad8a31a499a9c92a315d8b.tar.gz
Qt-e2f9eb037dfd26e02cad8a31a499a9c92a315d8b.tar.bz2
qdoc: Corrected some qdoc warnings.
Diffstat (limited to 'src/declarative')
-rw-r--r--src/declarative/fx/qfximage.cpp2
-rw-r--r--src/declarative/fx/qfxtextedit.cpp5
-rw-r--r--src/declarative/timeline/qmltimeline.cpp2
-rw-r--r--src/declarative/util/qfxview.cpp64
-rw-r--r--src/declarative/util/qmlscript.cpp2
5 files changed, 64 insertions, 11 deletions
diff --git a/src/declarative/fx/qfximage.cpp b/src/declarative/fx/qfximage.cpp
index a34cd12..9eb8277 100644
--- a/src/declarative/fx/qfximage.cpp
+++ b/src/declarative/fx/qfximage.cpp
@@ -812,7 +812,7 @@ QFxImage::Status QFxImage::status() const
*/
/*!
- \property QFxImage::src
+ \property QFxImage::source
\brief the url of the image to be displayed in this item.
The content specified can be of any image type loadable by QImage. Alternatively,
diff --git a/src/declarative/fx/qfxtextedit.cpp b/src/declarative/fx/qfxtextedit.cpp
index 68aea01..807fcbf 100644
--- a/src/declarative/fx/qfxtextedit.cpp
+++ b/src/declarative/fx/qfxtextedit.cpp
@@ -63,16 +63,15 @@ QML_DEFINE_TYPE(QFxTextEdit, TextEdit);
/*!
\qmlclass TextEdit
\brief The TextEdit element allows you to add editable formatted text to a scene.
- \inherits ImageItem
It can display both plain and rich text. For example:
- \code
+ \qml
<TextEdit id="edit" focus="true" focusable="true"
font.family="Helvetica" font.size="20" color="blue" width="240">
<![CDATA[<b>Hello</b> <i>World!</i>]]/>
</TextEdit>
- \endcode
+ \endqml
\image declarative-textedit.gif
diff --git a/src/declarative/timeline/qmltimeline.cpp b/src/declarative/timeline/qmltimeline.cpp
index b9f79ac..3fa0161 100644
--- a/src/declarative/timeline/qmltimeline.cpp
+++ b/src/declarative/timeline/qmltimeline.cpp
@@ -561,7 +561,7 @@ void QmlTimeLine::sync(QmlTimeLineValue &timeLineValue)
}
}
-/*!
+/*
Synchronize all currently and future scheduled values in this timeline to
the longest action currently scheduled.
diff --git a/src/declarative/util/qfxview.cpp b/src/declarative/util/qfxview.cpp
index 5611bca..aefe3e4 100644
--- a/src/declarative/util/qfxview.cpp
+++ b/src/declarative/util/qfxview.cpp
@@ -145,7 +145,7 @@ QFxView::QFxView(QWidget *parent)
/*!
\fn QFxView::QFxView(QSimpleCanvas::CanvasMode mode, QWidget *parent)
-
+ \internal
Constructs a QFxView with the given \a parent. The canvas
\a mode can be QSimpleCanvas::GraphicsView or
QSimpleCanvas::SimpleCanvas.
@@ -173,8 +173,8 @@ void QFxViewPrivate::init()
}
/*!
- The destructor clears the instance and deletes the internal
- representation.
+ The destructor clears the view's \l {QFxItem} {items} and
+ deletes the internal representation.
\sa clearItems()
*/
@@ -213,18 +213,29 @@ QString QFxView::xml() const
}
/*!
- Returns a pointer to the QmlEngine.
+ Returns a pointer to the QmlEngine used for instantiating
+ QML Components.
*/
QmlEngine* QFxView::engine()
{
return &d->engine;
}
+/*!
+ This function returns the root of the context hierarchy. Each QML
+ component is instantiated in a QmlContext. QmlContext's are
+ essential for passing data to QML components. In QML, contexts are
+ arranged hierarchically and this hierarchy is managed by the
+ QmlEngine.
+ */
QmlContext* QFxView::rootContext()
{
return d->engine.rootContext();
}
+/*!
+ Displays the Qt Declarative user interface.
+*/
void QFxView::execute()
{
rootContext()->activate();
@@ -242,6 +253,9 @@ void QFxView::execute()
}
}
+/*!
+ \internal
+ */
void QFxView::continueExecute()
{
disconnect(d->component, SIGNAL(statusChanged(QmlComponent::Status)), this, SLOT(continueExecute()));
@@ -283,12 +297,23 @@ void QFxView::continueExecute()
}
}
+/*! \fn void QFxView::sceneResized(QSize size)
+ This signal is emitted when the view is resized.
+ */
+
+/*!
+ \internal
+ */
void QFxView::sizeChanged()
{
// delay, so we catch both width and height changing.
d->resizetimer.start(0,this);
}
+/*!
+ If the \l {QTimerEvent} {timer event} \a e is this
+ view's resize timer, sceneResized() is emitted.
+ */
void QFxView::timerEvent(QTimerEvent* e)
{
if (e->timerId() == d->resizetimer.timerId()) {
@@ -298,6 +323,12 @@ void QFxView::timerEvent(QTimerEvent* e)
}
}
+/*!
+ Creates a \l{QmlComponent} {component} from the \a xml
+ string, and returns it as an \l {QFxItem} {item}. If the
+ \a parent item is provided, it becomes the new item's
+ parent. \a parent should be in this view's item hierarchy.
+ */
QFxItem* QFxView::addItem(const QString &xml, QFxItem* parent)
{
if (!d->root)
@@ -316,12 +347,19 @@ QFxItem* QFxView::addItem(const QString &xml, QFxItem* parent)
return 0;
}
+/*!
+ Deletes the view's \l {QFxItem} {items} and the \l {QmlEngine}
+ {QML engine's} Component cache.
+ */
void QFxView::reset()
{
clearItems();
d->engine.clearComponentCache();
}
+/*!
+ Deletes the view's \l {QFxItem} {items}.
+ */
void QFxView::clearItems()
{
if (!d->root)
@@ -330,11 +368,18 @@ void QFxView::clearItems()
d->root = 0;
}
+/*!
+ Returns the view's root \l {QFxItem} {item}.
+ */
QFxItem *QFxView::root() const
{
return d->root;
}
+/*!
+ This function handles the \l {QResizeEvent} {resize event}
+ \a e.
+ */
void QFxView::resizeEvent(QResizeEvent *e)
{
if (d->root) {
@@ -344,17 +389,26 @@ void QFxView::resizeEvent(QResizeEvent *e)
QSimpleCanvas::resizeEvent(e);
}
+/*! \fn void QFxView::focusInEvent(QFocusEvent *e)
+ This virtual function does nothing in this class.
+ */
void QFxView::focusInEvent(QFocusEvent *)
{
// Do nothing (do not call QWidget::update())
}
+
+/*! \fn void QFxView::focusOutEvent(QFocusEvent *e)
+ This virtual function does nothing in this class.
+ */
void QFxView::focusOutEvent(QFocusEvent *)
{
// Do nothing (do not call QWidget::update())
}
-
+/*!
+ \internal
+ */
void QFxView::dumpRoot()
{
root()->dump();
diff --git a/src/declarative/util/qmlscript.cpp b/src/declarative/util/qmlscript.cpp
index fbaf56e..757ae09 100644
--- a/src/declarative/util/qmlscript.cpp
+++ b/src/declarative/util/qmlscript.cpp
@@ -136,7 +136,7 @@ void QmlScript::setScript(const QString &script)
the file specified.
*/
/*!
- \property QmlScript::src
+ \property QmlScript::source
\brief the path to a script file.
*/
QString QmlScript::source() const