diff options
author | nulltoken <emeric.fermas@gmail.com> | 2012-10-17 13:53:40 +0400 |
---|---|---|
committer | nulltoken <emeric.fermas@gmail.com> | 2012-10-17 14:18:12 +0400 |
commit | 4b7412bc90fe9976926aa86234cf44846aadad5c (patch) | |
tree | 92b4d2f4d901fd10fcf7db06194ef6ae2b1009ae /LibGit2Sharp/TagFetchMode.cs | |
parent | 56b25be50c4e5ae27570bb670a5e16d5450fbaf7 (diff) |
Enhance TagFetchMode documentation
Diffstat (limited to 'LibGit2Sharp/TagFetchMode.cs')
-rw-r--r-- | LibGit2Sharp/TagFetchMode.cs | 15 |
1 files changed, 8 insertions, 7 deletions
diff --git a/LibGit2Sharp/TagFetchMode.cs b/LibGit2Sharp/TagFetchMode.cs index f692ea68..13024cb0 100644 --- a/LibGit2Sharp/TagFetchMode.cs +++ b/LibGit2Sharp/TagFetchMode.cs @@ -1,24 +1,25 @@ -using System; - -namespace LibGit2Sharp +namespace LibGit2Sharp { /// <summary> - /// Enum for TagOptions + /// Describe the expected tag retrieval behavior + /// when a fetch operation is being performed. /// </summary> public enum TagFetchMode { /// <summary> - /// None. + /// No tag will be retrieved. /// </summary> None = 1, // GIT_REMOTE_DOWNLOAD_TAGS_NONE /// <summary> - /// Auto. + /// Default behavior. Will automatically retrieve tags that + /// point to objects retrieved during this fetch. /// </summary> Auto, // GIT_REMOTE_DOWNLOAD_TAGS_AUTO /// <summary> - /// All. + /// All tags will be downloaded, but _only_ tags, along with + /// all the objects these tags are pointing to. /// </summary> All, // GIT_REMOTE_DOWNLOAD_TAGS_ALL } |