Skip to content

Commit e4b0f6c

Browse files
rstamrstam
committed
CSHARP-938: Fix doc comment warnings.
1 parent 2cfe34a commit e4b0f6c

24 files changed

+69
-37
lines changed

‎Docs/Api/CSharpDriverDocs.shfbproj

Lines changed: 20 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88
<Platform Condition=" '$(Platform)' == '' ">AnyCPU</Platform>
99
<SchemaVersion>2.0</SchemaVersion>
1010
<ProjectGuid>{cf31cff3-1925-457c-8775-e08bcd39e49f}</ProjectGuid>
11-
<SHFBSchemaVersion>1.9.5.0</SHFBSchemaVersion>
11+
<SHFBSchemaVersion>1.9.9.0</SHFBSchemaVersion>
1212
<!-- AssemblyName, Name, and RootNamespace are not used by SHFB but Visual
1313
Studio adds them anyway -->
1414
<AssemblyName>Documentation</AssemblyName>
@@ -28,21 +28,25 @@
2828
<HelpTitle>MongoDB C# Driver API Documentation</HelpTitle>
2929
<NamespaceSummaries>
3030
<NamespaceSummaryItem name="MongoDB.Bson" isDocumented="True">The MongoDB.Bson top level namespace and its child namespaces contain the classes for managing Bson data. The top level MongoDB.Bson namespace contains the classes that represent all the basic Bson Types.</NamespaceSummaryItem>
31-
<NamespaceSummaryItem name="MongoDB.Bson.IO" isDocumented="True">The MongoDB.Bson.IO namespace contains the types that allow reading and writing of Bson data.</NamespaceSummaryItem>
32-
<NamespaceSummaryItem name="MongoDB.Bson.Serialization" isDocumented="True">The MongoDB.Bson.Serialization namespace contains the types used in the serialization and deserialization of Bson data. It also contains the base interfaces to be implemented by the actual serializers.</NamespaceSummaryItem>
33-
<NamespaceSummaryItem name="(global)" isDocumented="False" />
34-
<NamespaceSummaryItem name="MongoDB.Bson.Serialization.Attributes" isDocumented="True">The MongoDB.Bson.Serialization.Attributes namespace contains the Attributes used to control Bson serialization/deserialization.</NamespaceSummaryItem>
35-
<NamespaceSummaryItem name="MongoDB.Bson.Serialization.Conventions" isDocumented="True">The various conventions used during serialization/deserialization of Bson data are represented by the types in the MongoDB.Bson.Serialization.Conventions namespace.</NamespaceSummaryItem>
36-
<NamespaceSummaryItem name="MongoDB.Bson.Serialization.IdGenerators" isDocumented="True">The various id generators used in the serialization/deserialization of Bson data are represented in this namespace.</NamespaceSummaryItem>
37-
<NamespaceSummaryItem name="MongoDB.Bson.Serialization.Options" isDocumented="True">The MongoDB.Bson.Serialization.Options namespace contains the classes that represent the serialization options for specific types such as DateTime, Document etc.</NamespaceSummaryItem>
38-
<NamespaceSummaryItem name="MongoDB.Bson.Serialization.Serializers" isDocumented="True">The MongoDB.Bson.Serialization.Serializers namespace contains the serializers for the various Bson and base .Net types</NamespaceSummaryItem>
39-
<NamespaceSummaryItem name="MongoDB.Driver" isDocumented="True">The MongoDB.Driver namespace contains all the basic types and classes that compose the MongoDB driver. It contains the classes needed for most interactions with the database.</NamespaceSummaryItem>
40-
<NamespaceSummaryItem name="MongoDB.Driver.Builders" isDocumented="True">The MongoDB.Driver.Builders namespace contains helper classes (builders) that can be used to construct various options used in the driver.</NamespaceSummaryItem>
41-
<NamespaceSummaryItem name="MongoDB.Driver.GridFS" isDocumented="True">The classes used to interact with MongoDB GridFS are part of the MongoDB.Driver.GridFS namespace.</NamespaceSummaryItem>
42-
<NamespaceSummaryItem name="MongoDB.Driver.Internal" isDocumented="True">The MongoDB.Driver.Internal namespace contains internal classes used by the driver such as ConnectionPool.</NamespaceSummaryItem>
43-
<NamespaceSummaryItem name="MongoDB.Driver.Wrappers" isDocumented="True">Wrapped versions of various classes for use in serialization are present in the MongoDB.Driver.Wrappers namespace.</NamespaceSummaryItem>
44-
<NamespaceSummaryItem name="MongoDB.Driver.Linq" isDocumented="True">The MongoDB.Driver.Linq namespace contains the LINQ related classes.</NamespaceSummaryItem>
45-
</NamespaceSummaries>
31+
<NamespaceSummaryItem name="MongoDB.Bson.IO" isDocumented="True">The MongoDB.Bson.IO namespace contains the types that allow reading and writing of Bson data.</NamespaceSummaryItem>
32+
<NamespaceSummaryItem name="MongoDB.Bson.Serialization" isDocumented="True">The MongoDB.Bson.Serialization namespace contains the types used in the serialization and deserialization of Bson data. It also contains the base interfaces to be implemented by the actual serializers.</NamespaceSummaryItem>
33+
<NamespaceSummaryItem name="(global)" isDocumented="False" />
34+
<NamespaceSummaryItem name="MongoDB.Bson.Serialization.Attributes" isDocumented="True">The MongoDB.Bson.Serialization.Attributes namespace contains the Attributes used to control Bson serialization/deserialization.</NamespaceSummaryItem>
35+
<NamespaceSummaryItem name="MongoDB.Bson.Serialization.Conventions" isDocumented="True">The various conventions used during serialization/deserialization of Bson data are represented by the types in the MongoDB.Bson.Serialization.Conventions namespace.</NamespaceSummaryItem>
36+
<NamespaceSummaryItem name="MongoDB.Bson.Serialization.IdGenerators" isDocumented="True">The various id generators used in the serialization/deserialization of Bson data are represented in this namespace.</NamespaceSummaryItem>
37+
<NamespaceSummaryItem name="MongoDB.Bson.Serialization.Options" isDocumented="True">The MongoDB.Bson.Serialization.Options namespace contains the classes that represent the serialization options for specific types such as DateTime, Document etc.</NamespaceSummaryItem>
38+
<NamespaceSummaryItem name="MongoDB.Bson.Serialization.Serializers" isDocumented="True">The MongoDB.Bson.Serialization.Serializers namespace contains the serializers for the various Bson and base .Net types</NamespaceSummaryItem>
39+
<NamespaceSummaryItem name="MongoDB.Driver" isDocumented="True">The MongoDB.Driver namespace contains all the basic types and classes that compose the MongoDB driver. It contains the classes needed for most interactions with the database.</NamespaceSummaryItem>
40+
<NamespaceSummaryItem name="MongoDB.Driver.Builders" isDocumented="True">The MongoDB.Driver.Builders namespace contains helper classes (builders) that can be used to construct various options used in the driver.</NamespaceSummaryItem>
41+
<NamespaceSummaryItem name="MongoDB.Driver.GridFS" isDocumented="True">The classes used to interact with MongoDB GridFS are part of the MongoDB.Driver.GridFS namespace.</NamespaceSummaryItem>
42+
<NamespaceSummaryItem name="MongoDB.Driver.Internal" isDocumented="True">The MongoDB.Driver.Internal namespace contains internal classes used by the driver such as ConnectionPool.</NamespaceSummaryItem>
43+
<NamespaceSummaryItem name="MongoDB.Driver.Wrappers" isDocumented="True">Wrapped versions of various classes for use in serialization are present in the MongoDB.Driver.Wrappers namespace.</NamespaceSummaryItem>
44+
<NamespaceSummaryItem name="MongoDB.Driver.Linq" isDocumented="True">The MongoDB.Driver.Linq namespace contains the LINQ related classes.</NamespaceSummaryItem>
45+
<NamespaceSummaryItem name="MongoDB.Driver.Communication.Security" isDocumented="True">The MongoDB.Driver.Communication.Security namespaces contains classes related to security.</NamespaceSummaryItem>
46+
<NamespaceSummaryItem name="MongoDB.Driver.Communication.Security.Mechanisms.Gsasl" isDocumented="True">The MongoDB.Driver.Communication.Security.Gsasl namespaces contains classes related to GSSASL.</NamespaceSummaryItem>
47+
<NamespaceSummaryItem name="MongoDB.Driver.Communication.Security.Mechanisms.Sspi" isDocumented="True">The MongoDB.Driver.Communication.Security.SSPI namespaces contains classes related to SSPI.</NamespaceSummaryItem>
48+
<NamespaceSummaryItem name="MongoDB.Driver.GeoJsonObjectModel" isDocumented="True">The MongoDB.Driver.GeoJsonObjectModel namespaces contains classes related to GeoJson.</NamespaceSummaryItem>
49+
<NamespaceSummaryItem name="MongoDB.Driver.GeoJsonObjectModel.Serializers" isDocumented="True">The MongoDB.Driver.GeoJsonObjectModel.Serializers namespaces contains GeoJson serializers..</NamespaceSummaryItem></NamespaceSummaries>
4650
<CopyrightText>Copyright &amp;#169%3b 2010-2014 MongoDB Inc.</CopyrightText>
4751
<FeedbackEMailAddress>dotnet-driver@mongodb.com</FeedbackEMailAddress>
4852
<FeedbackEMailLinkText>MongoDB</FeedbackEMailLinkText>

