added xml docs

Author: retailcoder

RubberduckTests/Mocks/MockProjectBuilder.cs

@@ -7,6 +7,9 @@
 
 namespace RubberduckTests.Mocks
 {
+    /// <summary>
+    /// Builds a mock <see cref="VBProject"/>.
+    /// </summary>
     public class MockProjectBuilder
     {
         private readonly Func<VBE> _getVbe;
@@ -30,30 +33,58 @@ public MockProjectBuilder(string name, vbext_ProjectProtection protection, Func<
             _project.SetupGet(m => m.References).Returns(_vbReferences.Object);
         }
 
+        /// <summary>
+        /// Adds a new component to the project.
+        /// </summary>
+        /// <param name="name">The name of the new component.</param>
+        /// <param name="type">The type of component to create.</param>
+        /// <param name="content">The VBA code associated to the component.</param>
+        /// <returns>Returns the <see cref="MockProjectBuilder"/> instance.</returns>
         public MockProjectBuilder AddComponent(string name, vbext_ComponentType type, string content)
         {
             var component = CreateComponentMock(name, type, content);
             return AddComponent(component);
         }
 
+        /// <summary>
+        /// Adds a new mock component to the project.
+        /// Use the <see cref="AddComponent(string,vbext_ComponentType,string)"/> overload to add module components.
+        /// Use this overload to add user forms created with a <see cref="MockUserFormBuilder"/> instance.
+        /// </summary>
+        /// <param name="component">The component to add.</param>
+        /// <returns>Returns the <see cref="MockProjectBuilder"/> instance.</returns>
         public MockProjectBuilder AddComponent(Mock<VBComponent> component)
         {
             _components.Add(component);
             return this;            
         }
 
+        /// <summary>
+        /// Adds a mock reference to the project.
+        /// </summary>
+        /// <param name="name">The name of the referenced library.</param>
+        /// <param name="filePath">The path to the referenced library.</param>
+        /// <returns>Returns the <see cref="MockProjectBuilder"/> instance.</returns>
         public MockProjectBuilder AddReference(string name, string filePath)
         {
             _references.Add(CreateReferenceMock(name, filePath));
             return this;
         }
 
+        /// <summary>
+        /// Creates a <see cref="MockUserFormBuilder"/> to build a new form component.
+        /// </summary>
+        /// <param name="name">The name of the component.</param>
+        /// <param name="content">The VBA code associated to the component.</param>
         public MockUserFormBuilder UserFormBuilder(string name, string content)
         {
             var component = CreateComponentMock(name, vbext_ComponentType.vbext_ct_MSForm, content);
             return new MockUserFormBuilder(component);
         }
 
+        /// <summary>
+        /// Gets the mock <see cref="VBProject"/> instance.
+        /// </summary>
         public Mock<VBProject> Build()
         {
             return _project;

RubberduckTests/Mocks/MockUserFormBuilder.cs

@@ -8,6 +8,9 @@
 
 namespace RubberduckTests.Mocks
 {
+    /// <summary>
+    /// Builds a mock <see cref="UserForm"/> component.
+    /// </summary>
     public class MockUserFormBuilder
     {
         private readonly Mock<VBComponent> _component;
@@ -25,6 +28,11 @@ public MockUserFormBuilder(Mock<VBComponent> component)
             _vbControls = CreateControlsMock();
         }
 
+        /// <summary>
+        /// Adds a <see cref="Control"/> to the form.
+        /// </summary>
+        /// <param name="name">The name of the control to add.</param>
+        /// <returns></returns>
         public MockUserFormBuilder AddControl(string name)
         {
             var control = new Mock<Control>();
@@ -34,6 +42,10 @@ public MockUserFormBuilder AddControl(string name)
             return this;
         }
 
+        /// <summary>
+        /// Gets the mock <see cref="UserForm"/> component.
+        /// </summary>
+        /// <returns></returns>
         public Mock<VBComponent> Build()
         {
             var designer = CreateMockDesigner();

RubberduckTests/Mocks/MockVbeBuilder.cs

@@ -6,6 +6,9 @@
 
 namespace RubberduckTests.Mocks
 {
+    /// <summary>
+    /// Builds a mock <see cref="VBE"/>.
+    /// </summary>
     public class MockVbeBuilder
     {
         private readonly Mock<VBE> _vbe;
@@ -21,6 +24,12 @@ public MockVbeBuilder()
             _vbe = CreateVbeMock();
         }
 
+        /// <summary>
+        /// Adds a project to the mock VBE.
+        /// Use a <see cref="MockProjectBuilder"/> to build the <see cref="project"/>.
+        /// </summary>
+        /// <param name="project">A mock <see cref="VBProject"/>.</param>
+        /// <returns>Returns the <see cref="MockVbeBuilder"/> instance.</returns>
         public MockVbeBuilder AddProject(Mock<VBProject> project)
         {
             project.SetupGet(m => m.VBE).Returns(_vbe.Object);
@@ -34,12 +43,20 @@ public MockVbeBuilder AddProject(Mock<VBProject> project)
             return this;
         }
 
+        /// <summary>
+        /// Creates a <see cref="MockProjectBuilder"/> to build a new project.
+        /// </summary>
+        /// <param name="name">The name of the project to build.</param>
+        /// <param name="protection">A value that indicates whether the project is protected.</param>
         public MockProjectBuilder ProjectBuilder(string name, vbext_ProjectProtection protection)
         {
             var result = new MockProjectBuilder(name, protection, () => _vbe.Object);
             return result;
         }
 
+        /// <summary>
+        /// Gets the mock <see cref="VBE"/> instance.
+        /// </summary>
         public Mock<VBE> Build()
         {
             return _vbe;