aboutsummaryrefslogtreecommitdiffhomepage
path: root/src/objc/utils
diff options
context:
space:
mode:
authorGravatar Matt Ronge <mronge@mronge.com>2013-06-02 21:08:38 -0500
committerGravatar Matt Ronge <mronge@mronge.com>2013-06-02 21:08:38 -0500
commitf4608bf0b70c5102eb64abd338c46cff68292b51 (patch)
treeb093170661099f7d8d55d2240b97738755e0cda5 /src/objc/utils
parent3ae5bf7a1d806c749c28f641be34733c85808efe (diff)
Updated the rest of the docs
Diffstat (limited to 'src/objc/utils')
-rw-r--r--src/objc/utils/MCOIndexSet.h28
-rw-r--r--src/objc/utils/MCORange.h24
2 files changed, 26 insertions, 26 deletions
diff --git a/src/objc/utils/MCOIndexSet.h b/src/objc/utils/MCOIndexSet.h
index 1ecf8c9a..d80aa322 100644
--- a/src/objc/utils/MCOIndexSet.h
+++ b/src/objc/utils/MCOIndexSet.h
@@ -14,47 +14,47 @@
#import <MailCore/MCORange.h>
-// similar to NSMutableIndexSet but supports int64_t
+/** similar to NSMutableIndexSet but supports int64_t*/
@interface MCOIndexSet : NSObject <NSCopying>
-// Creates an empty index set.
+/** Creates an empty index set.*/
+ (MCOIndexSet *) indexSet;
-// Creates an index set that contains a range of integers.
+/** Creates an index set that contains a range of integers.*/
+ (MCOIndexSet *) indexSetWithRange:(MCORange)range;
-// Creates an index set with a single integer.
+/** Creates an index set with a single integer.*/
+ (MCOIndexSet *) indexSetWithIndex:(uint64_t)idx;
-// Returns the number of integers in that index set.
+/** Returns the number of integers in that index set.*/
- (unsigned int) count;
-// Adds an integer to the index set.
+/** Adds an integer to the index set.*/
- (void) addIndex:(uint64_t)idx;
-// Removes an integer from the index set.
+/** Removes an integer from the index set.*/
- (void) removeIndex:(uint64_t)idx;
-// Returns YES if the index set contains the given integer.
+/** Returns YES if the index set contains the given integer.*/
- (BOOL) containsIndex:(uint64_t)idx;
-// Adds a range of integers to the index set.
+/** Adds a range of integers to the index set.*/
- (void) addRange:(MCORange)range;
-// Removes a range of integers from the index set.
+/** Removes a range of integers from the index set.*/
- (void) removeRange:(MCORange)range;
-// Removes all integers that are not in the given range.
+/** Removes all integers that are not in the given range.*/
- (void) intersectsRange:(MCORange)range;
-// Returns all the ranges of ths index set.
+/** Returns all the ranges of ths index set.*/
- (MCORange *) allRanges;
-// Returns the number of ranges in this index set.
+/** Returns the number of ranges in this index set.*/
- (unsigned int) rangesCount;
-// Enumerates all the indexes of the index set.
+/** Enumerates all the indexes of the index set.*/
- (void) enumerateIndexes:(void (^)(uint64_t idx))block;
@end
diff --git a/src/objc/utils/MCORange.h b/src/objc/utils/MCORange.h
index 4fdb9233..e3fac7fd 100644
--- a/src/objc/utils/MCORange.h
+++ b/src/objc/utils/MCORange.h
@@ -23,45 +23,45 @@ extern "C" {
@class MCOIndexSet;
typedef struct {
- // first integer of the range.
+ /** first integer of the range.*/
uint64_t location;
- // length of the range.
+ /** length of the range.*/
uint64_t length;
} MCORange;
-// Constants for an emtpy range.
+/** Constants for an emtpy range.*/
extern MCORange MCORangeEmpty;
-// Returns a new range given a location and length.
+/** Returns a new range given a location and length.*/
MCORange MCORangeMake(uint64_t location, uint64_t length);
-// Returns an index set that is the result of sustracting a range from a range.
+/** Returns an index set that is the result of sustracting a range from a range.*/
MCOIndexSet * MCORangeRemoveRange(MCORange range1, MCORange range2);
-// Returns an index set that is the result of the union a range from a range.
+/** Returns an index set that is the result of the union a range from a range.*/
MCOIndexSet * MCORangeUnion(MCORange range1, MCORange range2);
#ifdef __cplusplus
-// Returns a C++ range from an Objective-C range.
+/** Returns a C++ range from an Objective-C range.*/
mailcore::Range MCORangeToMCRange(MCORange range);
-// Returns an Objective-C range from a C++ range.
+/** Returns an Objective-C range from a C++ range.*/
MCORange MCORangeWithMCRange(mailcore::Range range);
#endif
-// Returns the intersection of two ranges.
+/** Returns the intersection of two ranges.*/
MCORange MCORangeIntersection(MCORange range1, MCORange range2);
-// Returns YES if two given ranges have an intersection.
+/** Returns YES if two given ranges have an intersection.*/
BOOL MCORangeHasIntersection(MCORange range1, MCORange range2);
-// Returns left bound of a range.
+/** Returns left bound of a range.*/
uint64_t MCORangeLeftBound(MCORange range);
-// Returns right bound of a range.
+/** Returns right bound of a range.*/
uint64_t MCORangeRightBound(MCORange range);
#ifdef __cplusplus