Skip to content

Commit 21aae35

Browse files
committed
Fix Sandcastle warnings.
1 parent 118c355 commit 21aae35

16 files changed

+30
-30
lines changed

src/MongoDB.Bson/IO/BsonReader.cs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -145,13 +145,13 @@ public BsonType GetCurrentBsonType()
145145
/// </returns>
146146
public abstract bool IsAtEndOfFile();
147147

148-
/// <inherited/>
148+
/// <inheritdoc/>
149149
public void PopSettings()
150150
{
151151
_settings = _settingsStack.Pop();
152152
}
153153

154-
/// <inherited/>
154+
/// <inheritdoc/>
155155
public void PushSettings(Action<BsonReaderSettings> configurator)
156156
{
157157
var newSettings = _settings.Clone();

src/MongoDB.Bson/IO/IBsonReaderExtensions.cs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -91,8 +91,8 @@ public static BsonBinaryData ReadBinaryData(this IBsonReader reader, string name
9191
/// <summary>
9292
/// Reads a BSON binary data element from the reader temporarily setting the GuidRepresentation to Unspecified.
9393
/// </summary>
94-
/// <param name="reader"></param>
95-
/// <returns></returns>
94+
/// <param name="reader">The reader.</param>
95+
/// <returns>A BsonBinaryData.</returns>
9696
[Obsolete("In V3 mode use ReadBinaryData instead.")]
9797
public static BsonBinaryData ReadBinaryDataWithGuidRepresentationUnspecified(this IBsonReader reader)
9898
{

src/MongoDB.Bson/Serialization/BsonSerializerRegistry.cs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -65,7 +65,7 @@ public IBsonSerializer GetSerializer(Type type)
6565
/// <summary>
6666
/// Gets the serializer for the specified <typeparamref name="T" />.
6767
/// </summary>
68-
/// <typeparam name="T"></typeparam>
68+
/// <typeparam name="T">The value type of the serializer.</typeparam>
6969
/// <returns>
7070
/// The serializer.
7171
/// </returns>

src/MongoDB.Bson/Serialization/IBsonSerializerRegistry.cs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ public interface IBsonSerializerRegistry
3232
/// <summary>
3333
/// Gets the serializer for the specified <typeparamref name="T"/>.
3434
/// </summary>
35-
/// <typeparam name="T"></typeparam>
35+
/// <typeparam name="T">The value type of the serializer.</typeparam>
3636
/// <returns>The serializer.</returns>
3737
IBsonSerializer<T> GetSerializer<T>();
3838
}

src/MongoDB.Bson/Serialization/Serializers/EnumerableInterfaceImplementerSerializer.cs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,7 @@ public EnumerableInterfaceImplementerSerializer(IBsonSerializer itemSerializer)
4949
/// <summary>
5050
/// Initializes a new instance of the <see cref="EnumerableInterfaceImplementerSerializer{TValue}" /> class.
5151
/// </summary>
52-
/// <param name="serializerRegistry"></param>
52+
/// <param name="serializerRegistry">The serializer registry.</param>
5353
public EnumerableInterfaceImplementerSerializer(IBsonSerializerRegistry serializerRegistry)
5454
: base(serializerRegistry)
5555
{

src/MongoDB.Bson/Serialization/Serializers/QueueSerializer.cs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,7 @@ public QueueSerializer(IBsonSerializer itemSerializer)
4646
/// <summary>
4747
/// Initializes a new instance of the <see cref="QueueSerializer" /> class.
4848
/// </summary>
49-
/// <param name="serializerRegistry"></param>
49+
/// <param name="serializerRegistry">The serializer registry.</param>
5050
public QueueSerializer(IBsonSerializerRegistry serializerRegistry)
5151
: base(serializerRegistry)
5252
{

src/MongoDB.Bson/Serialization/Serializers/ReadOnlyCollectionSubclassSerializer.cs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ public ReadOnlyCollectionSubclassSerializer()
3737
/// <summary>
3838
/// Initializes a new instance of the <see cref="ReadOnlyCollectionSubclassSerializer{TValue, TItem}"/> class.
3939
/// </summary>
40-
/// <param name="itemSerializer"></param>
40+
/// <param name="itemSerializer">The item serializer.</param>
4141
public ReadOnlyCollectionSubclassSerializer(IBsonSerializer<TItem> itemSerializer)
4242
: base(itemSerializer)
4343
{

src/MongoDB.Driver.Core/Core/Authentication/SaslPrepHelper.cs

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -199,7 +199,7 @@ private static int CharCount(int codepoint)
199199
/// characters as defined by <a href="https://tools.ietf.org/html/rfc3454#appendix-C.7">RFC 3454, Appendix C.7</a>.
200200
/// </summary>
201201
/// <param name="codepoint">The Unicode character's codepoint.</param>
202-
/// <returns></returns>
202+
/// <returns>True if the codepoint is inappropriate for canonical.</returns>
203203
private static bool InappropriateForCanonical(int codepoint)
204204
{
205205
return 0x2FF0 <= codepoint && codepoint <= 0x2FFB;
@@ -210,7 +210,7 @@ private static bool InappropriateForCanonical(int codepoint)
210210
/// by <a href="https://tools.ietf.org/html/rfc3454#appendix-C.6">RFC 3454, Appendix C.6</a>.
211211
/// </summary>
212212
/// <param name="codepoint">The Unicode character's codepoint.</param>
213-
/// <returns></returns>
213+
/// <returns>True if the codepoint is inappropriate for plain text.</returns>
214214
private static bool InappropriateForPlainText(int codepoint)
215215
{
216216
return codepoint == 0xFFF9
@@ -795,7 +795,7 @@ private static bool Surrogatecodepoint(int codepoint)
795795
/// <a href="https://tools.ietf.org/html/rfc3454#appendix-C.9">RFC 3454, Appendix C.9</a>.
796796
/// </summary>
797797
/// <param name="codepoint">The Unicode character's codepoint.</param>
798-
/// <returns></returns>
798+
/// <returns>True if the codepoint is a tagging character.</returns>
799799
private static bool Tagging(int codepoint)
800800
{
801801
return codepoint == 0xE0001

src/MongoDB.Driver.Core/Core/Authentication/ScramCache.cs

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -32,9 +32,9 @@ internal class ScramCache
3232
/// <summary>
3333
/// Try to get a cached entry.
3434
/// </summary>
35-
/// <param name="key"></param>
36-
/// <param name="entry"></param>
37-
/// <returns></returns>
35+
/// <param name="key">The key.</param>
36+
/// <param name="entry">The entry.</param>
37+
/// <returns>True if the cache contained an entry for the key.</returns>
3838
public bool TryGet(ScramCacheKey key, out ScramCacheEntry entry)
3939
{
4040
if (key.Equals(_cacheKey))
@@ -52,8 +52,8 @@ public bool TryGet(ScramCacheKey key, out ScramCacheEntry entry)
5252
/// <summary>
5353
/// Add a cached entry.
5454
/// </summary>
55-
/// <param name="key"></param>
56-
/// <param name="entry"></param>
55+
/// <param name="key">The key.</param>
56+
/// <param name="entry">The entry.</param>
5757
public void Add(ScramCacheKey key, ScramCacheEntry entry)
5858
{
5959
_cacheKey = key;

src/MongoDB.Driver.Core/Core/Authentication/Sspi/NativeMethods.cs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -54,7 +54,7 @@ internal static class NativeMethods
5454
/// </summary>
5555
/// <param name="errorCode">The error code.</param>
5656
/// <param name="defaultMessage">The default message.</param>
57-
/// <returns></returns>
57+
/// <returns>A Win32Exception.</returns>
5858
public static Win32Exception CreateException(long errorCode, string defaultMessage)
5959
{
6060
string message = defaultMessage;

0 commit comments

Comments
 (0)