Merge branch 'release/2.5.3'

SRGSSR · Oct 26, 2018 · 4844a4c · 4844a4c
2 parents 6134824 + 3c96ea2
commit 4844a4c
Show file tree

Hide file tree

Showing 6 changed files with 27 additions and 15 deletions.
diff --git a/Framework/Sources/Helpers/SRGMediaPlayerConstants.h b/Framework/Sources/Helpers/SRGMediaPlayerConstants.h
@@ -139,7 +139,7 @@ OBJC_EXTERN NSString * const SRGMediaPlayerExternalPlaybackStateDidChangeNotific
 
 /**
  *  Notification sent when the current segment changes. Use the keys available below to retrieve information from
- *  the notification `userInfo`dictionary.
+ *  the notification `userInfo` dictionary.
  */
 OBJC_EXTERN NSString * const SRGMediaPlayerSegmentDidStartNotification;                     // Notification sent when a segment starts.
 OBJC_EXTERN NSString * const SRGMediaPlayerSegmentDidEndNotification;                       // Notification sent when a segment ends.
@@ -176,24 +176,36 @@ OBJC_EXTERN NSString * const SRGMediaPlayerErrorKey;
  */
 OBJC_EXTERN NSString * const SRGMediaPlayerSeekTimeKey;                                     // Key to access the time to which the seek is made, as an `NSValue` (wrapping a `CMTime` value).
 
-// Information available for all segment-related notifications.
+/**
+ *  Information available for all segment-related notifications.
+ */
 OBJC_EXTERN NSString * const SRGMediaPlayerSegmentKey;                                      // The involved segment as an `id<SRGSegment>` object.
 
-// Information available for `SRGMediaPlayerSegmentDidStartNotification` and `SRGMediaPlayerSegmentDidEndNotification`.
+/**
+ *  Information available for `SRGMediaPlayerSegmentDidStartNotification` and `SRGMediaPlayerSegmentDidEndNotification`.
+ */
 OBJC_EXPORT NSString * const SRGMediaPlayerSelectedKey;                                     // Key to an `NSNumber` wrapping a boolean, set to `YES` iff the segment was selected.
 
-// Information available for `SRGMediaPlayerSegmentDidStartNotification`.
+/**
+ *  Information available for `SRGMediaPlayerSegmentDidStartNotification`.
+ */
 OBJC_EXTERN NSString * const SRGMediaPlayerPreviousSegmentKey;                              // The previously played segment, if any, as an `id<SRGSegment>` object.
 
-// Information available for `SRGMediaPlayerSegmentDidEndNotification`.
+/**
+ *  Information available for `SRGMediaPlayerSegmentDidEndNotification`.
+ */
 OBJC_EXTERN NSString * const SRGMediaPlayerNextSegmentKey;                                  // The segment which will be played next, if any, as an `id<SRGSegment>` object.
 OBJC_EXTERN NSString * const SRGMediaPlayerInterruptionKey;                                 // Key to an `NSNumber` wrapping a boolean, set to `YES` iff the end notification results because segment playback was interrupted.
 
-// Information available for `SRGMediaPlayerSegmentDidStartNotification`, `SRGMediaPlayerSegmentDidEndNotification` and `SRGMediaPlayerPlaybackStateDidChangeNotification`.
+/**
+ *  Information available for `SRGMediaPlayerSegmentDidStartNotification`, `SRGMediaPlayerSegmentDidEndNotification` and `SRGMediaPlayerPlaybackStateDidChangeNotification`.
+ */
 OBJC_EXTERN NSString * const SRGMediaPlayerSelectionKey;                                    // Key to an `NSNumber` wrapping a boolean, set to `YES` iff the notification results from a segment selection.
 
-// Information available for all notifications, except `SRGMediaPlayerPictureInPictureStateDidChangeNotification` and `SRGMediaPlayerExternalPlaybackStateDidChangeNotification`.
-// For `SRGMediaPlayerPlaybackStateDidChangeNotification` notifications, this key is only present when the player returns to idle, and provides the last known playback position.
+/**
+ *  Information available for all notifications, except `SRGMediaPlayerPictureInPictureStateDidChangeNotification` and `SRGMediaPlayerExternalPlaybackStateDidChangeNotification`.
+ *  For `SRGMediaPlayerPlaybackStateDidChangeNotification` notifications, this key is only present when the player returns to idle, and provides the last known playback position.
+ */
 OBJC_EXPORT NSString * const SRGMediaPlayerLastPlaybackTimeKey;                             // Key to an `NSValue` wrapping a `CMTime` specifying the last playback position before the event occurred.
 
 NS_ASSUME_NONNULL_END
