added comments and updated nuspec

This commit is contained in:
alexandre-spieser
2017-11-17 18:39:34 +00:00
parent 657beeac99
commit a3ae98d077
7 changed files with 95 additions and 5 deletions
@@ -2,7 +2,7 @@
<package >
<metadata>
<id>MongoDbGenericRepository</id>
<version>1.3</version>
<version>1.3.2</version>
<title>MongoDb Generic Repository</title>
<authors>Alexandre Spieser</authors>
<owners>Alexandre Spieser</owners>
@@ -10,7 +10,7 @@
<projectUrl>https://github.com/alexandre-spieser/mongodb-generic-repository</projectUrl>
<requireLicenseAcceptance>false</requireLicenseAcceptance>
<description>A generic repository implementation using the MongoDB C# Sharp 2.0 driver.</description>
<releaseNotes>Added support for Documents that have an Id of type TKey, and implement the IDocument{TKey} interface.</releaseNotes>
<releaseNotes>The MongoDbRepository now has a constructor that takes an IMongoDatabase.</releaseNotes>
<copyright>Copyright 2017 (c) Alexandre Spieser. All rights reserved.</copyright>
<tags>MongoDb Repository Generic NoSql</tags>
</metadata>
@@ -733,6 +733,12 @@
</summary>
<param name="mongoDbContext">A mongodb context implementing <see cref="T:MongoDbGenericRepository.IMongoDbContext"/></param>
</member>
<member name="M:MongoDbGenericRepository.BaseMongoRepository.#ctor(MongoDB.Driver.IMongoDatabase)">
<summary>
The contructor taking a <see cref="T:MongoDB.Driver.IMongoDatabase"/>.
</summary>
<param name="mongoDatabase">A mongodb context implementing <see cref="T:MongoDB.Driver.IMongoDatabase"/></param>
</member>
<member name="F:MongoDbGenericRepository.BaseMongoRepository.MongoDbContext">
<summary>
The MongoDbContext
@@ -1381,7 +1387,19 @@
<param name="groupProjection">The projected group result.</param>
<param name="partitionKey">The partition key of your document, if any.</param>
</member>
<!-- Commentaire XML incorrect pour le membre "M:MongoDbGenericRepository.BaseMongoRepository.GroupBy``3(System.Linq.Expressions.Expression{System.Func{``0,System.Boolean}},System.Linq.Expressions.Expression{System.Func{``0,``1}},System.Linq.Expressions.Expression{System.Func{System.Linq.IGrouping{``1,``0},``2}},System.String)" -->
<member name="M:MongoDbGenericRepository.BaseMongoRepository.GroupBy``3(System.Linq.Expressions.Expression{System.Func{``0,System.Boolean}},System.Linq.Expressions.Expression{System.Func{``0,``1}},System.Linq.Expressions.Expression{System.Func{System.Linq.IGrouping{``1,``0},``2}},System.String)">
<summary>
Groups filtered a collection of documents given a grouping criteria,
and returns a dictionary of listed document groups with keys having the different values of the grouping criteria.
</summary>
<typeparam name="TDocument">The type representing a Document.</typeparam>
<typeparam name="TGroupKey">The type of the grouping criteria.</typeparam>
<typeparam name="TProjection">The type of the projected group.</typeparam>
<param name="groupingCriteria">The grouping criteria.</param>
<param name="groupProjection">The projected group result.</param>
<param name="partitionKey">The partition key of your document, if any.</param>
<returns></returns>
</member>
<member name="M:MongoDbGenericRepository.BaseMongoRepository.GetPaginatedAsync``1(System.Linq.Expressions.Expression{System.Func{``0,System.Boolean}},System.Int32,System.Int32,System.String)">
<summary>
Asynchronously returns a paginated list of the documents matching the filter condition.
@@ -1472,6 +1490,12 @@
</summary>
<typeparam name="TDocument"></typeparam>
</member>
<member name="M:MongoDbGenericRepository.IMongoDbContext.SetGuidRepresentation(MongoDB.Bson.GuidRepresentation)">
<summary>
Sets the Guid representation of the MongoDb Driver.
</summary>
<param name="guidRepresentation">The new value of the GuidRepresentation</param>
</member>
<member name="T:MongoDbGenericRepository.Models.Document">
<summary>
This class represents a basic document that can be stored in MongoDb.
@@ -1570,6 +1594,12 @@
The IMongoDatabase from the official Mongodb driver
</summary>
</member>
<member name="M:MongoDbGenericRepository.MongoDbContext.SetGuidRepresentation(MongoDB.Bson.GuidRepresentation)">
<summary>
Sets the Guid representation of the MongoDb Driver.
</summary>
<param name="guidRepresentation">The new value of the GuidRepresentation</param>
</member>
<member name="M:MongoDbGenericRepository.MongoDbContext.#ctor(MongoDB.Driver.IMongoDatabase)">
<summary>
The constructor of the MongoDbContext, it needs a an object implementing <see cref="T:MongoDB.Driver.IMongoDatabase"/>.
@@ -733,6 +733,12 @@
</summary>
<param name="mongoDbContext">A mongodb context implementing <see cref="T:MongoDbGenericRepository.IMongoDbContext"/></param>
</member>
<member name="M:MongoDbGenericRepository.BaseMongoRepository.#ctor(MongoDB.Driver.IMongoDatabase)">
<summary>
The contructor taking a <see cref="T:MongoDB.Driver.IMongoDatabase"/>.
</summary>
<param name="mongoDatabase">A mongodb context implementing <see cref="T:MongoDB.Driver.IMongoDatabase"/></param>
</member>
<member name="F:MongoDbGenericRepository.BaseMongoRepository.MongoDbContext">
<summary>
The MongoDbContext
@@ -1381,7 +1387,19 @@
<param name="groupProjection">The projected group result.</param>
<param name="partitionKey">The partition key of your document, if any.</param>
</member>
<!-- Commentaire XML incorrect pour le membre "M:MongoDbGenericRepository.BaseMongoRepository.GroupBy``3(System.Linq.Expressions.Expression{System.Func{``0,System.Boolean}},System.Linq.Expressions.Expression{System.Func{``0,``1}},System.Linq.Expressions.Expression{System.Func{System.Linq.IGrouping{``1,``0},``2}},System.String)" -->
<member name="M:MongoDbGenericRepository.BaseMongoRepository.GroupBy``3(System.Linq.Expressions.Expression{System.Func{``0,System.Boolean}},System.Linq.Expressions.Expression{System.Func{``0,``1}},System.Linq.Expressions.Expression{System.Func{System.Linq.IGrouping{``1,``0},``2}},System.String)">
<summary>
Groups filtered a collection of documents given a grouping criteria,
and returns a dictionary of listed document groups with keys having the different values of the grouping criteria.
</summary>
<typeparam name="TDocument">The type representing a Document.</typeparam>
<typeparam name="TGroupKey">The type of the grouping criteria.</typeparam>
<typeparam name="TProjection">The type of the projected group.</typeparam>
<param name="groupingCriteria">The grouping criteria.</param>
<param name="groupProjection">The projected group result.</param>
<param name="partitionKey">The partition key of your document, if any.</param>
<returns></returns>
</member>
<member name="M:MongoDbGenericRepository.BaseMongoRepository.GetPaginatedAsync``1(System.Linq.Expressions.Expression{System.Func{``0,System.Boolean}},System.Int32,System.Int32,System.String)">
<summary>
Asynchronously returns a paginated list of the documents matching the filter condition.
@@ -1472,6 +1490,12 @@
</summary>
<typeparam name="TDocument"></typeparam>
</member>
<member name="M:MongoDbGenericRepository.IMongoDbContext.SetGuidRepresentation(MongoDB.Bson.GuidRepresentation)">
<summary>
Sets the Guid representation of the MongoDb Driver.
</summary>
<param name="guidRepresentation">The new value of the GuidRepresentation</param>
</member>
<member name="T:MongoDbGenericRepository.Models.Document">
<summary>
This class represents a basic document that can be stored in MongoDb.
@@ -1570,6 +1594,12 @@
The IMongoDatabase from the official Mongodb driver
</summary>
</member>
<member name="M:MongoDbGenericRepository.MongoDbContext.SetGuidRepresentation(MongoDB.Bson.GuidRepresentation)">
<summary>
Sets the Guid representation of the MongoDb Driver.
</summary>
<param name="guidRepresentation">The new value of the GuidRepresentation</param>
</member>
<member name="M:MongoDbGenericRepository.MongoDbContext.#ctor(MongoDB.Driver.IMongoDatabase)">
<summary>
The constructor of the MongoDbContext, it needs a an object implementing <see cref="T:MongoDB.Driver.IMongoDatabase"/>.
@@ -733,6 +733,12 @@
</summary>
<param name="mongoDbContext">A mongodb context implementing <see cref="T:MongoDbGenericRepository.IMongoDbContext"/></param>
</member>
<member name="M:MongoDbGenericRepository.BaseMongoRepository.#ctor(MongoDB.Driver.IMongoDatabase)">
<summary>
The contructor taking a <see cref="T:MongoDB.Driver.IMongoDatabase"/>.
</summary>
<param name="mongoDatabase">A mongodb context implementing <see cref="T:MongoDB.Driver.IMongoDatabase"/></param>
</member>
<member name="F:MongoDbGenericRepository.BaseMongoRepository.MongoDbContext">
<summary>
The MongoDbContext
@@ -1381,7 +1387,19 @@
<param name="groupProjection">The projected group result.</param>
<param name="partitionKey">The partition key of your document, if any.</param>
</member>
<!-- Commentaire XML incorrect pour le membre "M:MongoDbGenericRepository.BaseMongoRepository.GroupBy``3(System.Linq.Expressions.Expression{System.Func{``0,System.Boolean}},System.Linq.Expressions.Expression{System.Func{``0,``1}},System.Linq.Expressions.Expression{System.Func{System.Linq.IGrouping{``1,``0},``2}},System.String)" -->
<member name="M:MongoDbGenericRepository.BaseMongoRepository.GroupBy``3(System.Linq.Expressions.Expression{System.Func{``0,System.Boolean}},System.Linq.Expressions.Expression{System.Func{``0,``1}},System.Linq.Expressions.Expression{System.Func{System.Linq.IGrouping{``1,``0},``2}},System.String)">
<summary>
Groups filtered a collection of documents given a grouping criteria,
and returns a dictionary of listed document groups with keys having the different values of the grouping criteria.
</summary>
<typeparam name="TDocument">The type representing a Document.</typeparam>
<typeparam name="TGroupKey">The type of the grouping criteria.</typeparam>
<typeparam name="TProjection">The type of the projected group.</typeparam>
<param name="groupingCriteria">The grouping criteria.</param>
<param name="groupProjection">The projected group result.</param>
<param name="partitionKey">The partition key of your document, if any.</param>
<returns></returns>
</member>
<member name="M:MongoDbGenericRepository.BaseMongoRepository.GetPaginatedAsync``1(System.Linq.Expressions.Expression{System.Func{``0,System.Boolean}},System.Int32,System.Int32,System.String)">
<summary>
Asynchronously returns a paginated list of the documents matching the filter condition.
@@ -1472,6 +1490,12 @@
</summary>
<typeparam name="TDocument"></typeparam>
</member>
<member name="M:MongoDbGenericRepository.IMongoDbContext.SetGuidRepresentation(MongoDB.Bson.GuidRepresentation)">
<summary>
Sets the Guid representation of the MongoDb Driver.
</summary>
<param name="guidRepresentation">The new value of the GuidRepresentation</param>
</member>
<member name="T:MongoDbGenericRepository.Models.Document">
<summary>
This class represents a basic document that can be stored in MongoDb.
@@ -1570,6 +1594,12 @@
The IMongoDatabase from the official Mongodb driver
</summary>
</member>
<member name="M:MongoDbGenericRepository.MongoDbContext.SetGuidRepresentation(MongoDB.Bson.GuidRepresentation)">
<summary>
Sets the Guid representation of the MongoDb Driver.
</summary>
<param name="guidRepresentation">The new value of the GuidRepresentation</param>
</member>
<member name="M:MongoDbGenericRepository.MongoDbContext.#ctor(MongoDB.Driver.IMongoDatabase)">
<summary>
The constructor of the MongoDbContext, it needs a an object implementing <see cref="T:MongoDB.Driver.IMongoDatabase"/>.