diff options
author | Matthias Beyer <mail@beyermatthias.de> | 2017-06-26 19:18:14 +0200 |
---|---|---|
committer | Matthias Beyer <mail@beyermatthias.de> | 2017-06-26 19:28:57 +0200 |
commit | dd7954ddb6c2db51017ffa93536bf2a4936be1b8 (patch) | |
tree | 570dca839e55be7dd6e38e3e7d60885386acb2c0 /doc | |
parent | 78c2425bbd08621aa2145d5d21b931b6b5024438 (diff) |
Add Documentation
Diffstat (limited to 'doc')
-rw-r--r-- | doc/src/05100-lib-timetrack.md | 14 |
1 files changed, 14 insertions, 0 deletions
diff --git a/doc/src/05100-lib-timetrack.md b/doc/src/05100-lib-timetrack.md index 6d3e2c8c..7dd58488 100644 --- a/doc/src/05100-lib-timetrack.md +++ b/doc/src/05100-lib-timetrack.md @@ -50,3 +50,17 @@ The `end` field is, of course, only set if the event already ended. The library uses the `libimagentrydatetime::datepath::DatePathBuilder` for building `StoreId` objects. +The library offers two central traits: + +* `TimeTrackStore`, which extends a `Store` object with functionality to + create `FileLockEntry` objects with a certain setting that is used for + time-tracking, and +* `TimeTracking`, which extends `Entry` with helper functions to query the + entry-metadata that is used for the time tracking functionality + +The library does _not_ provide functionality to implement `imag-timetrack` or +so, as the core functionality is already given and the commandline application +can implement the missing bits in few lines of code. + +Aggregating functionality might be provided at a later point in time. + |