Skip to content

Commit 222d4c4

Browse files
committed
Issue-1471 Added code comments to WorktreeLock
1 parent 9d17daa commit 222d4c4

File tree

1 file changed

+18
-0
lines changed

1 file changed

+18
-0
lines changed

LibGit2Sharp/WorktreeLock.cs

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,20 +6,38 @@
66

77
namespace LibGit2Sharp
88
{
9+
/// <summary>
10+
/// Represents the lock state of a Worktree
11+
/// </summary>
912
[DebuggerDisplay("{DebuggerDisplay,nq}")]
1013
public class WorktreeLock
1114
{
15+
/// <summary>
16+
/// Creates a new instance of <see cref="WorktreeLock"/> with default, unlocked, state
17+
/// </summary>
1218
public WorktreeLock() : this(false, null)
1319
{
1420

1521
}
1622

23+
/// <summary>
24+
/// Creates a new instance of <see cref="WorktreeLock"/>
25+
/// </summary>
26+
/// <param name="isLocked">the locked state</param>
27+
/// <param name="reason">the reason given for the lock</param>
1728
public WorktreeLock(bool isLocked, string reason)
1829
{
1930
IsLocked = isLocked;
2031
Reason = reason;
2132
}
33+
/// <summary>
34+
/// Gets a flag indicating if the worktree is locked
35+
/// </summary>
2236
public virtual bool IsLocked { get; }
37+
38+
/// <summary>
39+
/// Gets the reason, if set, for the lock
40+
/// </summary>
2341
public virtual string Reason { get; }
2442

2543
private string DebuggerDisplay

0 commit comments

Comments
 (0)