Add documentation

synw · Mar 28, 2020 · 433dd88 · 433dd88
1 parent 504ee68
commit 433dd88
Showing 1 changed file with 12 additions and 1 deletion.
diff --git a/lib/src/type.dart b/lib/src/type.dart
@@ -1,3 +1,4 @@
+/// Get typed data from a value
 dynamic castTypeForValue(dynamic value, Type colType) {
   dynamic v;
   switch (colType) {
@@ -15,4 +16,14 @@ dynamic castTypeForValue(dynamic value, Type colType) {
   return v;
 }
 
-enum TimestampFormat { seconds, milliseconds, microseconds }
+/// The format to use for timestamps
+enum TimestampFormat {
+  /// Timestamp in seconds from epoch
+  seconds,
+
+  /// Timestamp in milliseconds from epoch
+  milliseconds,
+
+  /// Timestamp in microseconds from epoch
+  microseconds
+}