Reddit Client Example

Basic Reddit client which shows the user posts in a QListView.

Change-Id: I16c23bac2d7dc709c6223f6c6cf22a63e057a545
Reviewed-by: Edward Welbourne <edward.welbourne@qt.io>

1 files changed, 44 insertions, 0 deletions

diff --git a/examples/oauth/redditclient/doc/src/qtnetworkauth-redditclient.qdoc b/examples/oauth/redditclient/doc/src/qtnetworkauth-redditclient.qdoc
new file mode 100644
index 0000000..773f2db
--- /dev/null
+++ b/examples/oauth/redditclient/doc/src/qtnetworkauth-redditclient.qdoc
@@ -0,0 +1,44 @@
+/****************************************************************************
+**
+** Copyright (C) 2016 The Qt Company Ltd.
+** Contact: http://www.qt.io/licensing/
+**
+** This file is part of the documentation of the Qt Toolkit.
+**
+** $QT_BEGIN_LICENSE:FDL$
+** Commercial License Usage
+** Licensees holding valid commercial Qt licenses may use this file in
+** accordance with the commercial license agreement provided with the
+** Software or, alternatively, in accordance with the terms contained in
+** a written agreement between you and The Qt Company. For licensing terms
+** and conditions see http://www.qt.io/terms-conditions. For further
+** information use the contact form at http://www.qt.io/contact-us.
+**
+** GNU Free Documentation License Usage
+** Alternatively, this file may be used under the terms of the GNU Free
+** Documentation License version 1.3 as published by the Free Software
+** Foundation and appearing in the file included in the packaging of
+** this file. Please review the following information to ensure
+** the GNU Free Documentation License version 1.3 requirements
+** will be met: http://www.gnu.org/copyleft/fdl.html.
+** $QT_END_LICENSE$
+**
+****************************************************************************/
+
+/*!
+    \example redditclient
+    \title Reddit Example
+    \ingroup examples-qtnetworkauth
+    \brief Demonstrates authenticating with OAuth 2 to access Reddit.
+
+    \image redditclient-example.png Screenshot of the example
+
+    The \e {Reddit} example uses OAuth 2, as supported by
+    \l {Qt Network Authorization}, to sign in to Reddit and display the
+    Reddit posts (in text format) associated with the authenticated user.
+
+    To use this example, a consumer key from Reddit is needed.
+    To register the application visit https://www.reddit.com/prefs/apps/.
+
+    \include examples-run.qdocinc
+*/