[MobilePlayerViewController] Improve play and pause documentation

onlyyoujack · Dec 10, 2015 · ae3429c · ae3429c
1 parent 1961cd4
commit ae3429c
Showing 1 changed file with 5 additions and 0 deletions.
diff --git a/MobilePlayer/MobilePlayerViewController.swift b/MobilePlayer/MobilePlayerViewController.swift
@@ -286,11 +286,16 @@ public class MobilePlayerViewController: MPMoviePlayerViewController {
   }
 
   /// Initiates playback of current content.
+  ///
+  /// Starting playback causes dismiss to be called on prerollViewController, pauseOverlayViewController
+  /// and postrollViewController.
   public func play() {
     moviePlayer.play()
   }
 
   /// Pauses playback of current content.
+  ///
+  /// Pausing playback causes pauseOverlayViewController to be shown.
   public func pause() {
     moviePlayer.pause()
   }