Skip to content

Commit 99acd3c

Browse files
committed
add docs to signature
1 parent c2d1815 commit 99acd3c

File tree

1 file changed

+18
-0
lines changed

1 file changed

+18
-0
lines changed

LibGit2Sharp/Signature.cs

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,9 @@
33

44
namespace LibGit2Sharp
55
{
6+
/// <summary>
7+
/// A signature
8+
/// </summary>
69
public class Signature
710
{
811
private readonly GitSignature sig = new GitSignature();
@@ -17,21 +20,36 @@ internal Signature(IntPtr signaturePtr, bool ownedByRepo = true)
1720
}
1821
}
1922

23+
/// <summary>
24+
/// Initializes a new instance of the <see cref = "Signature" /> class.
25+
/// </summary>
26+
/// <param name = "name">The name.</param>
27+
/// <param name = "email">The email.</param>
28+
/// <param name = "when">The when.</param>
2029
public Signature(string name, string email, DateTimeOffset when)
2130
: this(NativeMethods.git_signature_new(name, email, when.ToSecondsSinceEpoch(), (int) when.Offset.TotalMinutes), false)
2231
{
2332
}
2433

34+
/// <summary>
35+
/// Gets the name.
36+
/// </summary>
2537
public string Name
2638
{
2739
get { return sig.Name; }
2840
}
2941

42+
/// <summary>
43+
/// Gets the email.
44+
/// </summary>
3045
public string Email
3146
{
3247
get { return sig.Email; }
3348
}
3449

50+
/// <summary>
51+
/// Gets the date when this signature happened.
52+
/// </summary>
3553
public DateTimeOffset When
3654
{
3755
get

0 commit comments

Comments
 (0)