Merge lp:~kalikiana/ubuntu-ui-toolkit/splitDocs into lp:ubuntu-ui-toolkit

[Cris Dywan]

Split documentation for previously group properties

[Tim Peeters (tpeeters)]

69 - /*! \internal */
70 + /*!
71 + \qmlproperty int hours
72 + \readonly
73 + */

No need to add \qmlproperty for all of those. qdoc can detect the property type there easily.

review: Needs Fixing

[Tim Peeters (tpeeters)]

\readonly also is not needed, is auto-detected by qdoc

[Tim Peeters (tpeeters)]

22 + See maximum date (inclusive) to be shown in the picker.

See --> The

[Tim Peeters (tpeeters)]

Would you mind adding a short description to the properties that don't show documentation now?
for example
/*
  The currently selected month
 */
readonly property int month

[Tim Peeters (tpeeters)]

25 + See minimum for more details.

add \l before minimum

review: Needs Fixing

[Tim Peeters (tpeeters)]

134 + See horizontalAlignment for details.

add \l

[Tim Peeters (tpeeters)]

95 /*!
96 \qmlproperty real contentWidth
97 + The properties can be used to alter the default content width and heights.
98 + */
99 + property alias contentWidth: foreground.width
100 + /*!
101 \qmlproperty real contentHeight
102 The properties can be used to alter the default content width and heights.
103 - */
104 - property alias contentWidth: foreground.width
105 - /*! \internal */
106 + */

That sentence is a bit weird.
What about: "Use this property to override the default contents width" (and height for the other property)

[lp:~kalikiana/ubuntu-ui-toolkit/splitDocs]

911. By Cris Dywan on 2014-01-10

Have one sentence for each date alias without superfulous annotations

912. By Cris Dywan on 2014-01-10

Typos and missing \l for properties

913. By Cris Dywan on 2014-01-10

contentWidth/ height sentence rewording

[Tim Peeters (tpeeters)]

great, thanks

review: Approve

[PS Jenkins bot (ps-jenkins)]

FAILED: Continuous integration, rev:910
http://jenkins.qa.ubuntu.com/job/ubuntu-ui-toolkit-ci/1570/
Executed test runs:
    SUCCESS: http://jenkins.qa.ubuntu.com/job/generic-mediumtests-trusty/2244
    FAILURE: http://jenkins.qa.ubuntu.com/job/generic-mediumtests-trusty-touch/2129/console
    SUCCESS: http://jenkins.qa.ubuntu.com/job/ubuntu-ui-toolkit-trusty-amd64-ci/518
    SUCCESS: http://jenkins.qa.ubuntu.com/job/ubuntu-ui-toolkit-trusty-armhf-ci/518
        deb: http://jenkins.qa.ubuntu.com/job/ubuntu-ui-toolkit-trusty-armhf-ci/518/artifact/work/output/*zip*/output.zip
    SUCCESS: http://jenkins.qa.ubuntu.com/job/autopilot-testrunner-otto-trusty/1964
    SUCCESS: http://jenkins.qa.ubuntu.com/job/generic-mediumtests-builder-trusty-amd64/2246
        deb: http://jenkins.qa.ubuntu.com/job/generic-mediumtests-builder-trusty-amd64/2246/artifact/work/output/*zip*/output.zip
    SUCCESS: http://jenkins.qa.ubuntu.com/job/generic-mediumtests-builder-trusty-armhf/2129
        deb: http://jenkins.qa.ubuntu.com/job/generic-mediumtests-builder-trusty-armhf/2129/artifact/work/output/*zip*/output.zip
    FAILURE: http://jenkins.qa.ubuntu.com/job/generic-mediumtests-runner-mako/4588/console
    SUCCESS: http://s-jenkins.ubuntu-ci:8080/job/touch-flash-device/2987

Click here to trigger a rebuild:
http://s-jenkins.ubuntu-ci:8080/job/ubuntu-ui-toolkit-ci/1570/rebuild

review: Needs Fixing (continuous-integration)

[PS Jenkins bot (ps-jenkins)]

review: Approve (continuous-integration)

