Use explicit cross references in documentation

Author: 0xced

.cocoadocs.yml

@@ -0,0 +1 @@
+explicit-references: true

XCDYouTubeKit/XCDYouTubeClient.h

@@ -9,9 +9,9 @@
 #import <XCDYouTubeKit/XCDYouTubeError.h>
 
 /**
- *  The `XCDYouTubeClient` class is responsible for interacting with the YouTube API. Given a YouTube video identifier, you will get video information with the `-getVideoWithIdentifier:completionHandler:` method.
+ *  The `XCDYouTubeClient` class is responsible for interacting with the YouTube API. Given a YouTube video identifier, you will get video information with the `<-getVideoWithIdentifier:completionHandler:>` method.
  *
- *  On iOS, you probably don’t want to use `XCDYouTubeClient` directly but the higher level class `XCDYouTubeVideoPlayerViewController`.
+ *  On iOS, you probably don’t want to use `XCDYouTubeClient` directly but the higher level class `<XCDYouTubeVideoPlayerViewController>`.
  */
 @interface XCDYouTubeClient : NSObject
 
@@ -62,11 +62,11 @@
  *  @param videoIdentifier   A 11 characters YouTube video identifier. If the video identifier is invalid (including nil) the completion handler will be called with an error with `XCDYouTubeVideoErrorDomain` domain and `XCDYouTubeErrorInvalidVideoIdentifier` code.
  *  @param completionHandler A block to execute when the client finishes the operation. The completion handler is executed on the main thread. If the completion handler is nil, this method throws an exception.
  *
- *  @discussion If the operation completes successfully, the video parameter of the handler block contains a `XCDYouTubeVideo` object, and the error parameter is nil. If the operation fails, the video parameter is nil and the error parameter contains information about the failure. The error's domain is always `XCDYouTubeVideoErrorDomain`.
+ *  @discussion If the operation completes successfully, the video parameter of the handler block contains a `<XCDYouTubeVideo>` object, and the error parameter is nil. If the operation fails, the video parameter is nil and the error parameter contains information about the failure. The error's domain is always `XCDYouTubeVideoErrorDomain`.
  *
  *  @see XCDYouTubeErrorCode
  *
- *  @return An opaque object conforming to the `XCDYouTubeOperation` protocol for canceling the asynchronous video information operation. If you call the `cancel` method before the operation is finished, the completion handler will not be called. It is recommended that you store this opaque object as a weak property.
+ *  @return An opaque object conforming to the `<XCDYouTubeOperation>` protocol for canceling the asynchronous video information operation. If you call the `cancel` method before the operation is finished, the completion handler will not be called. It is recommended that you store this opaque object as a weak property.
  */
 - (id<XCDYouTubeOperation>) getVideoWithIdentifier:(NSString *)videoIdentifier completionHandler:(void (^)(XCDYouTubeVideo *video, NSError *error))completionHandler __attribute__((nonnull(2)));
 

XCDYouTubeKit/XCDYouTubeOperation.h

@@ -5,7 +5,7 @@
 #import <Foundation/Foundation.h>
 
 /**
- *  The `XCDYouTubeOperation` protocol is adopted by opaque objects returned by the `-[XCDYouTubeClient getVideoWithIdentifier:completionHandler:]` method.
+ *  The `XCDYouTubeOperation` protocol is adopted by opaque objects returned by the `<-[XCDYouTubeClient getVideoWithIdentifier:completionHandler:]>` method.
  */
 @protocol XCDYouTubeOperation <NSObject>
 

XCDYouTubeKit/XCDYouTubeVideo.h

@@ -5,7 +5,7 @@
 #import <Foundation/Foundation.h>
 
 /**
- *  The quality of YouTube videos. These values are used as keys in the `streamURLs` property of the `XCDYouTubeVideo` class.
+ *  The quality of YouTube videos. These values are used as keys in the `<[XCDYouTubeVideo streamURLs]>` property.
  *
  *  The constant numbers are the YouTube [itag](https://en.wikipedia.org/wiki/YouTube#Quality_and_formats) values.
  */
@@ -43,7 +43,7 @@ typedef NS_ENUM(NSUInteger, XCDYouTubeVideoQuality) {
 extern NSString *const XCDYouTubeVideoQualityHTTPLiveStreaming;
 
 /**
- *  Represents a YouTube video. Use the `-[XCDYouTubeClient getVideoWithIdentifier:completionHandler:]` method to obtain a `XCDYouTubeVideo` object.
+ *  Represents a YouTube video. Use the `<-[XCDYouTubeClient getVideoWithIdentifier:completionHandler:]>` method to obtain a `XCDYouTubeVideo` object.
  */
 @interface XCDYouTubeVideo : NSObject <NSCopying>
 

XCDYouTubeKit/XCDYouTubeVideoOperation.h

@@ -10,7 +10,7 @@
 /**
  *  XCDYouTubeVideoOperation is a subclass of `NSOperation` that connects to the YouTube API and parse the response.
  *
- *  You should probably use the higher level class `XCDYouTubeClient`. Use this class only if you are very familiar with `NSOperation` and need to manage dependencies between operations.
+ *  You should probably use the higher level class `<XCDYouTubeClient>`. Use this class only if you are very familiar with `NSOperation` and need to manage dependencies between operations.
  *
  *  Since version 2.2.0 this operation is synchronous and must not be started on the main thread. Starting the operation on the main thread throws an exception.
  */

XCDYouTubeKit/XCDYouTubeVideoPlayerViewController.h

@@ -31,7 +31,7 @@ MP_EXTERN NSString *const XCDYouTubeVideoUserInfoKey;
  *
  *  Use UIViewController’s `presentMoviePlayerViewControllerAnimated:` method to play a YouTube video fullscreen.
  *
- *  Use the `presentInView:` method to play a YouTube video inline.
+ *  Use the `<presentInView:>` method to play a YouTube video inline.
  */
 @interface XCDYouTubeVideoPlayerViewController : MPMoviePlayerViewController
 
@@ -48,7 +48,7 @@ MP_EXTERN NSString *const XCDYouTubeVideoUserInfoKey;
  *
  *  @return An initialized YouTube video player view controller with the specified video identifier.
  *
- *  @discussion You can pass a nil videoIdentifier (or use the standard `init` method instead) and set the `videoIdentifier` property later.
+ *  @discussion You can pass a nil *videoIdentifier* (or use the standard `init` method instead) and set the `<videoIdentifier>` property later.
  */
 - (instancetype) initWithVideoIdentifier:(NSString *)videoIdentifier __attribute__((objc_designated_initializer));
 
@@ -74,7 +74,7 @@ MP_EXTERN NSString *const XCDYouTubeVideoUserInfoKey;
  *
  *  Defaults to @[ XCDYouTubeVideoQualityHTTPLiveStreaming, @(XCDYouTubeVideoQualityHD720), @(XCDYouTubeVideoQualityMedium360), @(XCDYouTubeVideoQualitySmall240) ]
  *
- *  You should set this property right after calling the `initWithVideoIdentifier:` method. Setting this property to nil restores its default values.
+ *  You should set this property right after calling the `<initWithVideoIdentifier:>` method. Setting this property to nil restores its default values.
  *
  *  @see `XCDYouTubeVideoQuality`
  */