8000 Standardize comments style · freevoid/libgit2sharp@6fbd65b · GitHub
[go: up one dir, main page]
Skip to content

Commit 6fbd65b

Browse files
yorahyorah
committed
Standardize comments style
1 parent 219b0c5 commit 6fbd65b

File tree

135 files changed

+2117
-2119
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

135 files changed

+2117
-2119
lines changed

‎LibGit2Sharp.Tests/CheckoutFixture.cs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -910,8 +910,8 @@ public void CanCheckoutDetachedHead()
910910
}
911911

912912
/// <summary>
913-
/// Helper method to populate a simple repository with
914-
/// a single file and two branches.
913+
/// Helper method to populate a simple repository with
914+
/// a single file and two branches.
915915
/// </summary>
916916
/// <param name="repo">Repository to populate</param>
917917
private void PopulateBasicRepository(Repository repo)

‎LibGit2Sharp.Tests/TestHelpers/ExpectedFetchState.cs

Lines changed: 16 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -5,38 +5,38 @@
55
namespace LibGit2Sharp.Tests.TestHelpers
66
{
77
/// <summary>
8-
/// Class to verify the expected state after fetching github.com/nulltoken/TestGitRepository into an empty repository.
9-
/// Includes the expected reference callbacks and the expected branches / tags after fetch is completed.
8+
/// Class to verify the expected state after fetching github.com/nulltoken/TestGitRepository into an empty repository.
9+
/// Includes the expected reference callbacks and the expected branches / tags after fetch is completed.
1010
/// </summary>
1111
internal class ExpectedFetchState
1212
{
1313
/// <summary>
14-
/// Name of the Remote being fetched from.
14+
/// Name of the Remote being fetched from.
1515
/// </summary>
1616
internal string RemoteName { get; private set; }
1717

1818
/// <summary>
19-
/// Expected branch tips after fetching into an empty repository.
19+
/// Expected branch tips after fetching into an empty repository.
2020
/// </summary>
2121
private Dictionary<string, ObjectId> ExpectedBranchTips = new Dictionary<string, ObjectId>();
2222

2323
/// <summary>
24-
/// Expected tags after fetching into an empty repository
24+
/// Expected tags after fetching into an empty repository
2525
/// </summary>
2626
private Dictionary<string, TestRemoteInfo.ExpectedTagInfo> ExpectedTags = new Dictionary<string, TestRemoteInfo.ExpectedTagInfo>();
2727

2828
/// <summary>
29-
/// References that we expect to be updated in the UpdateReferenceTips callback.
29+
/// References that we expect to be updated in the UpdateReferenceTips callback.
3030
/// </summary>
3131
private Dictionary<string, ReferenceUpdate> ExpectedReferenceUpdates = new Dictionary<string, ReferenceUpdate>();
3232

3333
/// <summary>
34-
/// References that were actually updated in the UpdateReferenceTips callback.
34+
/// References that were actually updated in the UpdateReferenceTips callback.
3535
/// </summary>
3636
private Dictionary<string, ReferenceUpdate> ObservedReferenceUpdates = new Dictionary<string, ReferenceUpdate>();
3737

3838
/// <summary>
39-
/// Constructor.
39+
/// Constructor.
4040
/// </summary>
4141
/// <param name="remoteName">Name of the remote being updated.</param>
4242
public ExpectedFetchState(string remoteName)
@@ -45,7 +45,7 @@ public ExpectedFetchState(string remoteName)
4545
}
4646

4747
/// <summary>
48-
/// Add information on a branch that is expected to be updated during a fetch.
48+
/// Add information on a branch that is expected to be updated during a fetch.
4949
/// </summary>
5050
/// <param name="branchName">Name of the branch.</param>
5151
/// <param name="oldId">Old ID of the branch reference.</param>
@@ -58,7 +58,7 @@ public void AddExpectedBranch(string branchName, ObjectId oldId, ObjectId newId)
5858
}
5959

6060
/// <summary>
61-
/// Add information on a tag that is expected to be updated during a fetch.
61+
/// Add information on a tag that is expected to be updated during a fetch.
6262
/// </summary>
6363
/// <param name="tagName">Name of the tag.</param>
6464
/// <param name="oldId">Old ID of the tag.</param>
@@ -73,12 +73,12 @@ public void AddExpectedTag(string tagName, ObjectId oldId, TestRemoteInfo.Expect
7373
}
7474

