Mercurial Repositories > Time Tracker / file diff

--- a/TimeTracker/Documentation/source/Plugin_Time_Tracker.TimeTracker.TimeTracker.html	Thu Jun 03 18:02:18 2021 +0200
+++ b/TimeTracker/Documentation/source/Plugin_Time_Tracker.TimeTracker.TimeTracker.html	Fri Jun 04 16:40:54 2021 +0200
@@ -74,7 +74,7 @@
 </tr>
 <tr>
 <td><a href="#TimeTracker.__activateWidget">__activateWidget</a></td>
-<td>Private slot to handle the activation of the project browser.</td>
+<td>Private slot to handle the activation of the time tracker widget.</td>
 </tr>
 <tr>
 <td><a href="#TimeTracker.__initialize">__initialize</a></td>
@@ -190,7 +190,7 @@
 <b>__activateWidget</b>(<i></i>)
 
 <p>
-        Private slot to handle the activation of the project browser.
+        Private slot to handle the activation of the time tracker widget.
 </p>
 <a NAME="TimeTracker.__initialize" ID="TimeTracker.__initialize"></a>
 <h4>TimeTracker.__initialize</h4>
@@ -222,21 +222,21 @@
 </p>
 <dl>
 
-<dt><i>startDateTime</i></dt>
+<dt><i>startDateTime</i> (QDateTime)</dt>
 <dd>
-start date and time (QDateTime)
+start date and time
 </dd>
-<dt><i>duration</i></dt>
+<dt><i>duration</i> (int)</dt>
 <dd>
-duration in minutes (integer)
+duration in minutes
 </dd>
-<dt><i>task</i></dt>
+<dt><i>task</i> (str)</dt>
 <dd>
-task description (string)
+task description
 </dd>
-<dt><i>comment</i></dt>
+<dt><i>comment</i> (str)</dt>
 <dd>
-comment (string)
+comment
 </dd>
 </dl>
 <a NAME="TimeTracker.continueTrackerEntry" ID="TimeTracker.continueTrackerEntry"></a>
@@ -262,9 +262,9 @@
 </p>
 <dl>
 
-<dt><i>eid</i></dt>
+<dt><i>eid</i> (int)</dt>
 <dd>
-ID of the tracker entry (integer)
+ID of the tracker entry
 </dd>
 </dl>
 <a NAME="TimeTracker.entryChanged" ID="TimeTracker.entryChanged"></a>
@@ -284,7 +284,13 @@
 <dl>
 <dt>Return:</dt>
 <dd>
-reference to the current entry (TimeTrackEntry)
+reference to the current entry
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+TimeTrackEntry
 </dd>
 </dl>
 <a NAME="TimeTracker.getEntry" ID="TimeTracker.getEntry"></a>
@@ -296,15 +302,21 @@
 </p>
 <dl>
 
-<dt><i>eid</i></dt>
+<dt><i>eid</i> (int)</dt>
 <dd>
-ID of the tracker entry (integer)
+ID of the tracker entry
 </dd>
 </dl>
 <dl>
 <dt>Return:</dt>
 <dd>
-entry for the given ID (TimeTrackEntry) or None
+entry for the given ID or None
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+TimeTrackEntry
 </dd>
 </dl>
 <a NAME="TimeTracker.getPreferences" ID="TimeTracker.getPreferences"></a>
@@ -316,15 +328,21 @@
 </p>
 <dl>
 
-<dt><i>key</i></dt>
+<dt><i>key</i> (str)</dt>
 <dd>
-the key of the value to get
+key of the value to get
 </dd>
 </dl>
 <dl>
 <dt>Return:</dt>
 <dd>
-the requested setting
+value of the requested setting
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+Any
 </dd>
 </dl>
 <a NAME="TimeTracker.importTrackerEntries" ID="TimeTracker.importTrackerEntries"></a>
@@ -393,14 +411,13 @@
 </p>
 <dl>
 
-<dt><i>filePath=</i></dt>
+<dt><i>filePath</i> (str)</dt>
 <dd>
 path and name of the file to write the entries to
-            (string)
 </dd>
-<dt><i>ids=</i></dt>
+<dt><i>ids</i> (list of int)</dt>
 <dd>
-list of entry IDs to be written (list of integer)
+list of entry IDs to be written
 </dd>
 </dl>
 <a NAME="TimeTracker.startTrackerEntry" ID="TimeTracker.startTrackerEntry"></a>
@@ -421,7 +438,13 @@
 <dt>Return:</dt>
 <dd>
 tuple of the ID assigned to the stopped tracker entry and
-            the duration (integer, integer)
+            the duration
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+tuple of (int, int)
 </dd>
 </dl>
 <div align="right"><a href="#top">Up</a></div>