diff options
author | nulltoken <emeric.fermas@gmail.com> | 2012-09-03 13:32:27 +0400 |
---|---|---|
committer | nulltoken <emeric.fermas@gmail.com> | 2012-09-05 13:53:15 +0400 |
commit | 03dcb223ed2a160b22081e5a7d0bfed04297913c (patch) | |
tree | 9d5bd0b0a8e57c66488ded2df673a43eda49d97c /LibGit2Sharp/BranchCollection.cs | |
parent | e2e3ff23cb60d418fe12136fb16d3c6f65fafe10 (diff) |
Improve BranchCollection documentation
Diffstat (limited to 'LibGit2Sharp/BranchCollection.cs')
-rw-r--r-- | LibGit2Sharp/BranchCollection.cs | 19 |
1 files changed, 10 insertions, 9 deletions
diff --git a/LibGit2Sharp/BranchCollection.cs b/LibGit2Sharp/BranchCollection.cs index 59e03e4b..df46c382 100644 --- a/LibGit2Sharp/BranchCollection.cs +++ b/LibGit2Sharp/BranchCollection.cs @@ -139,10 +139,11 @@ namespace LibGit2Sharp /// <param name = "name">The name of the branch.</param> /// <param name = "commitish">Revparse spec for the target commit.</param> /// <param name = "allowOverwrite">True to allow silent overwriting a potentially existing branch, false otherwise.</param> - /// <returns></returns> + /// <returns>A new <see cref="Branch"/>.</returns> public virtual Branch Add(string name, string commitish, bool allowOverwrite = false) { Ensure.ArgumentNotNullOrEmptyString(name, "name"); + Ensure.ArgumentNotNullOrEmptyString(commitish, "commitish"); ObjectId commitId = repo.LookupCommit(commitish).Id; @@ -187,17 +188,17 @@ namespace LibGit2Sharp Remove(name, isRemote); } - ///<summary> - /// Rename an existing local branch with a new name. - ///</summary> - ///<param name = "currentName">The current branch name.</param> - ///<param name = "newName">The new name of the existing branch should bear.</param> - ///<param name = "allowOverwrite">True to allow silent overwriting a potentially existing branch, false otherwise.</param> - ///<returns></returns> + /// <summary> + /// Rename an existing local branch with a new name. + /// </summary> + /// <param name = "currentName">The current branch name.</param> + /// <param name = "newName">The new name the existing branch should bear.</param> + /// <param name = "allowOverwrite">True to allow silent overwriting a potentially existing branch, false otherwise.</param> + /// <returns>A new <see cref="Branch"/>.</returns> public virtual Branch Move(string currentName, string newName, bool allowOverwrite = false) { Ensure.ArgumentNotNullOrEmptyString(currentName, "currentName"); - Ensure.ArgumentNotNullOrEmptyString(newName, "name"); + Ensure.ArgumentNotNullOrEmptyString(newName, "newName"); Proxy.git_branch_move(repo.Handle, currentName, newName, allowOverwrite); |