Merge pull request #14 from matejdro/docs

Improve protocol documentation

Author: crc-32

src/commonMain/kotlin/io/rebble/libpebblecommon/packets/Music.kt

@@ -31,6 +31,9 @@ open class MusicControl(val message: Message) : PebblePacket(ProtocolEndpoint.MU
         artist: String = "",
         album: String = "",
         title: String = "",
+        /**
+         * Length of current track in milliseconds
+         */
         trackLength: Int? = null,
         trackCount: Int? = null,
         currentTrack: Int? = null
@@ -57,7 +60,13 @@ open class MusicControl(val message: Message) : PebblePacket(ProtocolEndpoint.MU
 
     class UpdatePlayStateInfo(
         playbackState: PlaybackState = PlaybackState.Unknown,
+        /**
+         * Current playback position in milliseconds
+         */
         trackPosition: UInt = 0u,
+        /**
+         * Play rate in percentage (100 = normal speed)
+         */
         playRate: UInt = 0u,
         shuffle: ShuffleState = ShuffleState.Unknown,
         repeat: RepeatState = RepeatState.Unknown

src/commonMain/kotlin/io/rebble/libpebblecommon/packets/System.kt

@@ -278,6 +278,10 @@ open class WatchVersion(message: Message) : SystemPacket(endpoint) {
 
         /**
          * When *true*, it means watch has been connected to a different phone before this phone.
+         *
+         * Flag remains true until
+         * [io.rebble.libpebblecommon.packets.blobdb.BlobCommand.ClearCommand] is
+         * sent to the watch
          */
         val isUnfaithful = SBoolean(m)
     }

src/commonMain/kotlin/io/rebble/libpebblecommon/packets/blobdb/Timeline.kt

@@ -31,10 +31,27 @@ class TimelineItem(
 
     val itemId = SUUID(m, itemId)
     val parentId = SUUID(m, parentId)
+
+    /**
+     * Timeline pin timestamp in unix time
+     */
     val timestamp = SUInt(m, timestamp, endianness = '<')
+
+    /**
+     * Duration of the pin in minutes
+     */
     val duration = SUShort(m, duration, endianness = '<')
+
+    /**
+     * Serialization of [Type]. Use [Type.value].
+     */
     val type = SUByte(m, type.value)
+
+    /**
+     * Serialization of [Flag] entries. Use [Flag.makeFlags].
+     */
     val flags = SUShort(m, flags, endianness = '<')
+
     val layout = SUByte(m, layout)
     val dataLength = SUShort(m, endianness = '<')
     val attrCount = SUByte(m, attributes.size.toUByte())
@@ -116,11 +133,30 @@ class TimelineItem(
     }
 
     enum class Flag(val value: Int) {
+        /**
+         * ???
+         *
+         * Name suggests that setting this to false would hide the pin on the watch,
+         * but it does not seem to do anything
+         */
         IS_VISIBLE(0),
+
+        /**
+         * When set, pin is always displayed in UTC timezone on the watch
+         */
         IS_FLOATING(1),
+
+        /**
+         * Whether pin spans throughout the whole day
+         */
         IS_ALL_DAY(2),
+
         FROM_WATCH(3),
         FROM_ANCS(4),
+
+        /**
+         * When set, quick view will be displayed on the watchface when event in progress.
+         */
         PERSIST_QUICK_VIEW(5);
 
         companion object {