Add comments and keep formatting consitant

Author: Vikas Dadheech

MSGraphCoreSDK/MSGraphCoreSDK/Models/MSCollection.h

@@ -2,40 +2,35 @@
 
 #import <MSGraphCoreSDK/MSObject.h>
 
-/**
+/*
  An `MSCollection` object is a collection of Graph objects.
  @see MSObject
  */
 @interface MSCollection : MSObject
 
-/**
- An array of Graph objects.
+/*
+ An array of dictionaries.
  */
 @property (strong, nonatomic) NSArray *value;
 
-/**
+/*
  There may be more items in the collection available via paging. This is the url to the next page of the collection.
  */
 @property (strong, nonatomic) NSURL *nextLink;
 
-/**
+/*
  Any additional data returned from the collection request will be in this dictionary.
  */
 @property (strong, nonatomic) NSDictionary *additionalData;
 
-/**
+/*
  Creates an MSCollection with the response from the service.
- @param array The array of OneDrive objects.
+ @param array The array of objects.
  @param nextLink The link to the next page of items, if there is one.
  @param additionalData Any other data returned from the service.
  */
 - (instancetype)initWithArray:(NSArray *)array
                      nextLink:(NSString *)nextLink
                additionalData:(NSDictionary *)additionalData;
-//
-///**
-// Return an array with all values compatible with NSJsonSerialization
-//*/
-//- (NSArray *) arrayFromItem;
 
 @end

MSGraphCoreSDK/MSGraphCoreSDK/Models/MSCollection.m

