Commit 43562c77 authored by Felix Paul Kühne's avatar Felix Paul Kühne

Add documentation

parent 060d2dc5
......@@ -25,16 +25,46 @@
@interface MDFMediaObject : NSObject
/**
* indicates whether the database assumes that the object is NSFW [BOOL]
*/
@property (readwrite, nonatomic) BOOL isAdultContent;
/**
* the original language of the content [ISO 639-1 code as STRING]
*/
@property (readwrite, nonatomic, nullable) NSString *originalLanguage;
/**
* the original title of the content [STRING]
*/
@property (readwrite, nonatomic, nullable) NSString *originalTitle;
/**
* the title of the content, which maybe in the requested language [STRING]
*/
@property (readwrite, nonatomic, nullable) NSString *title;
/**
* description of the content, which maybe in the requested language [STRING]
*/
@property (readwrite, nonatomic, nullable) NSString *contentDescription;
/**
* the original release date of the content [STRING]
*/
@property (readwrite, nonatomic, nullable) NSDate *releaseDate;
/**
* the path to the poster image [STRING]
* \note you need to merge it with the image base URL provided by the MDFMovieDBSessionManager
*/
@property (readwrite, nonatomic, nullable) NSString *posterPath;
/**
* the path to the backdrop image [STRING]
* \note you need to merge it with the image base URL provided by the MDFMovieDBSessionManager
*/
@property (readwrite, nonatomic, nullable) NSString *backdropPath;
/**
* An internal ID, which can be used to ask the MDFMovieDBFetcher for more details
* about this content object [NSInteger]
*/
@property (readwrite, nonatomic) NSInteger movieDBID;
@end
......@@ -41,13 +41,35 @@
* \return property availibility [BOOLEAN]
*/
@property (readonly, nonatomic) BOOL hasFetchedProperties;
/**
* the base URL for images, http [STRING]
*/
@property (readonly, nonatomic, nullable) NSString *imageBaseURL;
/**
* the base URL for images, https [STRING]
*/
@property (readonly, nonatomic, nullable) NSString *secureImageBaseURL;
/**
* available images sizes for backdrops, ordered small to large [Array]
*/
@property (readonly, nonatomic, nullable) NSArray *backdropSizes;
/**
* available images sizes for logos, ordered small to large [Array]
*/
@property (readonly, nonatomic, nullable) NSArray *logoSizes;
/**
* available images sizes for posters, ordered small to large [Array]
*/
@property (readonly, nonatomic, nullable) NSArray *posterSizes;
/**
* available images sizes for stills, ordered small to large [Array]
*/
@property (readonly, nonatomic, nullable) NSArray *stillSizes;
/**
* available images sizes for profiles, ordered small to large [Array]
*/
@property (readonly, nonatomic, nullable) NSArray *profileSizes;
/**
......
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