From 303db2e8a19ea1f2c1b8d5dc59e2754b0d03bd61 Mon Sep 17 00:00:00 2001 From: Sze Howe Koh Date: Fri, 14 Mar 2014 23:41:01 +0800 Subject: Doc: Document signals (not handlers) under \qmlsignal Append the handler names to the end of the corresponding signal doc. Task-number: QTBUG-35846 Change-Id: I3d627ba7ed5be94e5c402ab092b4d582536499e8 Reviewed-by: Jerome Pasion --- src/quick/items/qquickrepeater.cpp | 14 +++++++++----- 1 file changed, 9 insertions(+), 5 deletions(-) (limited to 'src/quick/items/qquickrepeater.cpp') diff --git a/src/quick/items/qquickrepeater.cpp b/src/quick/items/qquickrepeater.cpp index 072bfab73c..e226d7ba49 100644 --- a/src/quick/items/qquickrepeater.cpp +++ b/src/quick/items/qquickrepeater.cpp @@ -131,22 +131,26 @@ QQuickRepeaterPrivate::~QQuickRepeaterPrivate() */ /*! - \qmlsignal QtQuick::Repeater::onItemAdded(int index, Item item) + \qmlsignal QtQuick::Repeater::itemAdded(int index, Item item) - This handler is called when an item is added to the repeater. The \a index + This signal is emitted when an item is added to the repeater. The \a index parameter holds the index at which the item has been inserted within the repeater, and the \a item parameter holds the \l Item that has been added. + + The corresponding handler is \c onItemAdded. */ /*! - \qmlsignal QtQuick::Repeater::onItemRemoved(int index, Item item) + \qmlsignal QtQuick::Repeater::itemRemoved(int index, Item item) - This handler is called when an item is removed from the repeater. The \a index + This signal is emitted when an item is removed from the repeater. The \a index parameter holds the index at which the item was removed from the repeater, and the \a item parameter holds the \l Item that was removed. Do not keep a reference to \a item if it was created by this repeater, as - in these cases it will be deleted shortly after the handler is called. + in these cases it will be deleted shortly after the signal is handled. + + The corresponding handler is \c onItemRemoved. */ QQuickRepeater::QQuickRepeater(QQuickItem *parent) : QQuickItem(*(new QQuickRepeaterPrivate), parent) -- cgit v1.2.3