7575
/// <summary>
76-
/// Handler to hook up to UpdateTips callback.
76+
/// Handler to hook up to UpdateTips callback.
7777
/// </summary>
7878
/// <param name="referenceName">Name of reference being updated.</param>
7979
/// <param name="oldId">Old ID of reference.</param>
8080
/// <param name="newId">New ID of reference.</param>
81-
/// <returns></returns>
81+
/// <returns>0 on success; a negative value to abort the process.</returns>
8282
public int RemoteUpdateTipsHandler(string referenceName, ObjectId oldId, ObjectId newId)
8383
{
8484
// assert that we have not seen this reference before
@@ -101,7 +101,7 @@ public int RemoteUpdateTipsHandler(string referenceName, ObjectId oldId, ObjectI
101101
}
102102

103103
/// <summary>
104-
/// Check that all expected references have been updated.
104+
/// Check that all expected references have been updated.
105105
/// </summary>
106106
/// <param name="repo">Repository object whose state will be checked against expected state.</param>
107107
public void CheckUpdatedReferences(Repository repo)
@@ -157,17 +157,17 @@ public void CheckUpdatedReferences(Repository repo)
157157
#region ExpectedFetchState
158158

159159
/// <summary>
160-
/// Structure to track a reference that has been updated.
160+
/// Structure to track a reference that has been updated.
161161
/// </summary>
162162
private struct ReferenceUpdate
163163
{
164164
/// <summary>
165-
/// Old ID of the reference.
165+
/// Old ID of the reference.
166166
/// </summary>
167167
public ObjectId OldId;
168168

169169
/// <summary>
170-
/// New ID of the reference.
170+
/// New ID of the reference.
171171
/// </summary>
172172
public ObjectId NewId;
173173

‎LibGit2Sharp.Tests/TestHelpers/TestRemoteInfo.cs

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -3,18 +3,18 @@
33
namespace LibGit2Sharp.Tests.TestHelpers
44
{
55
/// <summary>
6-
/// This is the state of the test repository based at:
7-
/// github.com/libgit2/TestGitRepository
6+
/// This is the state of the test repository based at:
7+
/// github.com/libgit2/TestGitRepository
88
/// </summary>
99
public class TestRemoteInfo
1010
{
1111
/// <summary>
12-
/// Expected Branch tips of the remote repository.
12+
/// Expected Branch tips of the remote repository.
1313
/// </summary>
1414
public Dictionary<string, ObjectId> BranchTips = new Dictionary<string, ObjectId>();
1515

1616
/// <summary>
17-
/// Expected Tags of the remote repository.
17+
/// Expected Tags of the remote repository.
1818
/// </summary>
1919
public Dictionary<string, ExpectedTagInfo> Tags = new Dictionary<string, ExpectedTagInfo>();
2020

@@ -35,7 +35,7 @@ private TestRemoteInfo()
3535
#region ExpectedTagInfo class
3636

3737
/// <summary>
38-
/// Helper class to contain expected info of tags in the test repository.
38+
/// Helper class to contain expected info of tags in the test repository.
3939
/// </summary>
4040
public class ExpectedTagInfo
4141
{

‎LibGit2Sharp/AmbiguousSpecificationException.cs

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -4,42 +4,42 @@
44
namespace LibGit2Sharp
55
{
66
/// <summary>
7-
/// The exception that is thrown when the provided specification cannot uniquely identify a reference, an object or a path.
7+
/// The exception that is thrown when the provided specification cannot uniquely identify a reference, an object or a path.
88
/// </summary>
99
[Serializable]
1010
public class AmbiguousSpecificationException : LibGit2SharpException
1111
{
1212
/// <summary>
13-
/// Initializes a new instance of the <see cref = "AmbiguousSpecificationException" /> class.
13+
/// Initializes a new instance of the <see cref="AmbiguousSpecificationException"/> class.
1414
/// </summary>
1515
public AmbiguousSpecificationException()
1616
{
1717
}
1818

1919
/// <summary>
20-
/// Initializes a new instance of the <see cref = "AmbiguousSpecificationException" /> class with a specified error message.
20+
/// Initializes a new instance of the <see cref="AmbiguousSpecificationException"/> class with a specified error message.
2121
/// </summary>
22-
/// <param name = "message">A message that describes the error. </param>
22+
/// <param name="message">A message that describes the error.</param>
2323
public AmbiguousSpecificationException(string message)
2424
: base(message)
2525
{
2626
}
2727

2828
/// <summary>
29-
/// Initializes a new instance of the <see cref = "AmbiguousSpecificationException" /> class with a specified error message and a reference to the inner exception that is the cause of this exception.
29+
/// Initializes a new instance of the <see cref="AmbiguousSpecificationException"/> class with a specified error message and a reference to the inner exception that is the cause of this exception.
3030
/// </summary>
31-
/// <param name = "message">The error message that explains the reason for the exception. </param>
32-
/// <param name = "innerException">The exception that is the cause of the current exception. If the <paramref name = "innerException" /> parameter is not a null reference, the current exception is raised in a catch block that handles the inner exception.</param>
31+
/// <param name="message">The error message that explains the reason for the exception.</param>
32+
/// <param name="innerException">The exception that is the cause of the current exception. If the <paramref name="innerException"/> parameter is not a null reference, the current exception is raised in a catch block that handles the inner exception.</param>
3333
public AmbiguousSpecificationException(string message, Exception innerException)
3434
: base(message, innerException)
3535
{
3636
}
3737

3838
/// <summary>
39-
/// Initializes a new instance of the <see cref = "AmbiguousSpecificationException" /> class with a serialized data.
39+
/// Initializes a new instance of the <see cref="AmbiguousSpecificationException"/> class with a serialized data.
4040
/// </summary>
41-
/// <param name = "info">The <see cref="SerializationInfo "/> that holds the serialized object data about the exception being thrown.</param>
42-
/// <param name = "context">The <see cref="StreamingContext"/> that contains contextual information about the source or destination.</param>
41+
/// <param name="info">The <see cref="SerializationInfo "/> that holds the serialized object data about the exception being thrown.</param>
42+
/// <param name="context">The <see cref="StreamingContext"/> that contains contextual information about the source or destination.</param>
4343
protected AmbiguousSpecificationException(SerializationInfo info, StreamingContext context)
4444
: base(info, context)
4545
{

‎LibGit2Sharp/BareRepositoryException.cs

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -5,43 +5,43 @@
55
namespace LibGit2Sharp
66
{
77
/// <summary>
8-
/// The exception that is thrown when an operation which requires a
9-
/// working directory is performed against a bare repository.
8+
/// The exception that is thrown when an operation which requires a
9+
/// working directory is performed against a bare repository.
1010
/// </summary>
1111
[Serializable]
1212
public class BareRepositoryException : LibGit2SharpException
1313
{
1414
/// <summary>
15-
/// Initializes a new instance of the <see cref = "LibGit2Sharp.BareRepositoryException" /> class.
15+
/// Initializes a new instance of the <see cref="LibGit2Sharp.BareRepositoryException"/> class.
1616
/// </summary>
1717
public BareRepositoryException()
1818
{
1919
}
2020

2121
/// <summary>
22-
/// Initializes a new instance of the <see cref = "LibGit2Sharp.BareRepositoryException" /> class with a specified error message.
22+
/// Initializes a new instance of the <see cref="LibGit2Sharp.BareRepositoryException"/> class with a specified error message.
2323
/// </summary>
24-
/// <param name = "message">A message that describes the error. </param>
24+
/// <param name="message">A message that describes the error.</param>
2525
public BareRepositoryException(string message)
2626
: base(message)
2727
{
2828
}
2929

3030
/// <summary>
31-
/// Initializes a new instance of the <see cref = "LibGit2Sharp.BareRepositoryException" /> class with a specified error message and a reference to the inner exception that is the cause of this exception.
31+
/// Initializes a new instance of the <see cref="LibGit2Sharp.BareRepositoryException"/> class with a specified error message and a reference to the inner exception that is the cause of this exception.
3232
/// </summary>
33-
/// <param name = "message">The error message that explains the reason for the exception. </param>
34-
/// <param name = "innerException">The exception that is the cause of the current exception. If the <paramref name = "innerException" /> parameter is not a null reference, the current exception is raised in a catch block that handles the inner exception.</param>
33+
/// <param name="message">The error message that explains the reason for the exception.</param>
34+
/// <param name="innerException">The exception that is the cause of the current exception. If the <paramref name="innerException"/> parameter is not a null reference, the current exception is raised in a catch block that handles the inner exception.</param>
3535
public BareRepositoryException(string message, Exception innerException)
3636
: base(message, innerException)
3737
{
3838
}
3939

4040
/// <summary>
41-
/// Initializes a new instance of the <see cref = "LibGit2Sharp.BareRepositoryException" /> class with a serialized data.
41+
/// Initializes a new instance of the <see cref="LibGit2Sharp.BareRepositoryException"/> class with a serialized data.
4242
/// </summary>
43-
/// <param name = "info">The <see cref="SerializationInfo "/> that holds the serialized object data about the exception being thrown.</param>
44-
/// <param name = "context">The <see cref="StreamingContext"/> that contains contextual information about the source or destination.</param>
43+
/// <param name="info">The <see cref="SerializationInfo "/> that holds the serialized object data about the exception being thrown.</param>
44+
/// <param name="context">The <see cref="StreamingContext"/> that contains contextual information about the source or destination.</param>
4545
protected BareRepositoryException(SerializationInfo info, StreamingContext context)
4646
: base(info, context)
4747
{

‎LibGit2Sharp/Blob.cs

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -5,15 +5,15 @@
55
namespace LibGit2Sharp
66
{
77
/// <summary>
8-
/// Stores the binary content of a tracked file.
8+
/// Stores the binary content of a tracked file.
99
/// </summary>
1010
public class Blob : GitObject
1111
{
1212
private readonly ILazy<Int64> lazySize;
1313
private readonly ILazy<bool> lazyIsBinary;
1414

1515
/// <summary>
16-
/// Needed for mocking purposes.
16+
/// Needed for mocking purposes.
1717
/// </summary>
1818
protected Blob()
1919
{ }
@@ -26,17 +26,17 @@ internal Blob(Repository repo, ObjectId id)
2626
}
2727

2828
/// <summary>
29-
/// Gets the size in bytes of the contents of a blob
29+
/// Gets the size in bytes of the contents of a blob
3030
/// </summary>
3131
public virtual int Size { get { return (int)lazySize.Value; } }
3232

3333
/// <summary>
34-
/// Determine if the blob content is most certainly binary or not.
34+
/// Determine if the blob content is most certainly binary or not.
3535
/// </summary>
3636
public virtual bool IsBinary { get { return lazyIsBinary.Value; } }
3737

3838
/// <summary>
39-
/// Gets the blob content in a <see cref="byte" /> array.
39+
/// Gets the blob content in a <see cref="byte"/> array.
4040
/// </summary>
4141
public virtual byte[] Content
4242
{
@@ -47,7 +47,7 @@ public virtual byte[] Content
4747
}
4848

4949
/// <summary>
50-
/// Gets the blob content in a <see cref="Stream" />.
50+
/// Gets the blob content in a <see cref="Stream"/>.
5151
/// </summary>
5252
public virtual Stream ContentStream
5353
{

‎LibGit2Sharp/BlobExtensions.cs

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,12 +4,12 @@
44
namespace LibGit2Sharp
55
{
66
/// <summary>
7-
/// Provides helper overloads to a <see cref = "Blob" />.
7+
/// Provides helper overloads to a <see cref="Blob"/>.
88
/// </summary>
99
public static class BlobExtensions
1010
{
1111
/// <summary>
12-
/// Gets the blob content decoded as UTF-8.
12+
/// Gets the blob content decoded as UTF-8.
1313
/// </summary>
1414
/// <param name="blob">The blob for which the content will be returned.</param>
1515
/// <returns>Blob content as UTF-8</returns>
@@ -21,7 +21,7 @@ public static string ContentAsUtf8(this Blob blob)
2121
}
2222

2323
/// <summary>
24-
/// Gets the blob content decoded as Unicode.
24+
/// Gets the blob content decoded as Unicode.
2525
/// </summary>
2626
/// <param name="blob">The blob for which the content will be returned.</param>
2727
/// <returns>Blob content as unicode.</returns>

0 commit comments

Comments
 (0)
0