Skip to content

Commit

Permalink
Added missing doc comments.
Browse files Browse the repository at this point in the history
  • Loading branch information
rstam committed Aug 29, 2012
1 parent 07594e7 commit a458636
Show file tree
Hide file tree
Showing 14 changed files with 19 additions and 9 deletions.
1 change: 1 addition & 0 deletions Bson/IO/BsonBinaryReader.cs
Original file line number Diff line number Diff line change
Expand Up @@ -160,6 +160,7 @@ public override bool ReadBoolean()
/// <summary>
/// Reads a BsonType from the reader.
/// </summary>
/// <typeparam name="TValue">The type of the BsonTrie values.</typeparam>
/// <param name="bsonTrie">An optional trie to search for a value that matches the next element name.</param>
/// <param name="found">Set to true if a matching value was found in the trie.</param>
/// <param name="value">Set to the matching value found in the trie or null if no matching value was found.</param>
Expand Down
1 change: 1 addition & 0 deletions Bson/IO/BsonBuffer.cs
Original file line number Diff line number Diff line change
Expand Up @@ -564,6 +564,7 @@ public string ReadCString()
/// <summary>
/// Reads a BSON CString from the reader (a null terminated string).
/// </summary>
/// <typeparam name="TValue">The type of the BsonTrie values.</typeparam>
/// <param name="bsonTrie">An optional BsonTrie to use during decoding.</param>
/// <param name="found">Set to true if the string was found in the trie.</param>
/// <param name="value">Set to the value found in the trie; otherwise, null.</param>
Expand Down
1 change: 1 addition & 0 deletions Bson/IO/BsonDocumentReader.cs
Original file line number Diff line number Diff line change
Expand Up @@ -103,6 +103,7 @@ public override bool ReadBoolean()
/// <summary>
/// Reads a BsonType from the reader.
/// </summary>
/// <typeparam name="TValue">The type of the BsonTrie values.</typeparam>
/// <param name="bsonTrie">An optional trie to search for a value that matches the next element name.</param>
/// <param name="found">Set to true if a matching value was found in the trie.</param>
/// <param name="value">Set to the matching value found in the trie or null if no matching value was found.</param>
Expand Down
1 change: 1 addition & 0 deletions Bson/IO/BsonReader.cs
Original file line number Diff line number Diff line change
Expand Up @@ -378,6 +378,7 @@ public BsonType ReadBsonType()
/// <summary>
/// Reads a BsonType from the reader.
/// </summary>
/// <typeparam name="TValue">The type of the BsonTrie values.</typeparam>
/// <param name="bsonTrie">An optional trie to search for a value that matches the next element name.</param>
/// <param name="found">Set to true if a matching value was found in the trie.</param>
/// <param name="value">Set to the matching value found in the trie or null if no matching value was found.</param>
Expand Down
2 changes: 2 additions & 0 deletions Bson/IO/BsonTrie.cs
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,7 @@ namespace MongoDB.Bson.IO
/// <summary>
/// Represents a mapping from a set of UTF8 encoded strings to a set of elementName/value pairs, implemented as a trie.
/// </summary>
/// <typeparam name="TValue">The type of the BsonTrie values.</typeparam>
public class BsonTrie<TValue>
{
// private static fields
Expand Down Expand Up @@ -114,6 +115,7 @@ public bool TryGetValue(string elementName, out TValue value)
/// <summary>
/// Represents a node in a BsonTrie.
/// </summary>
/// <typeparam name="TValue">The type of the BsonTrie values.</typeparam>
public sealed class BsonTrieNode<TValue>
{
// private fields
Expand Down
1 change: 1 addition & 0 deletions Bson/IO/JsonReader.cs
Original file line number Diff line number Diff line change
Expand Up @@ -108,6 +108,7 @@ public override bool ReadBoolean()
/// <summary>
/// Reads a BsonType from the reader.
/// </summary>
/// <typeparam name="TValue">The type of the BsonTrie values.</typeparam>
/// <param name="bsonTrie">An optional trie to search for a value that matches the next element name.</param>
/// <param name="found">Set to true if a matching value was found in the trie.</param>
/// <param name="value">Set to the matching value found in the trie or null if no matching value was found.</param>
Expand Down
1 change: 1 addition & 0 deletions Bson/Serialization/BsonDocumentBackedClass.cs
Original file line number Diff line number Diff line change
Expand Up @@ -68,6 +68,7 @@ protected internal BsonDocument BackingDocument
/// <summary>
/// Gets the value from the backing document.
/// </summary>
/// <typeparam name="T">The type of the value.</typeparam>
/// <param name="memberName">The member name.</param>
/// <param name="defaultValue">The default value.</param>
/// <returns>The value.</returns>
Expand Down
2 changes: 1 addition & 1 deletion CSharpDriverDocs.shfbproj
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@
<FeedbackEMailAddress>craig.wilson%4010gen.com, robert%4010gen.com sridhar%4010gen.com</FeedbackEMailAddress>
<FeedbackEMailLinkText>CSharp driver API doc</FeedbackEMailLinkText>
<FrameworkVersion>.NET 3.5</FrameworkVersion>
<HelpFileVersion>1.5.0.4566</HelpFileVersion>
<HelpFileVersion>1.6.0.4624</HelpFileVersion>
</PropertyGroup>
<!-- There are no properties for these groups. AnyCPU needs to appear in
order for Visual Studio to perform the build. The others are optional
Expand Down
4 changes: 2 additions & 2 deletions Driver/Builders/QueryBuilderTyped.cs
Original file line number Diff line number Diff line change
Expand Up @@ -303,7 +303,7 @@ public static IMongoQuery Near<TMember>(Expression<Func<TDocument, TMember>> mem
/// <summary>
/// Tests that an element does not equal the value (see $ne).
/// </summary>
/// <typeparam name="TMember"></typeparam>
/// <typeparam name="TMember">The member type.</typeparam>
/// <param name="memberExpression">The member expression.</param>
/// <param name="value">The value.</param>
/// <returns>An IMongoQuery.</returns>
Expand Down Expand Up @@ -963,7 +963,7 @@ public IMongoQuery Not(IMongoQuery query)
/// <summary>
/// Tests that an element does not equal the value (see $ne).
/// </summary>
/// <typeparam name="TMember"></typeparam>
/// <typeparam name="TMember">The member type.</typeparam>
/// <param name="memberExpression">The member expression.</param>
/// <param name="value">The value.</param>
/// <returns>An IMongoQuery.</returns>
Expand Down
1 change: 1 addition & 0 deletions Driver/Builders/UpdateBuilder.cs
Original file line number Diff line number Diff line change
Expand Up @@ -1205,6 +1205,7 @@ private void Inc(string name, BsonValue value)
/// <summary>
/// A builder for creating update modifiers.
/// </summary>
/// <typeparam name="TDocument">The document type.</typeparam>
public static class Update<TDocument>
{
// public static methods
Expand Down
4 changes: 2 additions & 2 deletions Driver/Core/MongoServerBuildInfo.cs
Original file line number Diff line number Diff line change
Expand Up @@ -118,8 +118,8 @@ private Version ParseVersion(string versionString)
/// <summary>
/// Creates a new instance of MongoServerBuildInfo initialized from the result of a buildinfo command.
/// </summary>
/// <param name="result"></param>
/// <returns></returns>
/// <param name="result">A CommandResult.</param>
/// <returns>A MongoServerBuildInfo.</returns>
public static MongoServerBuildInfo FromCommandResult(CommandResult result)
{
var document = result.Response;
Expand Down
6 changes: 3 additions & 3 deletions Driver/Core/SystemProfileInfo.cs
Original file line number Diff line number Diff line change
Expand Up @@ -493,7 +493,7 @@ public static SystemProfileInfoSerializer Instance
/// Creates the instance.
/// </summary>
/// <param name="backingDocument">The backing document.</param>
/// <returns></returns>
/// <returns>A SystemProfileInfo instance.</returns>
protected override SystemProfileInfo CreateInstance(BsonDocument backingDocument)
{
return new SystemProfileInfo(backingDocument);
Expand Down Expand Up @@ -532,7 +532,7 @@ public static SystemProfileLockStatisticsSerializer Instance
/// Creates the instance.
/// </summary>
/// <param name="backingDocument">The backing document.</param>
/// <returns></returns>
/// <returns>A SystemProfileLockStatistics instance.</returns>
protected override SystemProfileLockStatistics CreateInstance(BsonDocument backingDocument)
{
return new SystemProfileLockStatistics(backingDocument);
Expand Down Expand Up @@ -572,7 +572,7 @@ public static SystemProfileReadWriteLockStatisticsSerializer Instance
/// Creates the instance.
/// </summary>
/// <param name="backingDocument">The backing document.</param>
/// <returns></returns>
/// <returns>A SystemProfileReadWriteLockStatistics instance.</returns>
protected override SystemProfileReadWriteLockStatistics CreateInstance(BsonDocument backingDocument)
{
return new SystemProfileReadWriteLockStatistics(backingDocument);
Expand Down
1 change: 1 addition & 0 deletions Driver/Linq/Expressions/ExpressionVisitorGeneric.cs
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,7 @@ namespace MongoDB.Driver.Linq
/// <summary>
/// An abstract base class for an Expression visitor that returns a value of type T.
/// </summary>
/// <typeparam name="T">The type of the return value.</typeparam>
public abstract class ExpressionVisitor<T>
{
// constructors
Expand Down
2 changes: 1 addition & 1 deletion GlobalAssemblyInfo.cs
Original file line number Diff line number Diff line change
Expand Up @@ -39,4 +39,4 @@
// You can specify all the values or you can default the Build and Revision Numbers
// by using the '*' as shown below:
// [assembly: AssemblyVersion("1.0.*")]
[assembly: AssemblyVersion("1.6.0.*")]
[assembly: AssemblyVersion("1.6.0.4624")]

0 comments on commit a458636

Please sign in to comment.