uonedb-qt team mailing list archive

[Christian Dywan <christian.dywan@xxxxxxxxxxxxx>]

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

Commit message:
Implement 'make doc'; fix C++ classes to be parsed by qdoc

Requested reviews:
  U1DB Qt developers (uonedb-qt)

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

Add 'make doc' to generate documentation HTML
-- 
https://code.launchpad.net/~kalikiana/u1db-qt/trunk/+merge/156886
Your team U1DB Qt developers is requested to review the proposed merge of lp:~kalikiana/u1db-qt/trunk into lp:u1db-qt.

=== modified file 'CMakeLists.txt'
--- CMakeLists.txt	2013-03-12 16:08:00 +0000
+++ CMakeLists.txt	2013-04-03 15:40:41 +0000
@@ -77,6 +77,7 @@
 enable_testing()
 
 add_custom_target(check COMMAND "env" "CTEST_OUTPUT_ON_FAILURE=1" "${CMAKE_CTEST_COMMAND}")
+add_custom_target(doc COMMAND "qdoc" "u1db.qdocconf" WORKING_DIRECTORY "documentation")
 add_subdirectory(modules)
 add_subdirectory(tests)
 

=== modified file 'database.cpp'
--- database.cpp	2013-04-02 14:33:49 +0000
+++ database.cpp	2013-04-03 15:40:41 +0000
@@ -32,7 +32,21 @@
 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
 
     \brief The Database class implements the on-disk storage of an individual
     U1DB database.

=== modified file 'document.cpp'
--- document.cpp	2013-04-03 09:43:05 +0000
+++ document.cpp	2013-04-03 15:40:41 +0000
@@ -32,6 +32,7 @@
 
 /*!
     \class Document
+    \inmodule U1db
 
     \brief The Document class proxies a single document stored in the Database.
 

=== modified file 'document.h'
--- document.h	2013-02-27 16:47:21 +0000
+++ document.h	2013-04-03 15:40:41 +0000
@@ -30,7 +30,11 @@
 
 class Q_DECL_EXPORT Document : public QObject {
     Q_OBJECT
+#ifdef Q_QDOC
+    Q_PROPERTY(Database* database READ getDatabase WRITE setDatabase NOTIFY databaseChanged)
+#else
     Q_PROPERTY(QT_PREPEND_NAMESPACE_U1DB(Database*) database READ getDatabase WRITE setDatabase NOTIFY databaseChanged)
+#endif
     Q_PROPERTY(QString docId READ getDocId WRITE setDocId NOTIFY docIdChanged)
     Q_PROPERTY(bool create READ getCreate WRITE setCreate NOTIFY createChanged)
     Q_PROPERTY(QVariant defaults READ getDefaults WRITE setDefaults NOTIFY defaultsChanged)

=== modified file 'documentation/u1db.qdocconf'
--- documentation/u1db.qdocconf	2013-03-18 09:30:41 +0000
+++ documentation/u1db.qdocconf	2013-04-03 15:40:41 +0000
@@ -2,6 +2,20 @@
 description = U1Db-Qt plugin documentation
 
 sourcedirs = ..
+headers = ../database.h \
+          ../document.h \
+          ../index.h \
+          ../query.h \
+          ../global.h
+Cpp.ignoretokens = Q_DECL_EXPORT \
+                   Q_PROPERTY \
+                   QT_BEGIN_NAMESPACE_U1DB \
+                   
+defines = Q_QDOC
+Cpp.ignoredirectives = Q_ENUMS \
+                       Q_FLAGS \
+                       QT_PREPEND_NAMESPACE_U1DB \
+                       Q_DISABLE_COPY
 exampledirs = ../examples
 imagedirs = images 
 

=== modified file 'index.cpp'
--- index.cpp	2013-04-03 09:44:52 +0000
+++ index.cpp	2013-04-03 15:40:41 +0000
@@ -32,6 +32,7 @@
 
 /*!
     \class Index
+    \inmodule U1db
 
     \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 'index.h'
--- index.h	2013-02-28 17:59:51 +0000
+++ index.h	2013-04-03 15:40:41 +0000
@@ -30,7 +30,11 @@
 
 class Q_DECL_EXPORT Index : public QObject {
     Q_OBJECT
+#ifdef Q_QDOC
+    Q_PROPERTY(Database* database READ getDatabase WRITE setDatabase NOTIFY databaseChanged)
+#else
     Q_PROPERTY(QT_PREPEND_NAMESPACE_U1DB(Database*) database READ getDatabase WRITE setDatabase NOTIFY databaseChanged)
+#endif
     Q_PROPERTY(QString name READ getName WRITE setName NOTIFY nameChanged)
     Q_PROPERTY(QStringList expression READ getExpression WRITE setExpression NOTIFY expressionChanged)
 public:

=== modified file 'query.cpp'
--- query.cpp	2013-04-03 09:45:24 +0000
+++ query.cpp	2013-04-03 15:40:41 +0000
@@ -33,6 +33,7 @@
 
 /*!
     \class Query
+    \inmodule U1db
 
     \brief The Query class generates a filtered list of documents based on either
     a query or a range, and using the given Index.

=== modified file 'query.h'
--- query.h	2013-02-28 17:59:51 +0000
+++ query.h	2013-04-03 15:40:41 +0000
@@ -29,7 +29,11 @@
 
 class Q_DECL_EXPORT Query : public QAbstractListModel {
     Q_OBJECT
+#ifdef Q_QDOC
+    Q_PROPERTY(Index* index READ getIndex WRITE setIndex NOTIFY indexChanged)
+#else
     Q_PROPERTY(QT_PREPEND_NAMESPACE_U1DB(Index*) index READ getIndex WRITE setIndex NOTIFY indexChanged)
+#endif
     Q_PROPERTY(QVariant query READ getQuery WRITE setQuery NOTIFY queryChanged)
     Q_PROPERTY(QVariant range READ getRange WRITE setRange NOTIFY rangeChanged)
 public: