summaryrefslogtreecommitdiffstats
path: root/examples/oauth/redditclient/doc/src/qtnetworkauth-redditclient.qdoc
blob: 92ca6fbeea6e2eed0c105d09016ded570e7b314a (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
/****************************************************************************
**
** Copyright (C) 2017 The Qt Company Ltd.
** Contact: https://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 https://www.qt.io/terms-conditions. For further
** information use the contact form at https://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: https://www.gnu.org/licenses/fdl-1.3.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
*/