Added documentation comments

Author: aivascu

src/EntityFrameworkCore.AutoFixture/Core/DbContextCustomization.cs

@@ -3,8 +3,12 @@
 
 namespace EntityFrameworkCore.AutoFixture.Core
 {
+    /// <summary>
+    /// Customizes AutoFixture to resolve database context options from fixture.
+    /// </summary>
     public class DbContextCustomization : ICustomization
     {
+        /// <inheritdoc />
         public virtual void Customize(IFixture fixture)
         {
             if (fixture is null) throw new ArgumentNullException(nameof(fixture));

src/EntityFrameworkCore.AutoFixture/Core/DbContextOptionsSpecimenBuilder.cs

@@ -5,21 +5,36 @@
 
 namespace EntityFrameworkCore.AutoFixture.Core
 {
+    /// <summary>
+    /// Creates options builders from the current context.
+    /// </summary>
     public class DbContextOptionsSpecimenBuilder : ISpecimenBuilder
     {
+        /// <summary>
+        /// Creates a new <see cref="DbContextOptionsBuilder"/> instance.
+        /// </summary>
         public DbContextOptionsSpecimenBuilder()
             : this(new IsDbContextOptionsSpecification())
         {
         }
 
+        /// <summary>
+        /// Creates a new <see cref="DbContextOptionsBuilder"/> instance.
+        /// </summary>
+        /// <param name="optionsSpecification">The options builder specification.</param>
+        /// <exception cref="ArgumentNullException">When <paramref name="optionsSpecification"/> is <see langword="null" />.</exception>
         public DbContextOptionsSpecimenBuilder(IRequestSpecification optionsSpecification)
         {
             this.OptionsSpecification = optionsSpecification
                 ?? throw new ArgumentNullException(nameof(optionsSpecification));
         }
 
+        /// <summary>
+        /// Gets the optiosn specification.
+        /// </summary>
         public IRequestSpecification OptionsSpecification { get; }
 
+        /// <inheritdoc />
         public object Create(object request, ISpecimenContext context)
         {
             if (context == null) throw new ArgumentNullException(nameof(context));

src/EntityFrameworkCore.AutoFixture/Core/IOptionsBuilder.cs

@@ -4,6 +4,12 @@ namespace EntityFrameworkCore.AutoFixture.Core
 {
     public interface IOptionsBuilder
     {
+        /// <summary>
+        /// Builds a database context options instance for a <paramref name="type"/>.
+        /// </summary>
+        /// <param name="type">The database context type.</param>
+        /// <returns>Returns a <see cref="Microsoft.EntityFrameworkCore.DbContextOptions{TContext}"/> instance,
+        /// casted to <see cref="object" />.</returns>
         object Build(Type type);
     }
 }

src/EntityFrameworkCore.AutoFixture/Core/OptionsBuilder.cs

@@ -5,10 +5,20 @@
 
 namespace EntityFrameworkCore.AutoFixture.Core
 {
+    /// <summary>
+    /// Creates database options builders for a <see cref="DbContext"/> type.
+    /// </summary>
     public abstract class OptionsBuilder : IOptionsBuilder
     {
+        /// <summary>
+        /// Builds a database context options instance for a <paramref name="type"/>.
+        /// </summary>
+        /// <typeparam name="TContext">the database context type.</typeparam>
+        /// <returns>Returns a <see cref="DbContextOptions{TContext}"/> instance,
+        /// casted to <see cref="object" />.</returns>
         public abstract DbContextOptions<TContext> Build<TContext>() where TContext : DbContext;
 
+        /// <inheritdoc />
         public virtual object Build(Type type)
         {
             if (type == null) throw new ArgumentNullException(nameof(type));

src/EntityFrameworkCore.AutoFixture/InMemory/InMemoryContextCustomization.cs

@@ -4,8 +4,12 @@
 
 namespace EntityFrameworkCore.AutoFixture.InMemory
 {
+    /// <summary>
+    /// Customizes AutoFixture to create in memory database contexts.
+    /// </summary>
     public class InMemoryContextCustomization : DbContextCustomization
     {
+        /// <inheritdoc />
         public override void Customize(IFixture fixture)
         {
             if (fixture is null) throw new ArgumentNullException(nameof(fixture));

src/EntityFrameworkCore.AutoFixture/InMemory/InMemoryOptionsBuilder.cs

@@ -4,21 +4,36 @@
 
 namespace EntityFrameworkCore.AutoFixture.InMemory
 {
+    /// <summary>
+    /// Creates database context options.
+    /// </summary>
     public class InMemoryOptionsBuilder : OptionsBuilder
     {
+        /// <summary>
+        /// Creates a <see cref="InMemoryOptionsBuilder"/> instance.
+        /// </summary>
+        /// <param name="databaseName">The name of the database.</param>
+        /// <exception cref="ArgumentNullException">When <paramref name="databaseName"/> is null.</exception>
         public InMemoryOptionsBuilder(string databaseName)
         {
             this.DatabaseName = databaseName
                 ?? throw new ArgumentNullException(nameof(databaseName));
         }
 
+        /// <summary>
+        /// Creates a <see cref="InMemoryOptionsBuilder"/> instance.
+        /// </summary>
         public InMemoryOptionsBuilder()
             : this(Guid.NewGuid().ToString())
         {
         }
 
+        /// <summary>
+        /// Gets the database name.
+        /// </summary>
         public string DatabaseName { get; }
 
+        /// <inheritdoc />
         public override DbContextOptions<TContext> Build<TContext>()
             => new DbContextOptionsBuilder<TContext>()
             .UseInMemoryDatabase(this.DatabaseName)

src/EntityFrameworkCore.AutoFixture/InMemory/InMemoryOptionsSpecimenBuilder.cs

@@ -4,21 +4,36 @@
 
 namespace EntityFrameworkCore.AutoFixture.InMemory
 {
+    /// <summary>
+    /// Creates in-memory options builders.
+    /// </summary>
     public class InMemoryOptionsSpecimenBuilder : ISpecimenBuilder
     {
-        public IRequestSpecification OptionsSpecification { get; }
-
+        /// <summary>
+        /// Creates a <see cref="InMemoryOptionsSpecimenBuilder"/> instance.
+        /// </summary>
+        /// <param name="optionsSpecification">The options builder specification.</param>
+        /// <exception cref="ArgumentNullException">When <paramref name="optionsSpecification"/> is <see langword="null" />.</exception>
         public InMemoryOptionsSpecimenBuilder(IRequestSpecification optionsSpecification)
         {
             this.OptionsSpecification = optionsSpecification
                 ?? throw new ArgumentNullException(nameof(optionsSpecification));
         }
 
+        /// <summary>
+        /// Creates a <see cref="InMemoryOptionsSpecimenBuilder"/> instance.
+        /// </summary>
         public InMemoryOptionsSpecimenBuilder()
             : this(new IsOptionsBuilder())
         {
         }
 
+        /// <summary>
+        /// Gets the options specification.
+        /// </summary>
+        public IRequestSpecification OptionsSpecification { get; }
+
+        /// <inheritdoc />
         public object Create(object request, ISpecimenContext context)
         {
             if (context == null) throw new ArgumentNullException(nameof(context));

src/EntityFrameworkCore.AutoFixture/Sqlite/SqliteConnectionSpecimenBuilder.cs

@@ -4,6 +4,9 @@
 
 namespace EntityFrameworkCore.AutoFixture.Sqlite
 {
+    /// <summary>
+    /// Creates <see cref="SqliteConnection"/> instances.
+    /// </summary>
     public class SqliteConnectionSpecimenBuilder : ISpecimenBuilder
     {
         public SqliteConnectionSpecimenBuilder(IRequestSpecification connectionSpecification)
@@ -19,6 +22,7 @@ public SqliteConnectionSpecimenBuilder()
 
         public IRequestSpecification ConnectionSpecification { get; }
 
+        /// <inheritdoc />
         public object Create(object request, ISpecimenContext context)
         {
             if (context == null) throw new ArgumentNullException(nameof(context));

src/EntityFrameworkCore.AutoFixture/Sqlite/SqliteContextCustomization.cs

@@ -4,8 +4,12 @@
 
 namespace EntityFrameworkCore.AutoFixture.Sqlite
 {
+    /// <summary>
+    /// Customizes AutoFixture to create sqlite Entity Framework database ontexts.
+    /// </summary>
     public class SqliteContextCustomization : DbContextCustomization
     {
+        /// <inheritdoc />
         public override void Customize(IFixture fixture)
         {
             if (fixture is null) throw new ArgumentNullException(nameof(fixture));

src/EntityFrameworkCore.AutoFixture/Sqlite/SqliteOptionsBuilder.cs

@@ -5,6 +5,9 @@
 
 namespace EntityFrameworkCore.AutoFixture.Sqlite
 {
+    /// <summary>
+    /// Creates <see cref="DbContextOptions{TContext}"/> using SQLite.
+    /// </summary>
     public class SqliteOptionsBuilder : OptionsBuilder
     {
         public SqliteOptionsBuilder(SqliteConnection connection)
@@ -13,8 +16,17 @@ public SqliteOptionsBuilder(SqliteConnection connection)
                 ?? throw new ArgumentNullException(nameof(connection));
         }
 
+        /// <summary>
+        /// Gets the database connection.
+        /// </summary>
         public SqliteConnection Connection { get; }
 
+        /// <summary>
+        /// Builds default <see cref="DbContextOptions{TContext}"/>,
+        /// using the SQLite connection.
+        /// </summary>
+        /// <typeparam name="TContext"></typeparam>
+        /// <returns>Returns a <see cref="DbContextOptions{TContext}" /> instance.</returns>
         public override DbContextOptions<TContext> Build<TContext>()
             => new DbContextOptionsBuilder<TContext>()
             .UseSqlite(this.Connection)