Merge lp:~uonedb-qt/u1db-qt/apiFile into lp:u1db-qt

Proposed by Christian Dywan on 2016-03-01
Status: Work in progress
Proposed branch: lp:~uonedb-qt/u1db-qt/apiFile
Merge into: lp:u1db-qt
Diff against target: 97 lines (+69/-0)
4 files modified
debian/control (+1/-0)
debian/libu1db-qt5-api.install (+1/-0)
modules/U1db/CMakeLists.txt (+11/-0)
modules/U1db/U1db.api (+56/-0)
To merge this branch: bzr merge lp:~uonedb-qt/u1db-qt/apiFile
Reviewer Review Type Date Requested Status
Zoltan Balogh (community) Needs Fixing on 2016-03-02
PS Jenkins bot continuous-integration Needs Fixing on 2016-03-01
U1DB Qt developers 2016-03-01 Pending
Review via email: mp+287626@code.launchpad.net

Commit message

Verify and ship QML API description

To post a comment you must log in.
PS Jenkins bot (ps-jenkins) wrote :
review: Needs Fixing (continuous-integration)
Zoltan Balogh (bzoltan) wrote :

I wonder if we want to change the ubuntu-ui-toolkit-tools to a more generic name

review: Needs Information
Zoltan Balogh (bzoltan) wrote :

Inline comments.

review: Needs Fixing
Christian Dywan (kalikiana) wrote :

> I wonder if we want to change the ubuntu-ui-toolkit-tools
> to a more generic name

Note that *this* branch is merely using apicheck with U1db. Your feedback would make more sense on https://code.launchpad.net/~ubuntu-sdk-team/ubuntu-ui-toolkit/firstClassApiCheck/+merge/287004 where -tools package providing apicheck lives.

Unmerged revisions

132. By Christian Dywan on 2016-03-01

Verify and ship QML API description

Preview Diff

[H/L] Next/Prev Comment, [J/K] Next/Prev File, [N/P] Next/Prev Hunk
1=== modified file 'debian/control'
2--- debian/control 2014-01-22 13:14:22 +0000
3+++ debian/control 2016-03-01 13:02:26 +0000
4@@ -14,6 +14,7 @@
5 qtdeclarative5-qtquick2-plugin,
6 qtdeclarative5-test-plugin,
7 qttools5-dev-tools,
8+ ubuntu-ui-toolkit-tools,
9 ubuntu-ui-toolkit-doc,
10 xvfb,
11 libgl1-mesa-dri,
12
13=== added file 'debian/libu1db-qt5-api.install'
14--- debian/libu1db-qt5-api.install 1970-01-01 00:00:00 +0000
15+++ debian/libu1db-qt5-api.install 2016-03-01 13:02:26 +0000
16@@ -0,0 +1,1 @@
17+usr/share/click/api/qml/*
18
19=== modified file 'modules/U1db/CMakeLists.txt'
20--- modules/U1db/CMakeLists.txt 2013-08-08 10:11:39 +0000
21+++ modules/U1db/CMakeLists.txt 2016-03-01 13:02:26 +0000
22@@ -57,3 +57,14 @@
23 install(FILES ${CMAKE_CURRENT_BINARY_DIR}/plugins.qmltypes
24 DESTINATION ${QT_IMPORTS_DIR}/U1db
25 )
26+
27+add_custom_command(OUTPUT U1db.api
28+ COMMAND "ubuntu-ui-toolkit-apicheck" "U1db" "${CMAKE_CURRENT_SOURCE_DIR}/U1db.api" ">" "${CMAKE_CURRENT_BINARY_DIR}/U1db.api.new"
29+ WORKING_DIRECTORY "${CMAKE_SOURCE_DIR}"
30+ DEPENDS U1DBPlugin
31+ )
32+add_custom_target(api "ALL" DEPENDS U1db.api)
33+install(FILES ${CMAKE_CURRENT_SOURCE_DIR}/U1db.api
34+ DESTINATION ${CMAKE_INSTALL_PREFIX}/share/click/api/qml
35+ )
36+
37
38=== added file 'modules/U1db/U1db.api'
39--- modules/U1db/U1db.api 1970-01-01 00:00:00 +0000
40+++ modules/U1db/U1db.api 2016-03-01 13:02:26 +0000
41@@ -0,0 +1,56 @@
42+U1db.Database 1.0 U1db::Database: QAbstractListModel
43+ readonly property string error
44+ signal pathChanged(string path)
45+ signal errorChanged(string error)
46+ signal docChanged(string docId, var content)
47+ signal docLoaded(string docId, var content)
48+ function var getDoc(string docId)
49+ function string putDoc(var newDoc, string docID)
50+ function string putDoc(var newDoc)
51+ function deleteDoc(string docID)
52+ function list<string> listDocs()
53+ function string lastError()
54+ function string putIndex(string index_name, QStringList expressions)
55+ function QStringList getIndexExpressions(string indexName)
56+ function QStringList getIndexKeys(string indexName)
57+ property string path
58+U1db.Document 1.0 U1db::Document: QtObject
59+ property var contents
60+ property bool create
61+ property U1db.Database database
62+ property var defaults
63+ property string docId
64+ signal databaseChanged(Database database)
65+ signal docIdChanged(string docId)
66+ signal createChanged(bool create)
67+ signal defaultsChanged(var defaults)
68+ signal contentsChanged(var contents)
69+U1db.Index 1.0 U1db::Index: QtObject
70+ property U1db.Database database
71+ property QStringList expression
72+ signal databaseChanged(Database database)
73+ signal nameChanged(string name)
74+ signal expressionChanged(var expression)
75+ signal dataInvalidated()
76+ property string name
77+U1db.Query 1.0 U1db::Query: QAbstractListModel
78+ readonly property QStringList documents
79+ property U1db.Index index
80+ signal indexChanged(Index index)
81+ signal queryChanged(var query)
82+ signal documentsChanged(QStringList documents)
83+ signal resultsChanged(QVariantList results)
84+ property var query
85+ readonly property QVariantList results
86+U1db.Synchronizer 1.0 U1db::Synchronizer: QAbstractListModel
87+ signal sourceChanged(Database source)
88+ signal targetsChanged(var targets)
89+ signal syncChanged(bool synchronize)
90+ signal resolveToSourceChanged(bool resolve_to_source)
91+ signal syncOutputChanged(QVariantList sync_output)
92+ signal syncCompleted()
93+ property bool resolve_to_source
94+ property U1db.Database source
95+ readonly property QVariantList sync_output
96+ property bool synchronize
97+ property var targets

Subscribers

People subscribed via source and target branches

to all changes: