Skip to content
This repository was archived by the owner on Dec 5, 2024. It is now read-only.

Commit f61bacd

Browse files
StanleyGoldmanStanleyGoldman
committed
Adding parameters
1 parent 12558c8 commit f61bacd

File tree

1 file changed

+34
-34
lines changed

1 file changed

+34
-34
lines changed

‎src/GitHub.Api/Git/GitClient.cs

Lines changed: 34 additions & 34 deletions
Original file line numberDiff line numberDiff line change
@@ -44,18 +44,18 @@ public interface IGitClient
4444
/// <summary>
4545
/// Executes `git config get` to get a configuration value.
4646
/// </summary>
47-
/// <param name="key"></param>
48-
/// <param name="configSource"></param>
47+
/// <param name="key">The configuration key to get</param>
48+
/// <param name="configSource">The config source (unspecified, local,user,global) to use</param>
4949
/// <param name="processor">A custom output processor instance</param>
5050
/// <returns>String output of git command</returns>
5151
ITask<string> GetConfig(string key, GitConfigSource configSource, IOutputProcessor<string> processor = null);
5252

5353
/// <summary>
5454
/// Executes `git config set` to set a configuration value.
5555
/// </summary>
56-
/// <param name="key"></param>
57-
/// <param name="value"></param>
58-
/// <param name="configSource"></param>
56+
/// <param name="key">The configuration key to set</param>
57+
/// <param name="value">The value to set</param>
58+
/// <param name="configSource">The config source (unspecified, local,user,global) to use</param>
5959
/// <param name="processor">A custom output processor instance</param>
6060
/// <returns>String output of git command</returns>
6161
ITask<string> SetConfig(string key, string value, GitConfigSource configSource, IOutputProcessor<string> processor = null);
@@ -77,102 +77,102 @@ public interface IGitClient
7777
/// <summary>
7878
/// Executes `git pull` to perform a pull operation.
7979
/// </summary>
80-
/// <param name="remote"></param>
81-
/// <param name="branch"></param>
80+
/// <param name="remote">The remote to pull from</param>
81+
/// <param name="branch">The branch to pull</param>
8282
/// <param name="processor">A custom output processor instance</param>
8383
/// <returns>String output of git command</returns>
8484
ITask<string> Pull(string remote, string branch, IOutputProcessor<string> processor = null);
8585

8686
/// <summary>
8787
/// Executes `git push` to perform a push operation.
8888
/// </summary>
89-
/// <param name="remote"></param>
90-
/// <param name="branch"></param>
89+
/// <param name="remote">The remote to push to</param>
90+
/// <param name="branch">The branch to push</param>
9191
/// <param name="processor">A custom output processor instance</param>
9292
/// <returns>String output of git command</returns>
9393
ITask<string> Push(string remote, string branch, IOutputProcessor<string> processor = null);
9494

9595
/// <summary>
9696
/// Executes `git revert` to perform a revert operation.
9797
/// </summary>
98-
/// <param name="changeset"></param>
98+
/// <param name="changeset">The changeset to revert</param>
9999
/// <param name="processor">A custom output processor instance</param>
100100
/// <returns>String output of git command</returns>
101101
ITask<string> Revert(string changeset, IOutputProcessor<string> processor = null);
102102

103103
/// <summary>
104104
/// Executes `git fetch` to perform a fetch operation.
105105
/// </summary>
106-
/// <param name="remote"></param>
106+
/// <param name="remote">The remote to fetch from</param>
107107
/// <param name="processor">A custom output processor instance</param>
108108
/// <returns>String output of git command</returns>
109109
ITask<string> Fetch(string remote, IOutputProcessor<string> processor = null);
110110

111111
/// <summary>
112112
/// Executes `git checkout` to switch branches.
113113
/// </summary>
114-
/// <param name="branch"></param>
114+
/// <param name="branch">The branch to checkout</param>
115115
/// <param name="processor">A custom output processor instance</param>
116116
/// <returns>String output of git command</returns>
117117
ITask<string> SwitchBranch(string branch, IOutputProcessor<string> processor = null);
118118

119119
/// <summary>
120120
/// Executes `git branch -d` to delete a branch.
121121
/// </summary>
122-
/// <param name="branch"></param>
123-
/// <param name="deleteUnmerged"></param>
122+
/// <param name="branch">The branch to delete</param>
123+
/// <param name="deleteUnmerged">The flag to indicate the branch should be deleted even if not merged</param>
124124
/// <param name="processor">A custom output processor instance</param>
125125
/// <returns>String output of git command</returns>
126126
ITask<string> DeleteBranch(string branch, bool deleteUnmerged = false, IOutputProcessor<string> processor = null);
127127

128128
/// <summary>
129129
/// Executes `git branch` to create a branch.
130130
/// </summary>
131-
/// <param name="branch"></param>
132-
/// <param name="baseBranch"></param>
131+
/// <param name="branch">The name of branch to create</param>
132+
/// <param name="baseBranch">The name of branch to create from</param>
133133
/// <param name="processor">A custom output processor instance</param>
134134
/// <returns>String output of git command</returns>
135135
ITask<string> CreateBranch(string branch, string baseBranch, IOutputProcessor<string> processor = null);
136136

