Skip to content

Commit 141d957

Browse files
committed
Add doc comment to moveHEADToCommit:error:
1 parent c916c74 commit 141d957

File tree

1 file changed

+9
-1
lines changed

1 file changed

+9
-1
lines changed

ObjectiveGit/GTRepository.h

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -269,12 +269,20 @@ extern NSString * const GTRepositoryInitOptionsOriginURLString;
269269
/// Returns a GTReference or nil if an error occurs.
270270
- (nullable GTReference *)headReferenceWithError:(NSError **)error;
271271

272-
/// Move HEAD reference safely, since deleting and recreating HEAD is always wrong
272+
/// Move HEAD reference safely, since deleting and recreating HEAD is always wrong.
273273
///
274+
/// reference - The new target reference for HEAD.
274275
/// error - If not NULL, set to any error that occurs.
275276
///
276277
/// Returns NO if an error occurs.
277278
- (BOOL)moveHEADToReference:(GTReference *)reference error:(NSError **)error;
279+
280+
/// Move HEAD reference safely, since deleting and recreating HEAD is always wrong.
281+
///
282+
/// commit - The commit which HEAD should point to.
283+
/// error - If not NULL, set to any error that occurs.
284+
///
285+
/// Returns NO if an error occurs.
278286
- (BOOL)moveHEADToCommit:(GTCommit *)commit error:(NSError **)error;
279287

280288
/// Get the local branches.

0 commit comments

Comments
 (0)