Authored by Nikolay Tymchenko

Added doc comments for new stuff

@@ -78,7 +78,7 @@ @@ -78,7 +78,7 @@
78 /** 78 /**
79 * Sets the constraint relation to NSLayoutRelationEqual 79 * Sets the constraint relation to NSLayoutRelationEqual
80 * returns a block which accepts one of the following: 80 * returns a block which accepts one of the following:
81 - * MASViewAttribute, UIView, NSNumber, NSArray 81 + * MASViewAttribute, UIView, NSValue, NSArray
82 * see readme for more details. 82 * see readme for more details.
83 */ 83 */
84 - (MASConstraint * (^)(id attr))equalTo; 84 - (MASConstraint * (^)(id attr))equalTo;
@@ -86,7 +86,7 @@ @@ -86,7 +86,7 @@
86 /** 86 /**
87 * Sets the constraint relation to NSLayoutRelationGreaterThanOrEqual 87 * Sets the constraint relation to NSLayoutRelationGreaterThanOrEqual
88 * returns a block which accepts one of the following: 88 * returns a block which accepts one of the following:
89 - * MASViewAttribute, UIView, NSNumber, NSArray 89 + * MASViewAttribute, UIView, NSValue, NSArray
90 * see readme for more details. 90 * see readme for more details.
91 */ 91 */
92 - (MASConstraint * (^)(id attr))greaterThanOrEqualTo; 92 - (MASConstraint * (^)(id attr))greaterThanOrEqualTo;
@@ -94,7 +94,7 @@ @@ -94,7 +94,7 @@
94 /** 94 /**
95 * Sets the constraint relation to NSLayoutRelationLessThanOrEqual 95 * Sets the constraint relation to NSLayoutRelationLessThanOrEqual
96 * returns a block which accepts one of the following: 96 * returns a block which accepts one of the following:
97 - * MASViewAttribute, UIView, NSNumber, NSArray 97 + * MASViewAttribute, UIView, NSValue, NSArray
98 * see readme for more details. 98 * see readme for more details.
99 */ 99 */
100 - (MASConstraint * (^)(id attr))lessThanOrEqualTo; 100 - (MASConstraint * (^)(id attr))lessThanOrEqualTo;
@@ -174,14 +174,27 @@ @@ -174,14 +174,27 @@
174 174
175 @interface MASConstraint (Private) 175 @interface MASConstraint (Private)
176 176
177 -// TODO: describe 177 +/**
  178 + * Modifies the NSLayoutConstraint constant based on a value type,
  179 + * see _setLayoutConstantWithValue: for details
  180 + */
178 - (MASConstraint * (^)(id))_valueOffset; 181 - (MASConstraint * (^)(id))_valueOffset;
179 182
180 -// TODO: describe 183 +/**
  184 + * Based on a provided value type, is equal to calling:
  185 + * NSNumber - setOffset:
  186 + * NSValue with CGPoint - setPointOffset:
  187 + * NSValue with CGSize - setSizeOffset:
  188 + * NSValue with MASEdgeInsets - setInsets:
  189 + */
181 - (void)_setLayoutConstantWithValue:(NSValue *)value; 190 - (void)_setLayoutConstantWithValue:(NSValue *)value;
182 191
183 -// TODO: description  
184 -// TODO: update docs for the methods above 192 +/**
  193 + * Sets the constraint relation to given NSLayoutRelation
  194 + * returns a block which accepts one of the following:
  195 + * MASViewAttribute, UIView, NSValue, NSArray
  196 + * see readme for more details.
  197 + */
185 - (MASConstraint * (^)(id attr, NSLayoutRelation relation))_equalToWithRelation; 198 - (MASConstraint * (^)(id attr, NSLayoutRelation relation))_equalToWithRelation;
186 199
187 @end 200 @end
@@ -68,8 +68,10 @@ @@ -68,8 +68,10 @@
68 #define MAS_NSUINT_BIT (CHAR_BIT * sizeof(NSUInteger)) 68 #define MAS_NSUINT_BIT (CHAR_BIT * sizeof(NSUInteger))
69 #define MAS_NSUINTROTATE(val, howmuch) ((((NSUInteger)val) << howmuch) | (((NSUInteger)val) >> (MAS_NSUINT_BIT - howmuch))) 69 #define MAS_NSUINTROTATE(val, howmuch) ((((NSUInteger)val) << howmuch) | (((NSUInteger)val) >> (MAS_NSUINT_BIT - howmuch)))
70 70
71 -// TODO: description  
72 - 71 +/**
  72 + * Given a scalar or struct value, wraps it in NSValue
  73 + * Based on EXPObjectify: https://github.com/specta/expecta
  74 + */
73 static inline id _MASBoxValue(const char *type, ...) { 75 static inline id _MASBoxValue(const char *type, ...) {
74 va_list v; 76 va_list v;
75 va_start(v, type); 77 va_start(v, type);