From eaff48d3622bbb0e18e79f79aac6d1ac1b7e2760 Mon Sep 17 00:00:00 2001 From: Nico Vertriest Date: Wed, 4 Dec 2013 13:49:00 +0100 Subject: Doc: Moved Books SQL Example documentation MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit 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ƶ --- doc/src/examples/books.qdoc | 46 ------------------------------- doc/src/images/books-demo.png | Bin 29155 -> 0 bytes examples/sql/doc/images/books-demo.png | Bin 0 -> 29155 bytes examples/sql/doc/src/books.qdoc | 48 +++++++++++++++++++++++++++++++++ 4 files changed, 48 insertions(+), 46 deletions(-) delete mode 100644 doc/src/examples/books.qdoc delete mode 100644 doc/src/images/books-demo.png create mode 100644 examples/sql/doc/images/books-demo.png create mode 100644 examples/sql/doc/src/books.qdoc diff --git a/doc/src/examples/books.qdoc b/doc/src/examples/books.qdoc deleted file mode 100644 index c56dcdc4ef..0000000000 --- a/doc/src/examples/books.qdoc +++ /dev/null @@ -1,46 +0,0 @@ -/**************************************************************************** -** -** 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 - - 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. -*/ diff --git a/doc/src/images/books-demo.png b/doc/src/images/books-demo.png deleted file mode 100644 index 5bcc20b478..0000000000 Binary files a/doc/src/images/books-demo.png and /dev/null differ 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 Binary files /dev/null and b/examples/sql/doc/images/books-demo.png 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. +*/ -- cgit v1.2.3