summaryrefslogtreecommitdiffstats
path: root/examples/doc/openreadme.qdoc
diff options
context:
space:
mode:
authorLeena Miettinen <riitta-leena.miettinen@digia.com>2014-07-08 12:01:03 +0200
committerLeena Miettinen <riitta-leena.miettinen@digia.com>2014-07-09 15:53:37 +0200
commit255cc2c1a353e843aa95ee5a00e6136b949e76b0 (patch)
tree253cd3147f593accda155eb5111d926085e3f911 /examples/doc/openreadme.qdoc
parentdaea2525a9bc5f0d802b5637a47710c10bd72375 (diff)
Doc: add example documentation
Add initial topic skeletons. The contents will be modified in subsequent patches. Change-Id: I33ca4180c7070d5ae2ca20a59f75608289d76344 Reviewed-by: Jerome Pasion <jerome.pasion@digia.com>
Diffstat (limited to 'examples/doc/openreadme.qdoc')
-rw-r--r--examples/doc/openreadme.qdoc41
1 files changed, 41 insertions, 0 deletions
diff --git a/examples/doc/openreadme.qdoc b/examples/doc/openreadme.qdoc
new file mode 100644
index 000000000..165caf4e2
--- /dev/null
+++ b/examples/doc/openreadme.qdoc
@@ -0,0 +1,41 @@
+/****************************************************************************
+**
+** Copyright (C) 2014 Digia Plc and/or its subsidiary(-ies).
+** Contact: http://www.qt-project.org/legal
+**
+** This file is part of the Qt Installer Framework.
+**
+** $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 Digia. For licensing terms and
+** conditions see http://qt.digia.com/licensing. For further information
+** use the contact form at http://qt.digia.com/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 openreadme
+ \ingroup qtifwexamples
+ \title Open ReadMe Example
+
+ \brief Adding a check box for opening the readme file to the final
+ installer page.
+
+ \include installerfw-examples-configuring.qdocinc
+
+ \quotefile openreadme/config/config.xml
+
+ \include installerfw-examples-generating.qdocinc
+*/