Update dartdocs and comments

leancodepl · Nov 22, 2024 · 223fedc · 223fedc
1 parent 812bedc
commit 223fedc
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 3 deletions.
diff --git a/packages/video_player/video_player_avfoundation/lib/src/avfoundation_video_player.dart b/packages/video_player/video_player_avfoundation/lib/src/avfoundation_video_player.dart
@@ -25,7 +25,7 @@ class AVFoundationVideoPlayer extends VideoPlayerPlatform {
     return _api.initialize();
   }
 
-  // FIXME Rename textureId everywhere to playerId.
+  // FIXME Rename textureId to playerId everywhere.
   @override
   Future<void> dispose(int textureId) {
     return _api.dispose(textureId);

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
@@ -48,7 +48,9 @@ abstract class VideoPlayerPlatform extends PlatformInterface {
     throw UnimplementedError('dispose() has not been implemented.');
   }
 
-  /// Creates an instance of a video player and returns its textureId.
+  /// Creates an instance of a video player with and returns its textureId.
+  /// The [viewType] parameter specifies the type of view to be used for the
+  /// video player.
   Future<int?> create(
     DataSource dataSource, {
     VideoViewType viewType = VideoViewType.textureView,
@@ -96,7 +98,8 @@ abstract class VideoPlayerPlatform extends PlatformInterface {
     throw UnimplementedError('getPosition() has not been implemented.');
   }
 
-  /// Returns a widget displaying the video with a given textureID.
+  /// Returns a widget displaying the video with a given textureID, using given
+  /// viewType.
   Widget buildView(int textureId, VideoViewType viewType) {
     throw UnimplementedError('buildView() has not been implemented.');
   }