Add documentation on addData

Author: sagmor

ObjectiveGit/GTIndex.h

@@ -115,6 +115,7 @@
 - (GTIndexEntry *)entryWithName:(NSString *)name error:(NSError **)error;
 
 ///TODO: Document
+/// Get the 
 - (NSData *)dataWithName:(NSString *)name error:(NSError **)error;
 
 /// Add an entry to the index.
@@ -138,6 +139,14 @@
 /// Returns YES if successful, NO otherwise.
 - (BOOL)addFile:(NSString *)file error:(NSError **)error;
 
+/// Add an entry (with the provided data and name) to the index.
+/// Will fail if the receiver's repository is nil.
+///
+/// data  - The content of the entry to add
+/// name  - The name of the entry to add
+/// error - The error if one occurred.
+- (BOOL)addData:(NSData *)data withName:(NSString *)name error:(NSError **)error;
+
 /// Reads the contents of the given tree into the index.
 ///
 /// tree  - The tree to add to the index. This must not be nil.
@@ -146,9 +155,6 @@
 /// Returns whether reading the tree was successful.
 - (BOOL)addContentsOfTree:(GTTree *)tree error:(NSError **)error;
 
-///TODO: Document
-- (BOOL)addData:(NSData *)data withName:(NSString *)name error:(NSError **)error;
-
 /// Remove an entry (by relative path) from the index.
 /// Will fail if the receiver's repository is nil.
 ///

ObjectiveGit/GTIndex.m

@@ -77,6 +77,7 @@ - (void)dealloc {
 
 + (instancetype)inMemoryIndexWithRepository:(GTRepository *)repository error:(NSError **)error {
 	git_index *index = NULL;
+	
 	int status = git_index_new(&index);
 	if (status != GIT_OK) {
 		if (error != NULL) *error = [NSError git_errorFor:status description:@"Failed to initialize in-memory index"];
@@ -193,17 +194,6 @@ - (BOOL)addFile:(NSString *)file error:(NSError **)error {
 	return YES;
 }
 
-- (BOOL)addContentsOfTree:(GTTree *)tree error:(NSError **)error {
-	NSParameterAssert(tree != nil);
-
-	int status = git_index_read_tree(self.git_index, tree.git_tree);
-	if (status != GIT_OK) {
-		if (error != NULL) *error = [NSError git_errorFor:status description:@"Failed to read tree %@ into index.", tree];
-		return NO;
-	}
-
-	return YES;
-}
 - (BOOL)addData:(NSData *)data withName:(NSString *)name error:(NSError **)error {
 	NSParameterAssert(data != nil);
 	NSParameterAssert(name != nil);
@@ -223,6 +213,18 @@ - (BOOL)addData:(NSData *)data withName:(NSString *)name error:(NSError **)error
 	return YES;
 }
 
+- (BOOL)addContentsOfTree:(GTTree *)tree error:(NSError **)error {
+	NSParameterAssert(tree != nil);
+
+	int status = git_index_read_tree(self.git_index, tree.git_tree);
+	if (status != GIT_OK) {
+		if (error != NULL) *error = [NSError git_errorFor:status description:@"Failed to read tree %@ into index.", tree];
+		return NO;
+	}
+
+	return YES;
+}
+
 - (BOOL)removeFile:(NSString *)file error:(NSError **)error {
 	NSString *unicodeString = [self composedUnicodeStringWithString:file];