137137
/// <summary>
138138
/// Executes `git remote add` to add a git remote.
139139
/// </summary>
140-
/// <param name="remote"></param>
141-
/// <param name="url"></param>
140+
/// <param name="remote">The remote to add</param>
141+
/// <param name="url">The url of the remote</param>
142142
/// <param name="processor">A custom output processor instance</param>
143143
/// <returns>String output of git command</returns>
144144
ITask<string> RemoteAdd(string remote, string url, IOutputProcessor<string> processor = null);
145145

146146
/// <summary>
147147
/// Executes `git remote rm` to remove a git remote.
148148
/// </summary>
149-
/// <param name="remote"></param>
149+
/// <param name="remote">The remote to remove</param>
150150
/// <param name="processor">A custom output processor instance</param>
151151
/// <returns>String output of git command</returns>
152152
ITask<string> RemoteRemove(string remote, IOutputProcessor<string> processor = null);
153153

154154
/// <summary>
155155
/// Executes `git remote set-url` to change the url of a git remote.
156156
/// </summary>
157-
/// <param name="remote"></param>
158-
/// <param name="url"></param>
157+
/// <param name="remote">The remote to change</param>
158+
/// <param name="url">The url to change to</param>
159159
/// <param name="processor">A custom output processor instance</param>
160160
/// <returns>String output of git command</returns>
161161
ITask<string> RemoteChange(string remote, string url, IOutputProcessor<string> processor = null);
162162

163163
/// <summary>
164164
/// Executes `git commit` to perform a commit operation.
165165
/// </summary>
166-
/// <param name="message"></param>
167-
/// <param name="body"></param>
166+
/// <param name="message">The commit message summary</param>
167+
/// <param name="body">The commit message body</param>
168168
/// <param name="processor">A custom output processor instance</param>
169169
/// <returns>String output of git command</returns>
170170
ITask<string> Commit(string message, string body, IOutputProcessor<string> processor = null);
171171

172172
/// <summary>
173173
/// Executes at least one `git add` command to add the list of files to the git index.
174174
/// </summary>
175-
/// <param name="files"></param>
175+
/// <param name="files">The file to add</param>
176176
/// <param name="processor">A custom output processor instance</param>
177177
/// <returns>String output of git command</returns>
178178
ITask<string> Add(IList<string> files, IOutputProcessor<string> processor = null);
@@ -187,7 +187,7 @@ public interface IGitClient
187187
/// <summary>
188188
/// Executes at least one `git checkout` command to discard changes to the list of files.
189189
/// </summary>
190-
/// <param name="files"></param>
190+
/// <param name="files">The files to discard</param>
191191
/// <param name="processor">A custom output processor instance</param>
192192
/// <returns>String output of git command</returns>
193193
ITask<string> Discard(IList<string> files, IOutputProcessor<string> processor = null);
@@ -202,34 +202,34 @@ public interface IGitClient
202202
/// <summary>
203203
/// Executes `git reset HEAD` command to remove files from the git index.
204204
/// </summary>
205-
/// <param name="files"></param>
205+
/// <param name="files">The files to remove</param>
206206
/// <param name="processor">A custom output processor instance</param>
207207
/// <returns>String output of git command</returns>
208208
ITask<string> Remove(IList<string> files, IOutputProcessor<string> processor = null);
209209

210210
/// <summary>
211211
/// Executes at least one `git add` command to add the list of files to the git index. Followed by a `git commit` command to commit the changes.
212212
/// </summary>
213-
/// <param name="files"></param>
214-
/// <param name="message"></param>
215-
/// <param name="body"></param>
213+
/// <param name="files">The files to add and commit</param>
214+
/// <param name="message">The commit message summary</param>
215+
/// <param name="body">The commit message body</param>
216216
/// <param name="processor">A custom output processor instance</param>
217217
/// <returns>String output of git command</returns>
218218
ITask<string> AddAndCommit(IList<string> files, string message, string body, IOutputProcessor<string> processor = null);
219219

220220
/// <summary>
221221
/// Executes `git lfs lock` to lock a file.
222222
/// </summary>
223-
/// <param name="file"></param>
223+
/// <param name="file">The file to lock</param>
224224
/// <param name="processor">A custom output processor instance</param>
225225
/// <returns>String output of git command</returns>
226226
ITask<string> Lock(NPath file, IOutputProcessor<string> processor = null);
227227

228228
/// <summary>
229229
/// Executes `git lfs unlock` to unlock a file.
230230
/// </summary>
231-
/// <param name="file"></param>
232-
/// <param name="force"></param>
231+
/// <param name="file">The file to unlock</param>
232+
/// <param name="force">If force should be used</param>
233233
/// <param name="processor">A custom output processor instance</param>
234234
/// <returns>String output of git command</returns>
235235
ITask<string> Unlock(NPath file, bool force, IOutputProcessor<string> processor = null);
@@ -265,8 +265,8 @@ public interface IGitClient
265265
/// <summary>
266266
/// Executes two `git set config` commands to set the git name and email.
267267
/// </summary>
268-
/// <param name="username"></param>
269-
/// <param name="email"></param>
268+
/// <param name="username">The username to set</param>
269+
/// <param name="email">The email to set</param>
270270
/// <returns><see cref="GitUser"/> output</returns>
271271
ITask<GitUser> SetConfigNameAndEmail(string username, string email);
272272

0 commit comments

Comments
 (0)