Skip to content

Commit a458636

Browse files
author
rstam
committed
Added missing doc comments.
1 parent 07594e7 commit a458636

14 files changed

+19
-9
lines changed

Bson/IO/BsonBinaryReader.cs

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -160,6 +160,7 @@ public override bool ReadBoolean()
160160
/// <summary>
161161
/// Reads a BsonType from the reader.
162162
/// </summary>
163+
/// <typeparam name="TValue">The type of the BsonTrie values.</typeparam>
163164
/// <param name="bsonTrie">An optional trie to search for a value that matches the next element name.</param>
164165
/// <param name="found">Set to true if a matching value was found in the trie.</param>
165166
/// <param name="value">Set to the matching value found in the trie or null if no matching value was found.</param>

Bson/IO/BsonBuffer.cs

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -564,6 +564,7 @@ public string ReadCString()
564564
/// <summary>
565565
/// Reads a BSON CString from the reader (a null terminated string).
566566
/// </summary>
567+
/// <typeparam name="TValue">The type of the BsonTrie values.</typeparam>
567568
/// <param name="bsonTrie">An optional BsonTrie to use during decoding.</param>
568569
/// <param name="found">Set to true if the string was found in the trie.</param>
569570
/// <param name="value">Set to the value found in the trie; otherwise, null.</param>

Bson/IO/BsonDocumentReader.cs

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -103,6 +103,7 @@ public override bool ReadBoolean()
103103
/// <summary>
104104
/// Reads a BsonType from the reader.
105105
/// </summary>
106+
/// <typeparam name="TValue">The type of the BsonTrie values.</typeparam>
106107
/// <param name="bsonTrie">An optional trie to search for a value that matches the next element name.</param>
107108
/// <param name="found">Set to true if a matching value was found in the trie.</param>
108109
/// <param name="value">Set to the matching value found in the trie or null if no matching value was found.</param>

Bson/IO/BsonReader.cs

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -378,6 +378,7 @@ public BsonType ReadBsonType()
378378
/// <summary>
379379
/// Reads a BsonType from the reader.
380380
/// </summary>
381+
/// <typeparam name="TValue">The type of the BsonTrie values.</typeparam>
381382
/// <param name="bsonTrie">An optional trie to search for a value that matches the next element name.</param>
382383
/// <param name="found">Set to true if a matching value was found in the trie.</param>
383384
/// <param name="value">Set to the matching value found in the trie or null if no matching value was found.</param>

Bson/IO/BsonTrie.cs

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,7 @@ namespace MongoDB.Bson.IO
2222
/// <summary>
2323
/// Represents a mapping from a set of UTF8 encoded strings to a set of elementName/value pairs, implemented as a trie.
2424
/// </summary>
25+
/// <typeparam name="TValue">The type of the BsonTrie values.</typeparam>
2526
public class BsonTrie<TValue>
2627
{
2728
// private static fields
@@ -114,6 +115,7 @@ public bool TryGetValue(string elementName, out TValue value)
114115
/// <summary>
115116
/// Represents a node in a BsonTrie.
116117
/// </summary>
118+
/// <typeparam name="TValue">The type of the BsonTrie values.</typeparam>
117119
public sealed class BsonTrieNode<TValue>
118120
{
119121
// private fields

Bson/IO/JsonReader.cs

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -108,6 +108,7 @@ public override bool ReadBoolean()
108108
/// <summary>
109109
/// Reads a BsonType from the reader.
110110
/// </summary>
111+
/// <typeparam name="TValue">The type of the BsonTrie values.</typeparam>
111112
/// <param name="bsonTrie">An optional trie to search for a value that matches the next element name.</param>
112113
/// <param name="found">Set to true if a matching value was found in the trie.</param>
113114
/// <param name="value">Set to the matching value found in the trie or null if no matching value was found.</param>

Bson/Serialization/BsonDocumentBackedClass.cs

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -68,6 +68,7 @@ protected internal BsonDocument BackingDocument
6868
/// <summary>
6969
/// Gets the value from the backing document.
7070
/// </summary>
71+
/// <typeparam name="T">The type of the value.</typeparam>
7172
/// <param name="memberName">The member name.</param>
7273
/// <param name="defaultValue">The default value.</param>
7374
/// <returns>The value.</returns>

CSharpDriverDocs.shfbproj

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,7 @@
4545
<FeedbackEMailAddress>craig.wilson%4010gen.com, robert%4010gen.com sridhar%4010gen.com</FeedbackEMailAddress>
4646
<FeedbackEMailLinkText>CSharp driver API doc</FeedbackEMailLinkText>
4747
<FrameworkVersion>.NET 3.5</FrameworkVersion>
48-
<HelpFileVersion>1.5.0.4566</HelpFileVersion>
48+
<HelpFileVersion>1.6.0.4624</HelpFileVersion>
4949
</PropertyGroup>
5050
<!-- There are no properties for these groups. AnyCPU needs to appear in
5151
order for Visual Studio to perform the build. The others are optional

Driver/Builders/QueryBuilderTyped.cs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -303,7 +303,7 @@ public static IMongoQuery Near<TMember>(Expression<Func<TDocument, TMember>> mem
303303
/// <summary>
304304
/// Tests that an element does not equal the value (see $ne).
305305
/// </summary>
306-
/// <typeparam name="TMember"></typeparam>
306+
/// <typeparam name="TMember">The member type.</typeparam>
307307
/// <param name="memberExpression">The member expression.</param>
308308
/// <param name="value">The value.</param>
309309
/// <returns>An IMongoQuery.</returns>
@@ -963,7 +963,7 @@ public IMongoQuery Not(IMongoQuery query)
963963
/// <summary>
964964
/// Tests that an element does not equal the value (see $ne).
965965
/// </summary>
966-
/// <typeparam name="TMember"></typeparam>
966+
/// <typeparam name="TMember">The member type.</typeparam>
967967
/// <param name="memberExpression">The member expression.</param>
968968
/// <param name="value">The value.</param>
969969
/// <returns>An IMongoQuery.</returns>

Driver/Builders/UpdateBuilder.cs

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1205,6 +1205,7 @@ private void Inc(string name, BsonValue value)
12051205
/// <summary>
12061206
/// A builder for creating update modifiers.
12071207
/// </summary>
1208+
/// <typeparam name="TDocument">The document type.</typeparam>
12081209
public static class Update<TDocument>
12091210
{
12101211
// public static methods

0 commit comments

Comments
 (0)