diff options
author | Tor Arne Vestbø <tor.arne.vestbo@digia.com> | 2012-10-12 14:06:53 +0200 |
---|---|---|
committer | Frederik Gladhorn <frederik.gladhorn@digia.com> | 2012-10-12 15:06:30 +0200 |
commit | 6234dadf09af4fc7f58b7707a436a08f8ab0318c (patch) | |
tree | 5e6f5d7c49f86166e132cebfd53cf9a77f6eba7d | |
parent | 9f657424aafbcbde82bb39673a6f028d106ccda6 (diff) |
doc: Fix a few doc errors for QtSQL
The examples include path already contains 'sql', so we can't prefix the
includes with 'sql' as well. Changing the include path to also include
the parent examples directory is not an option, as qdoc will then try to
generate output for example single example.
Change-Id: Ifae07af86e60e6105a0625f29fbd6bc8f73b2550
Reviewed-by: Martin Smith <martin.smith@digia.com>
Reviewed-by: Frederik Gladhorn <frederik.gladhorn@digia.com>
-rw-r--r-- | src/sql/doc/qtsql.qdocconf | 2 | ||||
-rw-r--r-- | src/sql/doc/src/sql-programming.qdoc | 22 | ||||
-rw-r--r-- | src/sql/models/qsqlquerymodel.cpp | 2 | ||||
-rw-r--r-- | src/sql/models/qsqlrelationaldelegate.cpp | 4 | ||||
-rw-r--r-- | src/sql/models/qsqlrelationaltablemodel.cpp | 14 | ||||
-rw-r--r-- | src/sql/models/qsqltablemodel.cpp | 2 |
6 files changed, 23 insertions, 23 deletions
diff --git a/src/sql/doc/qtsql.qdocconf b/src/sql/doc/qtsql.qdocconf index 185f5064fa..34a23784bb 100644 --- a/src/sql/doc/qtsql.qdocconf +++ b/src/sql/doc/qtsql.qdocconf @@ -31,7 +31,7 @@ qhp.QtSql.subprojects.examples.selectors = fake:example tagfile = ../../../doc/qtsql/qtsql.tags -depends += qtcore +depends += qtcore qtwidgets headerdirs += .. diff --git a/src/sql/doc/src/sql-programming.qdoc b/src/sql/doc/src/sql-programming.qdoc index 3fe2373a73..aa2eb243b8 100644 --- a/src/sql/doc/src/sql-programming.qdoc +++ b/src/sql/doc/src/sql-programming.qdoc @@ -463,10 +463,10 @@ The following code snippet shows how the QSqlRelationalTableModel was set up: - \snippet sql/relationaltablemodel/relationaltablemodel.cpp 0 + \snippet relationaltablemodel/relationaltablemodel.cpp 0 \codeline - \snippet sql/relationaltablemodel/relationaltablemodel.cpp 1 - \snippet sql/relationaltablemodel/relationaltablemodel.cpp 2 + \snippet relationaltablemodel/relationaltablemodel.cpp 1 + \snippet relationaltablemodel/relationaltablemodel.cpp 2 See the QSqlRelationalTableModel documentation for details. */ @@ -503,7 +503,7 @@ You can use the same model as a data source for multiple views. If the user edits the model through one of the views, the other views will reflect the changes immediately. The - \l{sql/tablemodel}{Table Model} example shows how it works. + \l{tablemodel}{Table Model} example shows how it works. View classes display a header at the top to label the columns. To change the header texts, call @@ -511,7 +511,7 @@ model. The header's labels default to the table's field names. For example: - \snippet sql/relationaltablemodel/relationaltablemodel.cpp 3 + \snippet relationaltablemodel/relationaltablemodel.cpp 3 QTableView also has a vertical header on the left with numbers identifying the rows. If you insert rows programmatically using @@ -545,16 +545,16 @@ read-write. The following two functions make fields 1 and 2 of a query model editable: - \snippet sql/querymodel/editablesqlmodel.cpp 0 + \snippet querymodel/editablesqlmodel.cpp 0 \codeline - \snippet sql/querymodel/editablesqlmodel.cpp 1 + \snippet querymodel/editablesqlmodel.cpp 1 The setFirstName() helper function is defined as follows: - \snippet sql/querymodel/editablesqlmodel.cpp 2 + \snippet querymodel/editablesqlmodel.cpp 2 The setLastName() function is similar. See the - \l{sql/querymodel}{Query Model} example for the complete source code. + \l{querymodel}{Query Model} example for the complete source code. Subclassing a model makes it possible to customize it in many ways: You can provide tooltips for the items, change the @@ -570,7 +570,7 @@ \image relationaltable.png Editing a foreign key in a relational table - The \l{sql/relationaltablemodel}{Relational Table Model} example + The \l{relationaltablemodel}{Relational Table Model} example illustrates how to use QSqlRelationalTableModel in conjunction with QSqlRelationalDelegate to provide tables with foreign key support. @@ -603,7 +603,7 @@ \image qdatawidgetmapper-simple.png - The \l{sql/books}{Books} example shows how information can + The \l{books}{Books} example shows how information can be presented for easy access by using QDataWidgetMapper and a set of simple input widgets. */ diff --git a/src/sql/models/qsqlquerymodel.cpp b/src/sql/models/qsqlquerymodel.cpp index 926b78fe9f..c49a1f2fac 100644 --- a/src/sql/models/qsqlquerymodel.cpp +++ b/src/sql/models/qsqlquerymodel.cpp @@ -129,7 +129,7 @@ void QSqlQueryModelPrivate::initColOffsets(int size) option is to use QSqlTableModel, which provides a read-write model based on a single database table. - The \l{sql/querymodel} example illustrates how to use + The \l{querymodel} example illustrates how to use QSqlQueryModel to display the result of a query. It also shows how to subclass QSqlQueryModel to customize the contents of the data before showing it to the user, and how to create a diff --git a/src/sql/models/qsqlrelationaldelegate.cpp b/src/sql/models/qsqlrelationaldelegate.cpp index 31b3df3858..af50c03b2d 100644 --- a/src/sql/models/qsqlrelationaldelegate.cpp +++ b/src/sql/models/qsqlrelationaldelegate.cpp @@ -53,9 +53,9 @@ QT_BEGIN_NAMESPACE use the class, simply call QAbstractItemView::setItemDelegate() on the view with an instance of QSqlRelationalDelegate: - \snippet sql/relationaltablemodel/relationaltablemodel.cpp 4 + \snippet relationaltablemodel/relationaltablemodel.cpp 4 - The \l{sql/relationaltablemodel}{Relational Table Model} example + The \l{relationaltablemodel}{Relational Table Model} example (shown below) illustrates how to use QSqlRelationalDelegate in conjunction with QSqlRelationalTableModel to provide tables with foreign key support. diff --git a/src/sql/models/qsqlrelationaltablemodel.cpp b/src/sql/models/qsqlrelationaltablemodel.cpp index e249277a86..c3637f0db7 100644 --- a/src/sql/models/qsqlrelationaltablemodel.cpp +++ b/src/sql/models/qsqlrelationaltablemodel.cpp @@ -340,10 +340,10 @@ void QSqlRelationalTableModelPrivate::clearCache() The following code snippet shows how the QSqlRelationalTableModel was set up: - \snippet sql/relationaltablemodel/relationaltablemodel.cpp 0 + \snippet relationaltablemodel/relationaltablemodel.cpp 0 \codeline - \snippet sql/relationaltablemodel/relationaltablemodel.cpp 1 - \snippet sql/relationaltablemodel/relationaltablemodel.cpp 2 + \snippet relationaltablemodel/relationaltablemodel.cpp 1 + \snippet relationaltablemodel/relationaltablemodel.cpp 2 The setRelation() function calls establish a relationship between two tables. The first call specifies that column 2 in table \c @@ -359,9 +359,9 @@ void QSqlRelationalTableModelPrivate::clearCache() call QAbstractItemView::setItemDelegate() on the view with an instance of QSqlRelationalDelegate: - \snippet sql/relationaltablemodel/relationaltablemodel.cpp 4 + \snippet relationaltablemodel/relationaltablemodel.cpp 4 - The \l{sql/relationaltablemodel} example illustrates how to use + The \l{relationaltablemodel} example illustrates how to use QSqlRelationalTableModel in conjunction with QSqlRelationalDelegate to provide tables with foreign key support. @@ -486,9 +486,9 @@ bool QSqlRelationalTableModel::setData(const QModelIndex &index, const QVariant Example: - \snippet sql/relationaltablemodel/relationaltablemodel.cpp 0 + \snippet relationaltablemodel/relationaltablemodel.cpp 0 \codeline - \snippet sql/relationaltablemodel/relationaltablemodel.cpp 1 + \snippet relationaltablemodel/relationaltablemodel.cpp 1 The setRelation() call specifies that column 2 in table \c employee is a foreign key that maps with field \c id of table \c diff --git a/src/sql/models/qsqltablemodel.cpp b/src/sql/models/qsqltablemodel.cpp index 5feb3087b8..d685c7e0be 100644 --- a/src/sql/models/qsqltablemodel.cpp +++ b/src/sql/models/qsqltablemodel.cpp @@ -251,7 +251,7 @@ QSqlRecord QSqlTableModelPrivate::primaryValues(int row) const sort order using setSort(). At the end, you must call select() to populate the model with data. - The \l{sql/tablemodel} example illustrates how to use + The \l{tablemodel} example illustrates how to use QSqlTableModel as the data source for a QTableView. QSqlTableModel provides no direct support for foreign keys. Use |