diff --git a/SRGMediaPlayer.xcodeproj/project.pbxproj b/SRGMediaPlayer.xcodeproj/project.pbxproj
@@ -1289,7 +1289,7 @@
 				GCC_WARN_UNUSED_FUNCTION = YES;
 				GCC_WARN_UNUSED_VARIABLE = YES;
 				IPHONEOS_DEPLOYMENT_TARGET = 9.0;
-				MARKETING_VERSION = 2.5.2;
+				MARKETING_VERSION = 2.5.3;
 				ONLY_ACTIVE_ARCH = YES;
 				SDKROOT = iphoneos;
 				TARGETED_DEVICE_FAMILY = "1,2";
@@ -1426,7 +1426,7 @@
 				GCC_WARN_UNUSED_FUNCTION = YES;
 				GCC_WARN_UNUSED_VARIABLE = YES;
 				IPHONEOS_DEPLOYMENT_TARGET = 9.0;
-				MARKETING_VERSION = 2.5.2;
+				MARKETING_VERSION = 2.5.3;
 				SDKROOT = iphoneos;
 				TARGETED_DEVICE_FAMILY = "1,2";
 				VALIDATE_PRODUCT = YES;
@@ -1652,7 +1652,7 @@
 				GCC_WARN_UNUSED_FUNCTION = YES;
 				GCC_WARN_UNUSED_VARIABLE = YES;
 				IPHONEOS_DEPLOYMENT_TARGET = 9.0;
-				MARKETING_VERSION = 2.5.2;
+				MARKETING_VERSION = 2.5.3;
 				ONLY_ACTIVE_ARCH = YES;
 				SDKROOT = iphoneos;
 				TARGETED_DEVICE_FAMILY = "1,2";
@@ -1703,7 +1703,7 @@
 				GCC_WARN_UNUSED_FUNCTION = YES;
 				GCC_WARN_UNUSED_VARIABLE = YES;
 				IPHONEOS_DEPLOYMENT_TARGET = 9.0;
-				MARKETING_VERSION = 2.5.2;
+				MARKETING_VERSION = 2.5.3;
 				SDKROOT = iphoneos;
 				TARGETED_DEVICE_FAMILY = "1,2";
 				VALIDATE_PRODUCT = YES;

diff --git a/docs/Getting-started-images/outlets.jpg → docs/GETTING_STARTED-images/outlets.jpg b/docs/Getting-started-images/outlets.jpg → docs/GETTING_STARTED-images/outlets.jpg
diff --git a/docs/Getting-started.md → docs/GETTING_STARTED.md b/docs/Getting-started.md → docs/GETTING_STARTED.md
@@ -38,7 +38,7 @@ The `SRGMediaPlayerViewController` class natively supports all kind of audio and
 
 Custom player layouts can be designed entirely in Interface Builder, whether you are using xibs or storyboards. You can create your custom player entirely in code if you want, but using Interface Builder is recommended.
 
-![Connecting outlets](Getting-started-images/outlets.jpg)
+![Connecting outlets](GETTING_STARTED-images/outlets.jpg)
 
 Start by adding a view controller to a storyboard file. Drop a custom object from the library and set its class to `SRGMediaPlayerController`. This controller object will manage playback of medias.
 

diff --git a/docs/Migration-guide.md → docs/MIGRATION_GUIDE.md b/docs/Migration-guide.md → docs/MIGRATION_GUIDE.md
diff --git a/docs/README.md b/docs/README.md
@@ -85,7 +85,7 @@ import SRGMediaPlayer
 
 ### Working with the library
 
-To learn about how the library can be used, have a look at the [getting started guide](Getting-started.md).
+To learn about how the library can be used, have a look at the [getting started guide](GETTING_STARTED.md).
 
 ### Logging
 
@@ -122,7 +122,7 @@ To test what the library is capable of, run the associated demo.
 
 ## Migration from versions 1.x
 
-For information about changes introduced with version 2 of the library, please read the [migration guide](Migration-guide.md).
+For information about changes introduced with version 2 of the library, please read the [migration guide](MIGRATION_GUIDE.md).
 
 ## License