Merge lp:~xavi-garcia-mena/qtcreator-plugin-ubuntu/template-comments into lp:qtcreator-plugin-ubuntu

[Xavi Garcia]

Updated debian/control to fix wrong dependency.

Added some new comments to the code.

Updated debian/control to fix wrong dependency.

[Pete Woods (pete-woods)]

review: Approve

[Zoltan Balogh (bzoltan)]

OK

review: Approve

=== modified file 'debian/control'
--- debian/control	2014-12-12 09:19:25 +0000
+++ debian/control	2014-12-15 10:24:43 +0000
@@ -9,7 +9,7 @@
                libqt5widgets5 (>= 5.3),
                libsqlite3-dev,
                qt5-qmake (>= 5.3),
-               qtcreator-dev (>= 3.1),
+               qtcreator-dev (>= 3.1.1-0ubuntu7),
                qtdeclarative5-dev-tools (>= 5.3),
                qtdeclarative5-private-dev (>= 5.3),
                qtquick1-5-dev (>= 5.3),

=== modified file 'share/qtcreator/templates/wizards/ubuntu/scope/src/api/client.cpp'
--- share/qtcreator/templates/wizards/ubuntu/scope/src/api/client.cpp	2014-10-29 16:56:14 +0000
+++ share/qtcreator/templates/wizards/ubuntu/scope/src/api/client.cpp	2014-12-15 10:24:43 +0000
@@ -173,6 +173,13 @@
 Client::ResultList Client::search(const string &query) {
     ResultList results;
 
+    // This is the method that we will call from the Query class.
+    // It just returns some results.
+    // You can add here your code to get results from an http API, from your local disk
+    // or anywhere.
+
+    // In this case we just create some results withouth accessing any other source of
+    // data
     {
         Result result;
         result.uri = "uri";
@@ -262,11 +269,20 @@
 }
 
 Client::Current Client::weather(const string& query) {
+    // This is the method that we will call from the Query class.
+    // It connects to an HTTP source and returns the results.
+
 @if "%ContentType%" == "network-netcpp-json"
+
+    // In this case we are going to retrieve JSON data.
     json::Value root;
 @elsif "%ContentType%" == "network-netcpp-qjson"
+
+    // In this case we are going to retrieve JSON data.
     QJsonDocument root;
 @elsif "%ContentType%" == "network-netcpp-qxml"
+
+    // In this case we are going to retrieve XML data.
     QXmlStreamReader root;
 @endif
 

=== modified file 'share/qtcreator/templates/wizards/ubuntu/scope/src/scope/preview.cpp'
--- share/qtcreator/templates/wizards/ubuntu/scope/src/scope/preview.cpp	2014-09-03 14:56:27 +0000
+++ share/qtcreator/templates/wizards/ubuntu/scope/src/scope/preview.cpp	2014-12-15 10:24:43 +0000
@@ -24,6 +24,13 @@
     // Support three different column layouts
     sc::ColumnLayout layout1col(1), layout2col(2), layout3col(3);
 
+    // We define 3 different layouts, that will be used depending on the
+    // device. The shell (view) will decide which layout fits best.
+    // If, for instance, we are executing in a tablet probably the view will use
+    // 2 or more columns.
+    // Column layout definitions are optional.
+    // However, we recommend that scopes define layouts for the best visual appearance.
+
     // Single column layout
     layout1col.add_column( { "image", "header", "summary" });
 

=== modified file 'share/qtcreator/templates/wizards/ubuntu/scope/src/scope/query.cpp'
--- share/qtcreator/templates/wizards/ubuntu/scope/src/scope/query.cpp	2014-10-27 16:24:10 +0000
+++ share/qtcreator/templates/wizards/ubuntu/scope/src/scope/query.cpp	2014-12-15 10:24:43 +0000
@@ -116,6 +116,10 @@
         // Trim the query string of whitespace
         string query_string = alg::trim_copy(query.query_string());
 
+        // the Client is the helper class that provides the results
+        // without mixing APIs and scopes code.
+        // Add your code to retreive xml, json, or any other kind of result
+        // in the client.
         Client::ResultList results;
         if (query_string.empty()) {
             // If the string is empty, pick a default
@@ -167,6 +171,10 @@
         // Trim the query string of whitespace
         string query_string = alg::trim_copy(query.query_string());
 
+        // the Client is the helper class that provides the results
+        // without mixing APIs and scopes code.
+        // Add your code to retreive xml, json, or any other kind of result
+        // in the client.
         Client::Current current;
         if (query_string.empty()) {
             // If the string is empty, get the current weather for London