[ADDED] Sample kdoc for parser

hossain-khan · May 7, 2024 · c8600de · c8600de
1 parent c72449d
commit c8600de
Showing 1 changed file with 13 additions and 0 deletions.
diff --git a/parser/src/main/kotlin/Parser.kt b/parser/src/main/kotlin/Parser.kt
@@ -15,6 +15,19 @@ import okio.BufferedSource
 
 /**
  * Parser to parse Google Location Timeline JSON to Kotlin objects.
+ *
+ * Sample usages for parsing different JSON types:
+ * ```kotlin
+ * val parser = Parser()
+ *
+ * // ...
+ * val bufferedSourceRecords: BufferedSource = recordsFile.source().buffer()
+ * val records = parser.parseRecords(bufferedSourceRecords)
+ *
+ * // ...
+ * val bufferedSourceSemantic: BufferedSource = semanticMonthFile.source().buffer()
+ * val semanticTimeline = parser.parseSemanticTimeline(bufferedSourceSemantic)
+ * ```
  */
 class Parser constructor() {
   // Moshi instance with custom adapter to parse the timeline data.