summaryrefslogtreecommitdiffstats
path: root/examples
diff options
context:
space:
mode:
authorNico Vertriest <nico.vertriest@digia.com>2013-12-04 13:49:00 +0100
committerThe Qt Project <gerrit-noreply@qt-project.org>2013-12-05 14:56:29 +0100
commiteaff48d3622bbb0e18e79f79aac6d1ac1b7e2760 (patch)
tree0152de17b47a529b3303ffa17e2e29fefea2d0e6 /examples
parent998e6386f04e97b08bad8db6f0cfc8c9c9055786 (diff)
Doc: Moved Books SQL Example documentation
Moved qdoc and image file to correct qdoc folder. Added brief and ingroup statements to books.qdoc. Task-number: QTBUG-34749 Change-Id: I5806ffd6f116cccf10238e3e1a9fc627ad0e93a9 Reviewed-by: Topi Reiniƶ <topi.reinio@digia.com>
Diffstat (limited to 'examples')
-rw-r--r--examples/sql/doc/images/books-demo.pngbin0 -> 29155 bytes
-rw-r--r--examples/sql/doc/src/books.qdoc48
2 files changed, 48 insertions, 0 deletions
diff --git a/examples/sql/doc/images/books-demo.png b/examples/sql/doc/images/books-demo.png
new file mode 100644
index 0000000000..5bcc20b478
--- /dev/null
+++ b/examples/sql/doc/images/books-demo.png
Binary files differ
diff --git a/examples/sql/doc/src/books.qdoc b/examples/sql/doc/src/books.qdoc
new file mode 100644
index 0000000000..bfdee4e362
--- /dev/null
+++ b/examples/sql/doc/src/books.qdoc
@@ -0,0 +1,48 @@
+/****************************************************************************
+**
+** Copyright (C) 2013 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.
+**
+** $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 books
+ \title Books
+ \ingroup sql_examples
+ \brief Shows how to use Qt SQL classes with a model/view framework.
+
+ The Books example shows how Qt's SQL classes can be used with the model/view
+ framework to create rich user interfaces for information stored in a database.
+
+ \image books-demo.png
+
+ Information about a collection of books is held in a database. The books are
+ catalogued by author, title, genre, and year of publication. Although each of
+ these fields can be displayed and edited using standard widgets, an additional
+ field describing an arbitrary rating for the book needs something extra.
+
+ Books are rated using a system where each is allocated a number of stars; the
+ more a book has, the better it is supposed to be. By clicking on a cell
+ containing the rating, the number of stars can be modified, and the rating in
+ the database is updated.
+*/