New documentation from Doxygen. Added comment for function songsBell().

2017-08-24 23:13:58 +02:00 · 2017-08-24 23:13:58 +02:00 · 43c5d255a0
parent 5e0698ae59
commit 43c5d255a0
38 changed files with 65 additions and 48 deletions
--- a/documentation/html/annotated.html
+++ b/documentation/html/annotated.html
@ -22,7 +22,7 @@
 <tr style="height: 56px;">
  <td id="projectalign" style="padding-left: 0.5em;">
   <div id="projectname">Boxing Timer
-   &#160;<span id="projectnumber">1.0</span>
+   &#160;<span id="projectnumber">0.1a</span>
   </div>
  </td>
 </tr>
--- a/documentation/html/boxingsettings_8cpp.html
+++ b/documentation/html/boxingsettings_8cpp.html
@ -22,7 +22,7 @@
 <tr style="height: 56px;">
  <td id="projectalign" style="padding-left: 0.5em;">
   <div id="projectname">Boxing Timer
-   &#160;<span id="projectnumber">1.0</span>
+   &#160;<span id="projectnumber">0.1a</span>
   </div>
  </td>
 </tr>
--- a/documentation/html/boxingsettings_8h.html
+++ b/documentation/html/boxingsettings_8h.html
@ -22,7 +22,7 @@
 <tr style="height: 56px;">
  <td id="projectalign" style="padding-left: 0.5em;">
   <div id="projectname">Boxing Timer
-   &#160;<span id="projectnumber">1.0</span>
+   &#160;<span id="projectnumber">0.1a</span>
   </div>
  </td>
 </tr>
--- a/documentation/html/boxingsettings_8h_source.html
+++ b/documentation/html/boxingsettings_8h_source.html
@ -22,7 +22,7 @@
 <tr style="height: 56px;">
  <td id="projectalign" style="padding-left: 0.5em;">
   <div id="projectname">Boxing Timer
-   &#160;<span id="projectnumber">1.0</span>
+   &#160;<span id="projectnumber">0.1a</span>
   </div>
  </td>
 </tr>
--- a/documentation/html/boxingtimer_8cpp.html
+++ b/documentation/html/boxingtimer_8cpp.html
@ -22,7 +22,7 @@
 <tr style="height: 56px;">
  <td id="projectalign" style="padding-left: 0.5em;">
   <div id="projectname">Boxing Timer
-   &#160;<span id="projectnumber">1.0</span>
+   &#160;<span id="projectnumber">0.1a</span>
   </div>
  </td>
 </tr>
