Document VideoViewType on Dart side

leancodepl · Nov 20, 2024 · 20c5270 · 20c5270
1 parent e937777
commit 20c5270
Show file tree

Hide file tree

Showing 2 changed files with 5 additions and 2 deletions.
diff --git a/packages/video_player/video_player_avfoundation/example/lib/mini_controller.dart b/packages/video_player/video_player_avfoundation/example/lib/mini_controller.dart
@@ -203,7 +203,7 @@ class MiniController extends ValueNotifier<VideoPlayerValue> {
   /// Only set for [asset] videos. The package that the asset was loaded from.
   final String? package;
 
-  // FIXME Document
+  /// The type of view used to display the video.
   final VideoViewType viewType;
 
   Timer? _timer;

diff --git a/...ges/video_player/video_player_platform_interface/lib/video_player_platform_interface.dart b/...ges/video_player/video_player_platform_interface/lib/video_player_platform_interface.dart
@@ -114,9 +114,12 @@ abstract class VideoPlayerPlatform extends PlatformInterface {
 
 class _PlaceholderImplementation extends VideoPlayerPlatform {}
 
-// FIXME Add docs
+/// Enum representing the type of video view to be used.
 enum VideoViewType {
+  /// Uses a texture view for rendering video.
   textureView,
+
+  ///  Uses a platform view for rendering video.
   platformView,
 }