diff options
| author | Jerome Pasion <jerome.pasion@digia.com> | 2014-04-14 15:57:57 +0200 |
|---|---|---|
| committer | The Qt Project <gerrit-noreply@qt-project.org> | 2014-04-16 21:22:06 +0200 |
| commit | fc634cb4a2daed40690f0530dc06ff850f3b73ab (patch) | |
| tree | d7753a5f795193f2405bccc394ea9b85dbdf0c5b /examples/quick/demos/tweetsearch | |
| parent | 1b3a9301fea572f970299f76332d468e366ede5a (diff) | |
Doc: Improved Qt Quick Demos documentation
-added include from qtbase/doc/global about running the example.
-added link to "QML Applications" (main landing page for QML)
-highlighted the names with \e
-various documentation changes
Task-number: QTBUG-33597
Change-Id: I9e23b8b61862c424f2a17003b3d1f5b2ef931ceb
Reviewed-by: Leena Miettinen <riitta-leena.miettinen@digia.com>
Reviewed-by: Sze Howe Koh <szehowe.koh@gmail.com>
Reviewed-by: Topi Reiniö <topi.reinio@digia.com>
Diffstat (limited to 'examples/quick/demos/tweetsearch')
| -rw-r--r-- | examples/quick/demos/tweetsearch/doc/src/tweetsearch.qdoc | 18 |
1 files changed, 9 insertions, 9 deletions
diff --git a/examples/quick/demos/tweetsearch/doc/src/tweetsearch.qdoc b/examples/quick/demos/tweetsearch/doc/src/tweetsearch.qdoc index a56ed0d7e9..41c6c09dea 100644 --- a/examples/quick/demos/tweetsearch/doc/src/tweetsearch.qdoc +++ b/examples/quick/demos/tweetsearch/doc/src/tweetsearch.qdoc @@ -1,6 +1,6 @@ /**************************************************************************** ** -** Copyright (C) 2013 Digia Plc and/or its subsidiary(-ies). +** Copyright (C) 2014 Digia Plc and/or its subsidiary(-ies). ** Contact: http://www.qt-project.org/legal ** ** This file is part of the documentation of the Qt Toolkit. @@ -33,22 +33,20 @@ \image qtquick-demo-tweetsearch-med-1.png \image qtquick-demo-tweetsearch-med-2.png - \section1 Demo Introduction - - The Tweet Search demo searches items posted to Twitter service - using a number of query parameters. Search can be done for tweets - from a specified user, a hashtag or a search phrase. + \e{Tweet Search} is a QML application that searches items posted to Twitter + service using a number of query parameters. Search can be done for tweets + from a specified user, a hashtag, or a search phrase. The search result is a list of items showing the contents of the tweet as well as the name and image of the user who posted it. Hashtags, names and links in the content are clickable. Clicking on the image will flip the item to reveal more information. - \section1 Running the Demo + \include examples-run.qdocinc Tweet Search uses Twitter API v1.1 for running seaches. - \section2 Authentication + \section1 Request Authentication Each request must be authenticated on behalf of the application. For demonstration purposes, the application uses a hard-coded @@ -67,7 +65,7 @@ Rebuild and run the demo. - \section2 JSON Parsing + \section1 JSON Parsing Search results are returned in JSON (JavaScript Object Notation) format. \c TweetsModel uses an \l XMLHTTPRequest object to send @@ -76,4 +74,6 @@ representing a tweet is then added to a \l ListModel: \snippet demos/tweetsearch/content/TweetsModel.qml requesting + + \sa {QML Applications} */ |