@ -70,6 +70,7 @@ $(function() {
 <div class="textblock"><code>#include &lt;QObject&gt;</code><br />
 <code>#include &lt;QTime&gt;</code><br />
 <code>#include &lt;QSettings&gt;</code><br />
+<code>#include &lt;QSound&gt;</code><br />
 <code>#include &quot;<a class="el" href="boxingtimer_8h_source.html">boxingtimer.h</a>&quot;</code><br />
 <code>#include &quot;<a class="el" href="boxingsettings_8h_source.html">boxingsettings.h</a>&quot;</code><br />
 </div></div><!-- contents -->
--- a/documentation/html/boxingtimer_8h.html
+++ b/documentation/html/boxingtimer_8h.html
@ -22,7 +22,7 @@
 <tr style="height: 56px;">
  <td id="projectalign" style="padding-left: 0.5em;">
   <div id="projectname">Boxing Timer
-   &#160;<span id="projectnumber">1.0</span>
+   &#160;<span id="projectnumber">0.1a</span>
   </div>
  </td>
 </tr>
--- a/documentation/html/boxingtimer_8h_source.html
+++ b/documentation/html/boxingtimer_8h_source.html
--- a/documentation/html/class_boxing_settings-members.html
+++ b/documentation/html/class_boxing_settings-members.html
@ -22,7 +22,7 @@
 <tr style="height: 56px;">
  <td id="projectalign" style="padding-left: 0.5em;">
   <div id="projectname">Boxing Timer
-   &#160;<span id="projectnumber">1.0</span>
+   &#160;<span id="projectnumber">0.1a</span>
   </div>
  </td>
 </tr>
--- a/documentation/html/class_boxing_settings.html
+++ b/documentation/html/class_boxing_settings.html
@ -22,7 +22,7 @@
 <tr style="height: 56px;">
  <td id="projectalign" style="padding-left: 0.5em;">
   <div id="projectname">Boxing Timer
-   &#160;<span id="projectnumber">1.0</span>
+   &#160;<span id="projectnumber">0.1a</span>
   </div>
  </td>
 </tr>
--- a/documentation/html/class_boxing_timer-members.html
+++ b/documentation/html/class_boxing_timer-members.html
@ -22,7 +22,7 @@
 <tr style="height: 56px;">
  <td id="projectalign" style="padding-left: 0.5em;">
   <div id="projectname">Boxing Timer
-   &#160;<span id="projectnumber">1.0</span>
+   &#160;<span id="projectnumber">0.1a</span>
   </div>
  </td>
 </tr>
--- a/documentation/html/class_boxing_timer.html
+++ b/documentation/html/class_boxing_timer.html
@ -22,7 +22,7 @@
 <tr style="height: 56px;">
  <td id="projectalign" style="padding-left: 0.5em;">
   <div id="projectname">Boxing Timer
-   &#160;<span id="projectnumber">1.0</span>
+   &#160;<span id="projectnumber">0.1a</span>
   </div>
  </td>
 </tr>
--- a/documentation/html/classes.html
+++ b/documentation/html/classes.html
@ -22,7 +22,7 @@
 <tr style="height: 56px;">
  <td id="projectalign" style="padding-left: 0.5em;">
   <div id="projectname">Boxing Timer
-   &#160;<span id="projectnumber">1.0</span>
+   &#160;<span id="projectnumber">0.1a</span>
   </div>
  </td>
 </tr>
--- a/documentation/html/dir_68267d1309a1af8e8297ef4c3efbcdba.html
+++ b/documentation/html/dir_68267d1309a1af8e8297ef4c3efbcdba.html
@ -22,7 +22,7 @@
 <tr style="height: 56px;">
  <td id="projectalign" style="padding-left: 0.5em;">
   <div id="projectname">Boxing Timer
-   &#160;<span id="projectnumber">1.0</span>
+   &#160;<span id="projectnumber">0.1a</span>
   </div>
  </td>
 </tr>
--- a/documentation/html/files.html
+++ b/documentation/html/files.html
@ -22,7 +22,7 @@
 <tr style="height: 56px;">
  <td id="projectalign" style="padding-left: 0.5em;">
   <div id="projectname">Boxing Timer
-   &#160;<span id="projectnumber">1.0</span>
+   &#160;<span id="projectnumber">0.1a</span>
   </div>
  </td>
 </tr>
--- a/documentation/html/functions.html
+++ b/documentation/html/functions.html
@ -22,7 +22,7 @@
 <tr style="height: 56px;">
  <td id="projectalign" style="padding-left: 0.5em;">
   <div id="projectname">Boxing Timer
-   &#160;<span id="projectnumber">1.0</span>
+   &#160;<span id="projectnumber">0.1a</span>
   </div>
  </td>
 </tr>
--- a/documentation/html/functions_enum.html
+++ b/documentation/html/functions_enum.html
@ -22,7 +22,7 @@
 <tr style="height: 56px;">
  <td id="projectalign" style="padding-left: 0.5em;">
   <div id="projectname">Boxing Timer
-   &#160;<span id="projectnumber">1.0</span>
+   &#160;<span id="projectnumber">0.1a</span>
   </div>
  </td>
 </tr>
--- a/documentation/html/functions_func.html
+++ b/documentation/html/functions_func.html
@ -22,7 +22,7 @@
 <tr style="height: 56px;">
  <td id="projectalign" style="padding-left: 0.5em;">
   <div id="projectname">Boxing Timer
-   &#160;<span id="projectnumber">1.0</span>
+   &#160;<span id="projectnumber">0.1a</span>
   </div>
  </td>
 </tr>
--- a/documentation/html/globals.html
+++ b/documentation/html/globals.html
@ -22,7 +22,7 @@
 <tr style="height: 56px;">
  <td id="projectalign" style="padding-left: 0.5em;">
   <div id="projectname">Boxing Timer
-   &#160;<span id="projectnumber">1.0</span>
+   &#160;<span id="projectnumber">0.1a</span>
   </div>
  </td>
 </tr>
--- a/documentation/html/globals_func.html
+++ b/documentation/html/globals_func.html
@ -22,7 +22,7 @@
 <tr style="height: 56px;">
  <td id="projectalign" style="padding-left: 0.5em;">
   <div id="projectname">Boxing Timer
-   &#160;<span id="projectnumber">1.0</span>
+   &#160;<span id="projectnumber">0.1a</span>
   </div>
  </td>
 </tr>
--- a/documentation/html/group___q_m_l.html
+++ b/documentation/html/group___q_m_l.html
@ -22,7 +22,7 @@
 <tr style="height: 56px;">
  <td id="projectalign" style="padding-left: 0.5em;">
   <div id="projectname">Boxing Timer
-   &#160;<span id="projectnumber">1.0</span>
+   &#160;<span id="projectnumber">0.1a</span>
   </div>
  </td>
 </tr>
--- a/documentation/html/harbour-boxing-timer_8cpp.html
+++ b/documentation/html/harbour-boxing-timer_8cpp.html
@ -22,7 +22,7 @@
 <tr style="height: 56px;">
  <td id="projectalign" style="padding-left: 0.5em;">
   <div id="projectname">Boxing Timer
-   &#160;<span id="projectnumber">1.0</span>
+   &#160;<span id="projectnumber">0.1a</span>
   </div>
  </td>
 </tr>
--- a/documentation/html/hierarchy.html
+++ b/documentation/html/hierarchy.html
@ -22,7 +22,7 @@
 <tr style="height: 56px;">
  <td id="projectalign" style="padding-left: 0.5em;">
   <div id="projectname">Boxing Timer
-   &#160;<span id="projectnumber">1.0</span>
+   &#160;<span id="projectnumber">0.1a</span>
   </div>
  </td>
 </tr>
--- a/documentation/html/index.html
+++ b/documentation/html/index.html
@ -22,7 +22,7 @@
 <tr style="height: 56px;">
  <td id="projectalign" style="padding-left: 0.5em;">
   <div id="projectname">Boxing Timer
-   &#160;<span id="projectnumber">1.0</span>
+   &#160;<span id="projectnumber">0.1a</span>
   </div>
  </td>
 </tr>
--- a/documentation/html/modules.html
+++ b/documentation/html/modules.html
@ -22,7 +22,7 @@
 <tr style="height: 56px;">
  <td id="projectalign" style="padding-left: 0.5em;">
   <div id="projectname">Boxing Timer
-   &#160;<span id="projectnumber">1.0</span>
+   &#160;<span id="projectnumber">0.1a</span>
   </div>
  </td>
 </tr>
--- a/documentation/html/search/all_9.js
+++ b/documentation/html/search/all_9.js
@ -9,5 +9,5 @@ var searchData=
  ['start',['start',['../class_boxing_timer.html#a64ae1d3a8bfe52b225658bf4121dcdfa',1,'BoxingTimer::start(const int &amp;milliseconds)'],['../class_boxing_timer.html#af2a4f0a0658b3685b2e0bcd965dca558aa6122a65eaa676f700ae68d393054a37',1,'BoxingTimer::Start()']]],
  ['status',['Status',['../class_boxing_timer.html#af2a4f0a0658b3685b2e0bcd965dca558',1,'BoxingTimer']]],
  ['statuschanged',['statusChanged',['../class_boxing_timer.html#ab3d16c454a2fac620bb84721c105485a',1,'BoxingTimer']]],
-  ['stop',['Stop',['../class_boxing_timer.html#af2a4f0a0658b3685b2e0bcd965dca558a11a755d598c0c417f9a36758c3da7481',1,'BoxingTimer::Stop()'],['../class_boxing_timer.html#aa294afc288608f91eb00d1680db67738',1,'BoxingTimer::stop()']]]
+  ['stop',['stop',['../class_boxing_timer.html#aa294afc288608f91eb00d1680db67738',1,'BoxingTimer::stop()'],['../class_boxing_timer.html#af2a4f0a0658b3685b2e0bcd965dca558a11a755d598c0c417f9a36758c3da7481',1,'BoxingTimer::Stop()']]]
 ];
--- a/documentation/latex/boxingtimer_8cpp.tex
+++ b/documentation/latex/boxingtimer_8cpp.tex
@ -3,5 +3,6 @@
 {\ttfamily \#include $<$Q\+Object$>$}\newline
 {\ttfamily \#include $<$Q\+Time$>$}\newline
 {\ttfamily \#include $<$Q\+Settings$>$}\newline
+{\ttfamily \#include $<$Q\+Sound$>$}\newline
 {\ttfamily \#include \char`\"{}boxingtimer.\+h\char`\"{}}\newline
 {\ttfamily \#include \char`\"{}boxingsettings.\+h\char`\"{}}\newline
--- a/documentation/latex/class_boxing_settings.pdf
+++ b/documentation/latex/class_boxing_settings.pdf
--- a/documentation/latex/class_boxing_timer.pdf
+++ b/documentation/latex/class_boxing_timer.pdf
--- a/documentation/latex/refman.tex
+++ b/documentation/latex/refman.tex
@ -125,7 +125,7 @@
 \begin{titlepage}
 \vspace*{7cm}
 \begin{center}%
-{\Large Boxing Timer \\[1ex]\large 1.\+0 }\\
+{\Large Boxing Timer \\[1ex]\large 0.\+1a }\\
 \vspace*{1cm}
 {\large Generated by Doxygen 1.8.13}\\
 \end{center}
--- a/qml/cover/CoverPage.qml
+++ b/qml/cover/CoverPage.qml
@ -48,7 +48,9 @@ CoverBackground {

            font.pixelSize: Theme.fontSizeHuge
            text: boxingTimer.remainingTimeToString
-            color: boxingTimer.status === BoxingTimer.Rest ? Theme.secondaryColor : Theme.primaryColor
+            color: boxingTimer.status === BoxingTimer.Rest ?
+                       Theme.secondaryColor :
+                       Theme.primaryColor
        }

        Item { width: 25; height: 25 }
--- a/qml/harbour-boxing-timer.qml
+++ b/qml/harbour-boxing-timer.qml
@ -31,6 +31,7 @@
 import QtQuick 2.0
 import Sailfish.Silica 1.0
 import Pw.Unitoo.Backend 1.0
+
 import "pages"

 ApplicationWindow {
--- a/qml/pages/PresetList.qml
+++ b/qml/pages/PresetList.qml
@ -53,7 +53,9 @@ Page {
                Label {
                    text: name

-                    color: highlighted ? Theme.highlightColor : Theme.primaryColor
+                    color: highlighted ?
+                               Theme.highlightColor :
+                               Theme.primaryColor

                    anchors {
                        left: parent.left
--- a/qml/pages/SettingsPage.qml
+++ b/qml/pages/SettingsPage.qml
@ -101,7 +101,9 @@ Page {

                width: parent.width

-                minimumValue: Converter.sToMs(30); maximumValue: Converter.sToMs(300); stepSize: Converter.sToMs(10)
+                minimumValue: Converter.sToMs(30)
+                maximumValue: Converter.sToMs(300)
+                stepSize: Converter.sToMs(10)

                value: mRoundMs
                valueText: Converter.msToTime(value)
--- a/qml/pages/TimerPage.qml
+++ b/qml/pages/TimerPage.qml
@ -31,6 +31,7 @@
 import QtQuick 2.0
 import Sailfish.Silica 1.0
 import Pw.Unitoo.Backend 1.0
+
 import "js/helpers.js" as Helper

 Page {
@ -85,7 +86,9 @@ Page {

                font.pixelSize: Theme.fontSizeHuge * 3.3
                text: boxingTimer.remainingTimeToString
-                color: boxingTimer.status == BoxingTimer.Rest ? Theme.secondaryColor : Theme.primaryColor
+                color: boxingTimer.status == BoxingTimer.Rest ?
+                           Theme.secondaryColor :
+                           Theme.primaryColor
            }

            Button {
--- a/rpm/harbour-boxing-timer.changes
+++ b/rpm/harbour-boxing-timer.changes
@ -8,5 +8,5 @@
 # * date Author's Name <author's email> version-release
 # - Summary of changes

-* Thu Jul 17 2017 Claudio Maradonna <claudio@unitoo.pw> 0.1a
+* Thu Aug 24 2017 Claudio Maradonna <claudio@unitoo.pw> 0.1a
 - Initial release
--- a/rpm/harbour-boxing-timer.spec
+++ b/rpm/harbour-boxing-timer.spec
@ -17,7 +17,7 @@ Version:    0.1a
 Release:    1
 Group:      Applications/Multimedia
 License:    GPLv3
-URL:        http://example.org/
+URL:        https://github.com/UnitooTeam/harbour-boxing-timer
 Source0:    %{name}-%{version}.tar.bz2
 Source100:  harbour-boxing-timer.yaml
 Requires:   sailfishsilica-qt5 >= 0.10.9
--- a/rpm/harbour-boxing-timer.yaml
+++ b/rpm/harbour-boxing-timer.yaml
@ -5,7 +5,7 @@ Release: 1
 # The contents of the Group field should be one of the groups listed here:
 # http://gitorious.org/meego-developer-tools/spectacle/blobs/master/data/GROUPS
 Group: Applications/Multimedia
-URL: http://example.org/
+URL: https://github.com/UnitooTeam/harbour-boxing-timer
 License: GPLv3
 # This must be generated before uploading a package to a remote build service.
 # Usually this line does not need to be modified.
--- a/src/boxingtimer.h
+++ b/src/boxingtimer.h
@ -162,6 +162,11 @@ class BoxingTimer : public QTimer {
        QSound *restBell;
        QSound *stopBell;

+        /**
+         * @fn void songsBell()
+         *
+         * @brief Play the bell check actual status
+         */
        void songsBell();

        Status mStatus;