=== modified file 'modules/Ubuntu/Components/Pickers/DatePicker.qml'
--- modules/Ubuntu/Components/Pickers/DatePicker.qml	2013-12-16 13:57:01 +0000
+++ modules/Ubuntu/Components/Pickers/DatePicker.qml	2014-01-10 15:35:00 +0000
@@ -223,8 +223,7 @@
 
     /*!
       \qmlproperty int minimum
-      \qmlproperty int maximum
-      The minimum and maximum dates (inclusive) to be shown in the picker.
+      The minimum date (inclusive) to be shown in the picker.
       Both year and month values will be considered from the properties.
 
       The year and month picker values are filled based on these values. The
@@ -239,7 +238,14 @@
       value for maximum.
       */
     property date minimum: Date.prototype.midnight.call(new Date())
-    /*! \internal */
+    /*!
+      \qmlproperty int maximum
+
+      The maximum date (inclusive) to be shown in the picker.
+      Both year and month values will be considered from the properties.
+
+      See \l minimum for more details.
+     */
     property date maximum: {
         var d = Date.prototype.midnight.call(new Date());
         d.setFullYear(d.getFullYear() + 50);
@@ -247,36 +253,32 @@
     }
 
     /*!
-      \qmlproperty int year
-      \readonly
-      \qmlproperty int month
-      \readonly
-      \qmlproperty int day
-      \readonly
-      \qmlproperty int week
-      \readonly
-      \qmlproperty int hours
-      \readonly
-      \qmlproperty int minutes
-      \readonly
-      \qmlproperty int seconds
-      \readonly
-      Properties declared for convenience, representing the \b year, \b month,
-      \b day, \b week as well as \b hours, \b minutes and \b seconds values of
-      the \l date property.
+      For convenience, the \b year value of the \l date property.
       */
     readonly property int year: datePicker.date.getFullYear()
-    /*! \internal */
+    /*!
+      For convenience, the \b month value of the \l date property.
+     */
     readonly property int month: datePicker.date.getMonth()
-    /*! \internal */
+    /*!
+      For convenience, the \b day value of the \l date property.
+     */
     readonly property int day: datePicker.date.getDate()
-    /*! \internal */
+    /*!
+      For convenience, the \b week value of the \l date property.
+     */
     readonly property int week: datePicker.date.getWeek()
-    /*! \internal */
+    /*!
+      For convenience, the \b hours value of the \l date property.
+     */
     readonly property int hours: datePicker.date.getHours()
-    /*! \internal */
+    /*!
+      For convenience, the \b minutes value of the \l date property.
+     */
     readonly property int minutes: datePicker.date.getMinutes()
-    /*! \internal */
+    /*!
+      For convenience, the \b seconds value of the \l date property.
+     */
     readonly property int seconds: datePicker.date.getSeconds()
 
     /*!

=== modified file 'modules/Ubuntu/Components/Popups/Popover.qml'
--- modules/Ubuntu/Components/Popups/Popover.qml	2014-01-08 10:48:29 +0000
+++ modules/Ubuntu/Components/Popups/Popover.qml	2014-01-10 15:35:00 +0000
@@ -100,11 +100,13 @@
 
     /*!
       \qmlproperty real contentWidth
+      Use this property to override the default content width.
+      */
+    property alias contentWidth: foreground.width
+    /*!
       \qmlproperty real contentHeight
-      The properties can be used to alter the default content width and heights.
-      */
-    property alias contentWidth: foreground.width
-    /*! \internal */
+      Use this property to override the default content height.
+     */
     property alias contentHeight: foreground.height
 
     /*!

=== modified file 'modules/Ubuntu/Components/TextField.qml'
--- modules/Ubuntu/Components/TextField.qml	2014-01-08 10:48:29 +0000
+++ modules/Ubuntu/Components/TextField.qml	2014-01-10 15:35:00 +0000
@@ -539,13 +539,19 @@
       horizontal alignment of TextField, use the read-only property effectiveHorizontalAlignment.
 
       \qmlproperty enumeration horizontalAlignment
+    */
+    property alias horizontalAlignment: editor.horizontalAlignment
+    /*!
       \qmlproperty enumeration effectiveHorizontalAlignment
+
+      See \l horizontalAlignment for details.
+    */
+    property alias effectiveHorizontalAlignment: editor.effectiveHorizontalAlignment
+    /*!
       \qmlproperty enumeration verticalAlignment
-    */
-    property alias horizontalAlignment: editor.horizontalAlignment
-    /*! \internal */
-    property alias effectiveHorizontalAlignment: editor.effectiveHorizontalAlignment
-    /*! \internal */
+
+      See \l horizontalAlignment for details.
+     */
     property alias verticalAlignment: editor.verticalAlignment
 
     /*!