Skip to content

Commit 6a4c1b5

Browse files
committed
added doc comments
1 parent de78535 commit 6a4c1b5

File tree

1 file changed

+17
-0
lines changed

1 file changed

+17
-0
lines changed

RubberduckTests/Mocks/MockFactory.cs

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -91,6 +91,12 @@ internal static Mock<VBProjects> CreateProjectsMock(List<VBProject> projectList,
9191
// return projects;
9292
//}
9393

94+
/// <summary>
95+
/// Creates a new <see cref="Mock{Reference}"/>.
96+
/// </summary>
97+
/// <param name="name">The see<see cref="Reference.Name"/>.</param>
98+
/// <param name="filePath">The <see cref="Reference.FullPath"/> filepath.</param>
99+
/// <returns></returns>
94100
internal static Mock<Reference> CreateMockReference(string name, string filePath)
95101
{
96102
var reference = new Mock<Reference>();
@@ -100,6 +106,11 @@ internal static Mock<Reference> CreateMockReference(string name, string filePath
100106
return reference;
101107
}
102108

109+
/// <summary>
110+
/// Creates a new <see cref="Mock{References}"/> collection that can be iterated over as an <see cref="IEnumerable"/>.
111+
/// </summary>
112+
/// <param name="referenceList">The collection to be iterated over.</param>
113+
/// <returns></returns>
103114
internal static Mock<References> CreateReferencesMock(List<Reference> referenceList)
104115
{
105116
var references = new Mock<References>();
@@ -108,6 +119,12 @@ internal static Mock<References> CreateReferencesMock(List<Reference> referenceL
108119
return references;
109120
}
110121

122+
/// <summary>
123+
/// Creates a new <see cref="Mock{Project}"/> that is set up with a <see cref="References"/> collection.
124+
/// </summary>
125+
/// <param name="name">The <see cref="VBProject"/> <see cref="VBProject.Name"/>.</param>
126+
/// <param name="references">The <see cref="References"/> collection.</param>
127+
/// <returns></returns>
111128
internal static Mock<VBProject> CreateProjectMock(string name, Mock<References> references)
112129
{
113130
var project = new Mock<VBProject>();

0 commit comments

Comments
 (0)