AuroraMiddleware/qt5base-lts
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

QDoc: Doc: Use correct terminology ("signal" vs. "signal handler")

Browse Source 
Change-Id: I0c6cdc77296b8a1a759671bac2c920bc05d0cbcb
Reviewed-by: Jerome Pasion <jerome.pasion@digia.com>
This commit is contained in:
Sze Howe Koh 2014-03-19 22:37:57 +08:00 committed by The Qt Project
parent 12bd35aa24
commit cd08d34452
1 changed files with 9 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

21
src/tools/qdoc/doc/qdoc-manual-topiccmds.qdoc
View File

@ -1113,27 +1113,24 @@
\section1 \\qmlattachedsignal
The \\qmlattachedsignal command is for documenting an attachable
\l{http://qt-project.org/doc/qt-4.7/qdeclarativeintroduction.html#signal-handlers}
{signal handler}. The \\qmlattachedsignal command is used just like
the \l{qmlsignal-command} {\\qmlsignal} command.
\l{Signal and Handler Event System}{signal}. The \\qmlattachedsignal
command is used just like the \l{qmlsignal-command} {\\qmlsignal} command.
The argument is the rest of the line. It should be the name of the
QML type where the signal handler is declared, the \c{::}
qualifier, and finally the signal handler name. If we have a QML
attached signal handler named \c onAdd() in the \c GridView
element, the \\qmlattachedsignal for it would look like this:
QML type where the signal is declared, the \c{::}
qualifier, and finally the signal name. For example, a QML
attached signal named \c add() in the \c GridView
element is documented like this:
\code
/ *!
\qmlattachedsignal GridView::onAdd()
This attached handler is called immediately after an item is
added to the view.
\qmlattachedsignal GridView::add()
This attached signal is emitted immediately after an item is added to the view.
* /
\endcode
QDoc includes this documentation on the QML reference page for the
\l{http://qt-project.org/doc/qt-4.7/qml-gridview.html#onAdd-signal}
{GridView} element.
\l GridView element.
\target qmlbasictype-command
\section1 \\qmlbasictype