Commit 67e25f83 authored by Felix Paul Kühne's avatar Felix Paul Kühne

Fix warnings regarding documentation

parent cd4ccaee
......@@ -42,7 +42,7 @@
/**
* the object receiving the responses to requests send to instances of the fetcher
* \param any NSObject implementing the MDFMovieDBFetcherDataRecipient protocol
* param: any NSObject implementing the MDFMovieDBFetcherDataRecipient protocol
* \return the current receiver
* \note should be set before doing any requests
*/
......@@ -51,7 +51,7 @@
/**
* The fetcher can process input strings by removing stray characters, file extensions, etc.,
* which can lead to improve search results.
* \param turn on/off the feature [BOOLEAN]
* param: turn on/off the feature [BOOLEAN]
* \return current state of the feature [BOOLEAN]
* \note OFF by default
*/
......@@ -64,17 +64,17 @@
/**
* a convenience method to simply search for a movie
* \param a string to search for [STRING]
* \param searchRequest string to search for [STRING]
* \note in case of multiple results, the most popular is returned
*/
- (void)searchForMovie:(NSString * _Nonnull)searchRequest;
/**
* the full method to search for a movie
* \param a string to search for [STRING]
* \param the release year [STRING]
* \param the language to search in [ISO 639-1 code as STRING]
* \param include adult content in search results [BOOLEAN]
* \param searchRequest string to search for [STRING]
* \param releaseYear release year [STRING]
* \param languageCode language to search in [ISO 639-1 code as STRING]
* \param includeAdult include adult content in search results [BOOLEAN]
* \note in case of multiple results, the most popular is returned
*/
- (void)searchForMovie:(NSString * _Nonnull)searchRequest
......@@ -84,15 +84,15 @@
/**
* the full method to search for a TV show
* \param a string to search for [STRING]
* \param searchRequest string to search for [STRING]
*/
- (void)searchForTVShow:(NSString * _Nonnull)searchRequest;
/**
* the full method to search for a TV show
* \param a string to search for [STRING]
* \param the year the show was aired first [STRING]
* \param the language to search in [ISO 639-1 code as STRING]
* \param searchRequest string to search for [STRING]
* \param firstAirYear year the show was aired first [STRING]
* \param languageCode language to search in [ISO 639-1 code as STRING]
*/
- (void)searchForTVShow:(NSString * _Nonnull)searchRequest firstAirYear:(NSString * _Nullable)firstAirYear language:(NSString * _Nullable)languageCode;
......
......@@ -29,7 +29,7 @@
/**
* the API key to use for the fetches
* \param the API key to set [STRING]
* param: the API key to set [STRING]
* \return the current API key [STRING]
* \note API key must be set before doing any requests
*/
......
......@@ -22,7 +22,7 @@
*****************************************************************************/
#import "MDFMovieDBSessionManager.h"
#import "AFNetworking/AFNetworking.h"
#import "AFNetworking.h"
static NSString * const MovieDBBaseURLString = @"https://api.themoviedb.org/3/";
static AFHTTPSessionManager *_sharedClient = nil;
......@@ -76,7 +76,7 @@ static AFHTTPSessionManager *_sharedClient = nil;
- (NSURLSessionDataTask *)GET:(NSString *)URLString parameters:(id)parameters success:(void (^)(NSURLSessionDataTask * _Nullable, id _Nullable))success failure:(void (^)(NSURLSessionDataTask * _Nullable, NSError * _Nullable))failure
{
return [_sharedClient GET:URLString parameters:parameters success:success failure:failure];
return [_sharedClient GET:URLString parameters:parameters progress:nil success:success failure:failure];
}
@end
......@@ -45,7 +45,7 @@
/**
* the object receiving the responses to requests send to instances of the fetcher
* \param any NSObject implementing the MDFOSOFetcherDataRecipient protocol
* param: any NSObject implementing the MDFOSOFetcherDataRecipient protocol
* \return the current receiver
* \note should be set before doing any requests
*/
......@@ -55,7 +55,7 @@
/**
* the user-agent key to use for the fetches
* \param the user-agent key to set [STRING]
* param: the user-agent key to set [STRING]
* \return the current user-agent key [STRING]
* \note user-agent key must be set before doing any requests
*/
......@@ -68,7 +68,7 @@
/**
* the language ID (ISO-639-3) to use for the fetches
* \param the language ID to set [STRING]
* param: the language ID to set [STRING]
* \return the current language ID [STRING]
* \note if none is set, the default value "eng" will be used
*/
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment