uonedb-qt team mailing list archive

[Christian Dywan <christian.dywan@xxxxxxxxxxxxx>]

Christian Dywan has proposed merging lp:~kalikiana/u1db-qt/overview into lp:u1db-qt.

Commit message:
Replaces classes page with a real overview

Requested reviews:
  U1DB Qt developers (uonedb-qt)

For more details, see:
https://code.launchpad.net/~kalikiana/u1db-qt/overview/+merge/160064

Replaces classes page with a real overview
-- 
https://code.launchpad.net/~kalikiana/u1db-qt/overview/+merge/160064
Your team U1DB Qt developers is requested to review the proposed merge of lp:~kalikiana/u1db-qt/overview into lp:u1db-qt.

=== modified file 'documentation/overview.qdoc'
--- documentation/overview.qdoc	2013-03-13 14:23:22 +0000
+++ documentation/overview.qdoc	2013-04-22 10:37:29 +0000
@@ -0,0 +1,37 @@
+/*
+ * Copyright (C) 2013 Canonical, Ltd.
+ *
+ * Authors:
+ *  Christian Dywan <christian.dywan@xxxxxxxxxxxxx>
+ *
+ * This program is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU Lesser General Public License as published by
+ * the Free Software Foundation; version 3.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ */
+
+/*!
+     \page overview.html overview
+     \title U1Db-Qt QML bindings for U1Db
+     \contentspage {U1Db-Qt QML bindings for U1Db} {Contents}
+
+     \part General Topics
+     \list
+     \li \l {U1Db-Qt Tutorial} gives a quick start guide from storing a document
+     to querying a database and displaying it in Ubuntu Components.
+     \endlist
+
+     \part Document Storage
+     Available through:
+     \code
+         import U1db 1.0 as U1db
+     \endcode
+     \annotatedlist modules
+ */

=== modified file 'documentation/u1db.qdocconf'
--- documentation/u1db.qdocconf	2013-04-12 12:26:52 +0000
+++ documentation/u1db.qdocconf	2013-04-22 10:37:29 +0000
@@ -1,7 +1,8 @@
 project = U1Db-Qt
 description = U1Db-Qt plugin documentation
 
-sourcedirs = ../src
+sourcedirs = ../src \
+             ../documentation
 headers = ../src/database.h \
           ../src/document.h \
           ../src/index.h \

=== modified file 'documentation/u1db.tutorial.qdoc'
--- documentation/u1db.tutorial.qdoc	2013-04-05 10:30:56 +0000
+++ documentation/u1db.tutorial.qdoc	2013-04-22 10:37:29 +0000
@@ -1,8 +1,8 @@
 /*!
 
-\page u1db-qt-cheatsheet.html
+\page tutorial.html
 
-\title U1Db-Qt Cheat Sheet
+\title U1Db-Qt Tutorial
   
   
 \chapter 1.0.0 Overview of U1Db-Qt  

=== modified file 'src/database.cpp'
--- src/database.cpp	2013-04-12 12:26:52 +0000
+++ src/database.cpp	2013-04-22 10:37:29 +0000
@@ -32,18 +32,6 @@
 QT_BEGIN_NAMESPACE_U1DB
 
 /*!
-    \page classes.html
-    \title All Classes
-    \ingroup classlists
-
-    \brief If you know the name of the class you want, find it here.
-
-    This is a list of all U1db classes.
-
-    \generatelist annotatedclasses
-*/
-
-/*!
     \class Database
     \inmodule U1Db
     \ingroup modules

=== modified file 'src/document.cpp'
--- src/document.cpp	2013-04-12 12:26:52 +0000
+++ src/document.cpp	2013-04-22 10:37:29 +0000
@@ -33,6 +33,7 @@
 /*!
     \class Document
     \inmodule U1db
+    \ingroup modules
 
     \brief The Document class proxies a single document stored in the Database.
 

=== modified file 'src/index.cpp'
--- src/index.cpp	2013-04-12 12:26:52 +0000
+++ src/index.cpp	2013-04-22 10:37:29 +0000
@@ -32,6 +32,8 @@
 
 /*!
     \class Index
+    \inmodule U1Db
+    \ingroup modules
 
     \brief The Index class defines an index to be stored in the database and
     queried using Query. Changes in documents affected by the index also update

=== modified file 'src/query.cpp'
--- src/query.cpp	2013-04-19 11:19:43 +0000
+++ src/query.cpp	2013-04-22 10:37:29 +0000
@@ -34,6 +34,7 @@
 /*!
     \class Query
     \inmodule U1db
+    \ingroup modules
 
     \brief The Query class generates a filtered list of documents based on either
     a query or a range, and using the given Index.