Add docs for QSqlRelationalTableModel::JoinMode

Task-number:QTBUG-8217
Reviewed-by:Michael Goddard

(cherry picked from commit e2e62bc810d21fecc9ed1d1db486b529b760d292)

Change-Id: Ie2af750c3a64aa634e11617cf9b3f9e7bdcf3a5f
Reviewed-on: http://codereview.qt.nokia.com/1854
Reviewed-by: Qt Sanity Bot <qt_sanity_bot@ovi.com>
Reviewed-by: Charles Yin <charles.yin@nokia.com>

diff --git a/src/sql/models/qsqlrelationaltablemodel.cpp b/src/sql/models/qsqlrelationaltablemodel.cpp
index bc96e83..f6c4018 100644 (file)
--- a/src/sql/models/qsqlrelationaltablemodel.cpp
+++ b/src/sql/models/qsqlrelationaltablemodel.cpp
@@ -676,11 +676,23 @@ void QSqlRelationalTableModel::clear()
     d->relations.clear();
     QSqlTableModel::clear();
 }
+
+
+/*! \enum QSqlRelationalTableModel::JoinMode
+
+    \value InnerJoin - Inner join mode, return rows when there is at least one match in both tables.
+    \value LeftJoin - Left join mode, returns all rows from the left table (table_name1), even if there are no matches in the right table (table_name2).
+
+    \see QSqlRelationalTableModel::setJoinMode
+    \since 4.8
+*/
+
 /*!
     Sets the SQL join mode to show or hide rows with NULL foreign keys.
     In InnerJoin mode (the default) these rows will not be showed: use the
     LeftJoin mode if you want to show them.
 
+    \see QSqlRelationalTableModel::JoinMode
     \since 4.8
 */
 void QSqlRelationalTableModel::setJoinMode( QSqlRelationalTableModel::JoinMode joinMode )