From 36173eb3c6ea153fad5cc76f5763a8fa695d072c Mon Sep 17 00:00:00 2001
From: Hiroshi Horie <548776+hiroshihorie@users.noreply.github.com>
Date: Fri, 3 Dec 2021 11:47:47 +0700
Subject: [PATCH] more docs

---
 lib/src/options.dart     | 10 +++++++---
 lib/src/track/track.dart |  6 ++++--
 2 files changed, 11 insertions(+), 5 deletions(-)

diff --git a/lib/src/options.dart b/lib/src/options.dart
index 0ad042e..a842eb1 100644
--- a/lib/src/options.dart
+++ b/lib/src/options.dart
@@ -1,4 +1,5 @@
 import 'track/options.dart';
+import 'track/track.dart';
 
 /// Options when joining a room.
 /// {@category Room}
@@ -21,6 +22,7 @@ class ConnectOptions {
   final bool optimizeVideo;
 
   /// Set this to false in case you would like to stop the track yourself.
+  /// If you set this to false, make sure you call [Track.stop].
   /// defaults to true.
   final bool stopLocalTrackOnUnpublish;
 
@@ -37,7 +39,9 @@ class VideoPublishOptions {
   ///
   final VideoEncoding? videoEncoding;
 
-  ///
+  /// Whether to enable simulcast or not.
+  /// https://blog.livekit.io/an-introduction-to-webrtc-simulcast-6c5f1f6402eb
+  /// defaults to true.
   final bool simulcast;
 
   const VideoPublishOptions({
@@ -51,9 +55,9 @@ class VideoPublishOptions {
 }
 
 class AudioPublishOptions {
-  /// DTX (Discontinuous Transmission)
+  /// Whether to enable DTX (Discontinuous Transmission) or not.
   /// https://en.wikipedia.org/wiki/Discontinuous_transmission
-  /// defaults to true
+  /// defaults to true.
   final bool dtx;
 
   const AudioPublishOptions({
diff --git a/lib/src/track/track.dart b/lib/src/track/track.dart
index fc62758..c728e0d 100644
--- a/lib/src/track/track.dart
+++ b/lib/src/track/track.dart
@@ -88,7 +88,8 @@ abstract class Track extends DisposableChangeNotifier
     return cid;
   }
 
-  // returns true if started, false if already started
+  /// Start this [Track] if not started.
+  /// Returns true if started, false if already started
   @mustCallSuper
   Future<bool> start() async {
     if (_active) {
@@ -102,7 +103,8 @@ abstract class Track extends DisposableChangeNotifier
     return true;
   }
 
-  // returns true if stopped, false if already stopped
+  /// Stop this [Track] if not stopped.
+  /// Returns true if stopped, false if already stopped
   @mustCallSuper
   Future<bool> stop() async {
     if (!_active) {