Skip to content

Clarify GTDiff options argument documentation #621

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Mar 10, 2017
Merged

Clarify GTDiff options argument documentation #621

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 8 additions & 8 deletions ObjectiveGit/GTDiff.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -193,7 +193,7 @@ typedef NS_OPTIONS(NSInteger, GTDiffFindOptionsFlags) {
/// newTree - The "right" side of the diff. May be nil to represent an empty
/// tree.
/// repository - The repository to be used for the diff. Cannot be nil.
/// options - A dictionary containing any of the above options key constants, or
/// options - A dictionary containing any of the GTDiffOptions key constants, or
/// nil to use the defaults.
/// error - Populated with an `NSError` object on error, if information is
/// available.
Expand All @@ -210,7 +210,7 @@ typedef NS_OPTIONS(NSInteger, GTDiffFindOptionsFlags) {
/// newIndex - The "right" side of the diff. May be nil to represent an empty
/// index.
/// repository - The repository to be used for the diff. Cannot be nil.
/// options - A dictionary containing any of the above options key constants, or
/// options - A dictionary containing any of the GTDiffOptions key constants, or
/// nil to use the defaults.
/// error - Populated with an `NSError` object on error, if information is
/// available.
Expand All @@ -227,7 +227,7 @@ typedef NS_OPTIONS(NSInteger, GTDiffFindOptionsFlags) {
/// newIndex - The "right" side of the diff. May be nil to represent an empty
/// index.
/// repository - The repository to be used for the diff. Cannot be nil.
/// options - A dictionary containing any of the above options key constants, or
/// options - A dictionary containing any of the GTDiffOptions key constants, or
/// nil to use the defaults.
/// error - Populated with an `NSError` object on error, if information is
/// available.
Expand All @@ -247,7 +247,7 @@ typedef NS_OPTIONS(NSInteger, GTDiffFindOptionsFlags) {
/// repository. The left side of the diff. May be nil to represent an
/// empty tree.
/// repository - The repository to be used for the diff.
/// options - A dictionary containing any of the above options key constants, or
/// options - A dictionary containing any of the GTDiffOptions key constants, or
/// nil to use the defaults.
/// error - Populated with an `NSError` object on error, if information is
/// available.
Expand All @@ -260,7 +260,7 @@ typedef NS_OPTIONS(NSInteger, GTDiffFindOptionsFlags) {
/// This matches the `git diff` command.
///
/// repository - The repository to be used for the diff. May not be nil.
/// options - A dictionary containing any of the above options key constants,
/// options - A dictionary containing any of the GTDiffOptions key constants,
/// or nil to use the defaults.
/// error - Populated with an `NSError` object on error, if information is
/// available.
Expand All @@ -273,7 +273,7 @@ typedef NS_OPTIONS(NSInteger, GTDiffFindOptionsFlags) {
/// tree - The tree to be diffed. The tree will be the left side of the diff.
/// May be nil to represent an empty tree.
/// repository - The repository to be used for the diff. May not be nil.
/// options - A dictionary containing any of the above options key constants, or
/// options - A dictionary containing any of the GTDiffOptions key constants, or
/// nil to use the defaults.
/// error - Populated with an `NSError` object on error, if information is
/// available.
Expand All @@ -287,7 +287,7 @@ typedef NS_OPTIONS(NSInteger, GTDiffFindOptionsFlags) {
/// the working directory as if everything would be part of the initial commit.
///
/// repository - The repository to be used for the diff. May not be nil.
/// options - A dictionary containing any of the above options key constants,
/// options - A dictionary containing any of the GTDiffOptions key constants,
/// or nil to use the defaults.
/// error - Populated if an error occurs.
///
Expand Down Expand Up @@ -325,7 +325,7 @@ typedef NS_OPTIONS(NSInteger, GTDiffFindOptionsFlags) {

/// Modify the diff list to combine similar changes using the given options.
///
/// options - A dictionary containing any of the above find options key constants
/// options - A dictionary containing any of the GTDiffFindOptions key constants
/// or nil to use the defaults.
- (void)findSimilarWithOptions:(nullable NSDictionary *)options;

Expand Down