‎MongoDB.Bson/IO/BsonBuffer.cs

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -378,6 +378,7 @@ public void ReadObjectId(out int timestamp, out int machine, out short pid, out
378378
/// <summary>
379379
/// Reads a BSON string from the reader.
380380
/// </summary>
381+
/// <param name="encoding">The encoding.</param>
381382
/// <returns>A String.</returns>
382383
public string ReadString(UTF8Encoding encoding)
383384
{
@@ -416,6 +417,7 @@ public string ReadString(UTF8Encoding encoding)
416417
/// <summary>
417418
/// Reads a BSON CString from the reader (a null terminated string).
418419
/// </summary>
420+
/// <param name="encoding">The encoding.</param>
419421
/// <returns>A string.</returns>
420422
public string ReadCString(UTF8Encoding encoding)
421423
{

‎MongoDB.Bson/Serialization/Serializers/EnumerableSerializerBase.cs

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -31,6 +31,7 @@ public abstract class EnumerableSerializerBase : BsonBaseSerializer, IBsonArrayS
3131
/// <summary>
3232
/// Initializes a new instance of the EnumerableSerializerBase class.
3333
/// </summary>
34+
/// <param name="defaultSerializationOptions">The default serialization options for this serializer.</param>
3435
public EnumerableSerializerBase(IBsonSerializationOptions defaultSerializationOptions)
3536
: base(defaultSerializationOptions)
3637
{
@@ -230,6 +231,7 @@ public abstract class EnumerableSerializerBase<T> : BsonBaseSerializer, IBsonArr
230231
/// <summary>
231232
/// Initializes a new instance of the EnumerableSerializer class.
232233
/// </summary>
234+
/// <param name="defaultSerializationOptions">The default serialization options for this serializer.</param>
233235
public EnumerableSerializerBase(IBsonSerializationOptions defaultSerializationOptions)
234236
: base(defaultSerializationOptions)
235237
{

‎MongoDB.Driver/Builders/CollectionOptionsBuilder.cs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -151,7 +151,7 @@ public CollectionOptionsBuilder SetMaxSize(long value)
151151
}
152152

153153
/// <summary>
154-
/// Sets the storage options.
154+
/// Sets the storage engine options.
155155
/// </summary>
156156
/// <param name="value">The value.</param>
157157
/// <returns>The builder (so method calls can be chained).</returns>

‎MongoDB.Driver/Builders/GroupByBuilder.cs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -147,7 +147,7 @@ public class GroupByBuilder<TDocument> : BuilderBase, IMongoGroupBy
147147

148148
// constructors
149149
/// <summary>
150-
/// Initializes a new instance of the <see cref="GroupByBuilder&lt;TDocument&gt;"/> class.
150+
/// Initializes a new instance of the <see cref="GroupByBuilder{TDocument}"/> class.
151151
/// </summary>
152152
public GroupByBuilder()
153153
{

‎MongoDB.Driver/Builders/IndexOptionsBuilder.cs

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -110,7 +110,7 @@ public static IndexOptionsBuilder SetSparse(bool value)
110110
}
111111

112112
/// <summary>
113-
/// Sets the storage options.
113+
/// Sets the storage engine options.
114114
/// </summary>
115115
/// <param name="value">The value.</param>
116116
/// <returns>The builder (so method calls can be chained).</returns>
@@ -272,7 +272,7 @@ public IndexOptionsBuilder SetSparse(bool value)
272272
}
273273

274274
/// <summary>
275-
/// Sets the storage options.
275+
/// Sets the storage engine options.
276276
/// </summary>
277277
/// <param name="value">The value.</param>
278278
/// <returns>The builder (so method calls can be chained).</returns>
@@ -456,7 +456,7 @@ public static IndexOptionsBuilder<TDocument> SetSparse(bool value)
456456
}
457457

458458
/// <summary>
459-
/// Sets the storage options.
459+
/// Sets the storage engine options.
460460
/// </summary>
461461
/// <param name="value">The value.</param>
462462
/// <returns>The builder (so method calls can be chained).</returns>
@@ -623,7 +623,7 @@ public IndexOptionsBuilder<TDocument> SetSparse(bool value)
623623
}
624624

625625
/// <summary>
626-
/// Sets the storage options.
626+
/// Sets the storage engine options.
627627
/// </summary>
628628
/// <param name="value">The value.</param>
629629
/// <returns>The builder (so method calls can be chained).</returns>

‎MongoDB.Driver/Builders/QueryBuilder.cs

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -346,6 +346,7 @@ public static IMongoQuery Near<TCoordinates>(string name, GeoJsonPoint<TCoordina
346346
/// <summary>
347347
/// Tests that the value of the named element is near some location (see $near).
348348
/// </summary>
349+
/// <typeparam name="TCoordinates">The type of the coordinates.</typeparam>
349350
/// <param name="name">The name of the element to test.</param>
350351
/// <param name="point">The point.</param>
351352
/// <param name="maxDistance">The max distance.</param>
@@ -359,6 +360,7 @@ public static IMongoQuery Near<TCoordinates>(string name, GeoJsonPoint<TCoordina
359360
/// <summary>
360361
/// Tests that the value of the named element is near some location (see $near).
361362
/// </summary>
363+
/// <typeparam name="TCoordinates">The type of the coordinates.</typeparam>
362364
/// <param name="name">The name of the element to test.</param>
363365
/// <param name="point">The point.</param>
364366
/// <param name="maxDistance">The max distance.</param>
@@ -1533,14 +1535,14 @@ public class QueryBuilder<TDocument>
15331535

15341536
// constructors
15351537
/// <summary>
1536-
/// Initializes a new instance of the <see cref="QueryBuilder&lt;TDocument&gt;"/> class.
1538+
/// Initializes a new instance of the <see cref="QueryBuilder{TDocument}"/> class.
15371539
/// </summary>
15381540
public QueryBuilder()
15391541
: this(new BsonSerializationInfoHelper())
15401542
{ }
15411543

15421544
/// <summary>
1543-
/// Initializes a new instance of the <see cref="QueryBuilder&lt;TDocument&gt;"/> class.
1545+
/// Initializes a new instance of the <see cref="QueryBuilder{TDocument}"/> class.
15441546
/// </summary>
15451547
/// <param name="serializationInfoHelper">The serialization info helper.</param>
15461548
internal QueryBuilder(BsonSerializationInfoHelper serializationInfoHelper)

‎MongoDB.Driver/Builders/SortByBuilder.cs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -208,7 +208,7 @@ public class SortByBuilder<TDocument> : BuilderBase, IMongoSortBy
208208

209209
// constructors
210210
/// <summary>
211-
/// Initializes a new instance of the <see cref="SortByBuilder&lt;TDocument&gt;"/> class.
211+
/// Initializes a new instance of the <see cref="SortByBuilder{TDocument}"/> class.
212212
/// </summary>
213213
public SortByBuilder()
214214
: this(new BsonSerializationInfoHelper())

‎MongoDB.Driver/Builders/UpdateBuilder.cs

Lines changed: 9 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -566,6 +566,7 @@ public static UpdateBuilder PushEach(string name, PushEachOptions options, param
566566
/// <summary>
567567
/// Adds a list of values to the end of the named array element (see $push and $each).
568568
/// </summary>
569+
/// <typeparam name="T">The type of the wrapped values.</typeparam>
569570
/// <param name="name">The name of the array element.</param>
570571
/// <param name="values">The values to add to the end of the array.</param>
571572
/// <returns>The builder (so method calls can be chained).</returns>
@@ -577,7 +578,7 @@ public static UpdateBuilder PushEachWrapped<T>(string name, IEnumerable<T> value
577578
/// <summary>
578579
/// Adds a list of values to the end of the named array element (see $push and $each).
579580
/// </summary>
580-
/// <typeparam name="T">The type of wrapped value.</typeparam>
581+
/// <typeparam name="T">The type of the wrapped values.</typeparam>
581582
/// <param name="name">The name of the array element.</param>
582583
/// <param name="values">The values to add to the end of the array.</param>
583584
/// <returns>The builder (so method calls can be chained).</returns>
@@ -589,7 +590,7 @@ public static UpdateBuilder PushEachWrapped<T>(string name, params T[] values)
589590
/// <summary>
590591
/// Adds a list of values to the end of the named array element (see $push and $each).
591592
/// </summary>
592-
/// <typeparam name="T">The type of wrapped value.</typeparam>
593+
/// <typeparam name="T">The type of the wrapped values.</typeparam>
593594
/// <param name="name">The name of the array element.</param>
594595
/// <param name="options">The options.</param>
595596
/// <param name="values">The values to add to the end of the array.</param>
@@ -602,7 +603,7 @@ public static UpdateBuilder PushEachWrapped<T>(string name, PushEachOptions opti
602603
/// <summary>
603604
/// Adds a list of values to the end of the named array element (see $push and $each).
604605
/// </summary>
605-
/// <typeparam name="T">The type of wrapped value.</typeparam>
606+
/// <typeparam name="T">The type of the wrapped values.</typeparam>
606607
/// <param name="name">The name of the array element.</param>
607608
/// <param name="options">The options.</param>
608609
/// <param name="values">The values to add to the end of the array.</param>
@@ -1529,6 +1530,7 @@ public UpdateBuilder PushEach(string name, PushEachOptions options, params BsonV
15291530
/// <summary>
15301531
/// Adds a list of values to the end of the named array element (see $push and $each).
15311532
/// </summary>
1533+
/// <typeparam name="T">The type of the wrapped values.</typeparam>
15321534
/// <param name="name">The name of the array element.</param>
15331535
/// <param name="values">The values to add to the end of the array.</param>
15341536
/// <returns>The builder (so method calls can be chained).</returns>
@@ -1542,6 +1544,7 @@ public UpdateBuilder PushEachWrapped<T>(string name, IEnumerable<T> values)
15421544
/// <summary>
15431545
/// Adds a list of values to the end of the named array element (see $push and $each).
15441546
/// </summary>
1547+
/// <typeparam name="T">The type of the wrapped values.</typeparam>
15451548
/// <param name="name">The name of the array element.</param>
15461549
/// <param name="values">The values to add to the end of the array.</param>
15471550
/// <returns>The builder (so method calls can be chained).</returns>
@@ -1555,6 +1558,7 @@ public UpdateBuilder PushEachWrapped<T>(string name, params T[] values)
15551558
/// <summary>
15561559
/// Adds a list of values to the end of the named array element (see $push and $each).
15571560
/// </summary>
1561+
/// <typeparam name="T">The type of the wrapped values.</typeparam>
15581562
/// <param name="name">The name of the array element.</param>
15591563
/// <param name="args">The args.</param>
15601564
/// <param name="values">The values to add to the end of the array.</param>
@@ -1570,6 +1574,7 @@ public UpdateBuilder PushEachWrapped<T>(string name, PushEachOptions args, IEnum
15701574
/// <summary>
15711575
/// Adds a list of values to the end of the named array element (see $push and $each).
15721576
/// </summary>
1577+
/// <typeparam name="T">The type of the wrapped values.</typeparam>
15731578
/// <param name="name">The name of the array element.</param>
15741579
/// <param name="args">The args.</param>
15751580
/// <param name="values">The values to add to the end of the array.</param>
@@ -2868,6 +2873,7 @@ public UpdateBuilder<TDocument> PushAll<TValue>(Expression<Func<TDocument, IEnum
28682873
/// <summary>
28692874
/// Adds a list of values to the end of the named array element (see $push and $each).
28702875
/// </summary>
2876+
/// <typeparam name="TValue">The type of the value.</typeparam>
28712877
/// <param name="memberExpression">The name of the array element.</param>
28722878
/// <param name="values">The values to add to the end of the array.</param>
28732879
/// <returns>The builder (so method calls can be chained).</returns>

‎MongoDB.Driver/CommandResults/DistinctCommandResult.cs

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,7 @@ namespace MongoDB.Driver
2323
/// <summary>
2424
/// Represents the result of a command (there are also subclasses for various commands).
2525
/// </summary>
26+
/// <typeparam name="TValue">The type of the values.</typeparam>
2627
[Serializable]
2728
[BsonSerializer(typeof(DistinctCommandResultSerializer<>))]
2829
public class DistinctCommandResult<TValue> : CommandResult

0 commit comments

Comments
 (0)