@@ -10,20 +10,23 @@ -(instancetype)initWithArray:(NSArray *)array
               additionalData:(NSDictionary *)additionalData
 {
     self = [super init];
-    if (self){
+    if (self)
+    {
         _value = array;
         _nextLink = [NSURL URLWithString:nextLink];
         _additionalData = additionalData;
     }
     return self;
 }
 
-- (instancetype)initWithData:(NSData *)data
+- (instancetype)initWithData:(NSData *)data error:(NSError *__autoreleasing *)error
 {
-    self = [super initWithData:data];
-    if(self){
-        self.value = [[self dictionaryFromItem] objectForKey:@"value"];
-        self.nextLink = [[self dictionaryFromItem] objectForKey:@"@odata.nextLink"];
+    self = [super initWithData:data error:error];
+    if(self)
+    {
+        self.value = [[self getDictionary] objectForKey:@"value"];
+        self.nextLink = [NSURL URLWithString:[[self dictionaryFromItem] objectForKey:@"@odata.nextLink"]];
+        self.additionalData = [self getDictionary];
     }
     return self;
 }
@@ -33,19 +36,11 @@ - (instancetype)initWithDictionary:(NSDictionary *)dictionary
     self = [super initWithDictionary:dictionary];
     if(self)
     {
-        self.value = [dictionary objectForKey:@"values"];
-        self.nextLink = [dictionary objectForKey:@"@odata.nextLink"];
+        self.value = [[self getDictionary] objectForKey:@"values"];
+        self.nextLink = [NSURL URLWithString:[[self getDictionary] objectForKey:@"@odata.nextLink"]];
+        self.additionalData = [self getDictionary];
     }
     return self;
 }
 
-//- (NSArray *) arrayFromItem
-//{
-//    NSMutableArray *retArray = [NSMutableArray arrayWithCapacity:[self.value count]];
-//    [self.value enumerateObjectsUsingBlock:^(id obj, NSUInteger idx, BOOL *stop){
-//        retArray[idx] = [MSObject getNSJsonSerializationCompatibleValue:obj];
-//    }];
-//    return retArray;
-//}
-
 @end

MSGraphCoreSDK/MSGraphCoreSDK/Models/MSDate.h

@@ -2,19 +2,45 @@
 
 #import <Foundation/Foundation.h>
 
+
+/*
+ A wrapper class around native NSDate class to ease the conversion and initialization of date.
+ */
 @interface MSDate : NSObject
 
+@property (nonatomic, readonly) NSInteger year;
+@property (nonatomic, readonly) NSInteger month;
+@property (nonatomic, readonly) NSInteger day;
+
+/*
+ Class method to initialize an instance of MSDate with NSDate
+ */
 + (instancetype) date;
+
+/*
+ Class method to initialize an instance of MSDate with year, month and day in Integer form.
+ */
 + (instancetype) dateWithYear:(NSInteger)year month:(NSInteger)month day:(NSInteger)day;
 
-- (id) initWithYear:(NSInteger)year month:(NSInteger)month day:(NSInteger)day;
+/*
+ Instance method to initialize an instance of MSDate with NSDate
+ */
 - (id) initWithNSDate:(NSDate*)date;
 
-@property (nonatomic, readonly) NSInteger year;
-@property (nonatomic, readonly) NSInteger month;
-@property (nonatomic, readonly) NSInteger day;
+/*
+ Instance method to initialize an instance of MSDate with year, month and day in Integer form.
+ */
+- (id) initWithYear:(NSInteger)year month:(NSInteger)month day:(NSInteger)day;
 
+/*
+ This method generates a string equivalent of MSDate instance.
+ */
 - (NSString *)ms_toString;
+
+/*
+ This method can be used to get an MSDate instance from a date string
+ @param dateString The date string which needs to be converted.
+ */
 + (instancetype)ms_dateFromString:(NSString *)dateString;
 
 @end

MSGraphCoreSDK/MSGraphCoreSDK/Models/MSDate.m

@@ -14,23 +14,29 @@ @implementation MSDate
 
 #pragma mark - Initializers
 
-+ (instancetype) date {
++ (instancetype) date
+{
     return [[MSDate alloc] initWithNSDate:[NSDate date]];
 }
 
-+ (instancetype) dateWithYear:(NSInteger)year month:(NSInteger)month day:(NSInteger)day {
++ (instancetype) dateWithYear:(NSInteger)year month:(NSInteger)month day:(NSInteger)day
+{
     return [[MSDate alloc] initWithYear:year month:month day:day];
 }
 
-- (id) initWithNSDate:(NSDate*)date {
-    if (self = [super init]) {
+- (id) initWithNSDate:(NSDate*)date
+{
+    if (self = [super init])
+    {
         self.date = date;
     }
     return self;
 }
 
-- (id) initWithYear:(NSInteger)year month:(NSInteger)month day:(NSInteger)day {
-    if (self = [super init]) {
+- (id) initWithYear:(NSInteger)year month:(NSInteger)month day:(NSInteger)day
+{
+    if (self = [super init])
+    {
         NSDateComponents *components = [[NSDateComponents alloc] init];
         components.year = year;
         components.month = month;
@@ -44,17 +50,20 @@ - (id) initWithYear:(NSInteger)year month:(NSInteger)month day:(NSInteger)day {
 
 #pragma mark - Properties
 
-- (NSInteger) year {
+- (NSInteger) year
+{
     NSDateComponents *components = [[MSDate gregorianCalendar] components:NSCalendarUnitYear fromDate:self.date];
     return components.year;
 }
 
-- (NSInteger) month {
+- (NSInteger) month
+{
     NSDateComponents *components = [[MSDate gregorianCalendar] components:NSCalendarUnitMonth fromDate:self.date];
     return components.month;
 }
 
-- (NSInteger) day {
+- (NSInteger) day
+{
     NSDateComponents *components = [[MSDate gregorianCalendar] components:NSCalendarUnitDay fromDate:self.date];
     return components.day;
 }
@@ -74,7 +83,8 @@ - (NSString *)ms_toString
 + (instancetype)ms_dateFromString:(NSString *)dateString
 {
     NSDate *date = nil;
-    if (dateString){
+    if (dateString)
+    {
         NSDateFormatter *dateFormatter = [[NSDateFormatter alloc] init];
         [dateFormatter setDateFormat:dateFormat];
         NSLocale *posix = [[NSLocale alloc] initWithLocaleIdentifier:@"en_US_POSIX"];
@@ -86,7 +96,8 @@ + (instancetype)ms_dateFromString:(NSString *)dateString
 
 #pragma mark - Helpers
 
-+ (NSCalendar*) gregorianCalendar {
++ (NSCalendar*) gregorianCalendar
+{
     static NSCalendar *calendar;
     static dispatch_once_t onceToken;
     dispatch_once(&onceToken, ^{

MSGraphCoreSDK/MSGraphCoreSDK/Models/MSObject.h

@@ -1,31 +1,36 @@
-//
-//  MSObject.h
-//  MSGraphPOCSDK
-//
-//  Created by Vikas Dadheech on 26/07/18.
-//  Copyright © 2018 Vikas Dadheech. All rights reserved.
-//
+// Copyright (c) Microsoft Corporation.  All Rights Reserved.  Licensed under the MIT License.  See License in the project root for license information.
 
 #import <Foundation/Foundation.h>
 
 @interface MSObject : NSObject
 
-/**
+/*
+ Creates an MSObject with the given data.
+ @param data The NSData instance from the response.
+ @error If there are any errors during the conversion of data then it will be assigned to this.
+ @warning This method will return nil if the data is nil.
+ */
+-(instancetype)initWithData:(NSData *)data error:(NSError **)error;;
+
+/*
  Creates an MSObject with the given dictionary.
  @param dictionary The dictionary representation of the object.
  @warning This method will return nil if the dictionary is nil.
  */
 - (instancetype)initWithDictionary:(NSDictionary*)dictionary;
 
--(instancetype)initWithData:(NSData *)data;
-
-/**
- Creates a dictionary from the given item.
- @return dictionary Representation for the given item.
+/*
+This method returns the underlying dictionary which is used to construct the model.
+ @return The NSDictionary consisting of different properties and their values for the model.
  */
-- (NSDictionary*)dictionaryFromItem;
+- (NSMutableDictionary*)getDictionary;
 
-- (NSData *)serializedData;
+/*
+ This method converts the internal dictionary to serialized data.
+ @param error If there are any errors during the conversion of internal dictionary then it will be assigned to this.
+ @return NSData representation of the internal dictionary,
+ */
+- (NSData *)getSerializedDataWithError:(NSError **)error;;
 
 
 @end

MSGraphCoreSDK/MSGraphCoreSDK/Models/MSObject.m

@@ -1,10 +1,4 @@
-//
-//  MSObject.m
-//  MSGraphPOCSDK
-//
-//  Created by Vikas Dadheech on 26/07/18.
-//  Copyright © 2018 Vikas Dadheech. All rights reserved.
-//
+// Copyright (c) Microsoft Corporation.  All Rights Reserved.  Licensed under the MIT License.  See License in the project root for license information.
 
 #import "MSObject.h"
 
@@ -16,32 +10,46 @@ @interface MSObject()
 
 @implementation MSObject
 
-
-- (instancetype)init {
+- (instancetype)init
+{
    return [self initWithDictionary:[NSMutableDictionary new]];
 }
 
--(instancetype)initWithData:(NSData *)data{
+-(instancetype)initWithData:(NSData *)data error:(NSError *__autoreleasing *)error
+{
+    if(!data)
+    {
+        return nil;
+    }
     self = [super init];
-    if(self){
-        self.dictionary = [NSJSONSerialization JSONObjectWithData:data options:kNilOptions error:nil];
+    if(self)
+    {
+        self.dictionary = [NSJSONSerialization JSONObjectWithData:data options:kNilOptions error:error];
     }
     return self;
 }
 
--(instancetype)initWithDictionary:(NSDictionary *)dictionary{
+-(instancetype)initWithDictionary:(NSDictionary *)dictionary
+{
+    if (!dictionary)
+    {
+        return nil;
+    }
     self = [super init];
-    if(self){
+    if(self)
+    {
         self.dictionary = [NSMutableDictionary dictionaryWithDictionary:dictionary];
     }
     return self;
 }
 
--(NSMutableDictionary *)dictionaryFromItem{
+-(NSMutableDictionary *)getDictionary
+{
     return [self.dictionary mutableCopy];
 }
 
-- (NSData *)serializedData{
-    return [NSJSONSerialization dataWithJSONObject:self.dictionary options:kNilOptions error:nil];
+- (NSData *)getSerializedDataWithError:(NSError *__autoreleasing *)error
+{
+    return [NSJSONSerialization dataWithJSONObject:self.dictionary options:kNilOptions error:error];
 }
 @end

MSGraphCoreSDK/MSGraphCoreSDK/Models/MSTimeOfDay.h

@@ -2,17 +2,40 @@
 
 #import <Foundation/Foundation.h>
 
+/*
+ A wrapper class around native NSDate class to represent a specific time in the day.
+ */
 @interface MSTimeOfDay : NSObject
 
-+ (instancetype) timeWithSeconds:(NSInteger)hour minute:(NSInteger)minute second:(NSInteger)second;
-
-- (id) initWithSeconds:(NSInteger)hour minute:(NSInteger)minute second:(NSInteger)second;
-
 @property (nonatomic, readonly) NSInteger hour;
 @property (nonatomic, readonly) NSInteger minute;
 @property (nonatomic, readonly) NSInteger second;
 
+/*
+ Class method to create an instance of MSTimeOfDay
+ @param hour Integer value denoting the hour of day
+ @param minute Integer value denoting the minutes of that hour
+ @param second Integer value denoting the seconds of that minute
+ */
++ (instancetype) timeWithSeconds:(NSInteger)hour minute:(NSInteger)minute second:(NSInteger)second;
+
+/*
+ Instance method to create an instance of MSTimeOfDay
+ @param hour Integer value denoting the hour of day
+ @param minute Integer value denoting the minutes of that hour
+ @param second Integer value denoting the seconds of that minute
+ */
+- (id) initWithSeconds:(NSInteger)hour minute:(NSInteger)minute second:(NSInteger)second;
+
+/*
+ This method generates a string equivalent of MSTimeOfDay instance.
+ */
 - (NSString *)ms_toString;
+
+/*
+ This method can be used to get an MSTimeOfDay instance from a date string
+ @param dateString The date string which needs to be converted.
+ */
 + (instancetype)ms_timeFromString:(NSString *)timeString;
 
 @end