Skip to content

Commit 508bfdb

Browse files
committed
Fix trivial warnings.
1 parent e584f0b commit 508bfdb

File tree

5 files changed

+14
-14
lines changed

5 files changed

+14
-14
lines changed

src/MsgPack/BufferedStream.cs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -44,14 +44,14 @@ namespace System.IO
4444
/// greater than the internal buffer size, then this class may not even allocate the internal buffer.
4545
/// See a large comment in Write for the details of the write buffer heuristic.
4646
///
47-
/// This class buffers reads & writes in a shared buffer.
47+
/// This class buffers reads & writes in a shared buffer.
4848
/// (If you maintained two buffers separately, one operation would always trash the other buffer
4949
/// anyways, so we might as well use one buffer.)
5050
/// The assumption here is you will almost always be doing a series of reads or writes, but rarely
5151
/// alternate between the two of them on the same stream.
5252
///
5353
/// Class Invariants:
54-
/// The class has one buffer, shared for reading & writing.
54+
/// The class has one buffer, shared for reading & writing.
5555
/// It can only be used for one or the other at any point in time - not both.
5656
/// The following should be true:
5757
/// <![CDATA[

src/MsgPack/PackerUnpackerStreamOptions.cs

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
#region -- License Terms --
1+
#region -- License Terms --
22
//
33
// MessagePack for CLI
44
//
@@ -82,18 +82,18 @@ private static bool ShouldWrapStream( Stream stream )
8282
/// as long as it has buffered value.
8383
/// </para>
8484
/// <para>
85-
/// Current built-in <see cref="Unpacker"/> implementation uses <see cref="BufferedStream"/> for buffering,
85+
/// Current built-in <see cref="Unpacker"/> implementation uses <c>BufferedStream</c> for buffering,
8686
/// and avoid buffering for following in-memory or stream with buffering feature:
8787
/// <list type="bullet">
88-
/// <item><see cref="System.IO.BufferedStream" /> itself.</item>
89-
/// <item><see cref="System.IO.MemoryStream" />.</item>
90-
/// <item><see cref="System.IO.UnmanagedMemoryStream" />.</item>
91-
/// <item><see cref="System.IO.FileStream" /> which has own internal buffer.</item>
88+
/// <item><c>System.IO.BufferedStream</c> itself.</item>
89+
/// <item><c>System.IO.MemoryStream</c>.</item>
90+
/// <item><c>System.IO.UnmanagedMemoryStream</c>.</item>
91+
/// <item><c>System.IO.FileStream</c> which has own internal buffer.</item>
9292
/// </list>
9393
/// </para>
9494
/// <para>
95-
/// Logically, it is preferred that you should wrap with <see cref="System.IO.BufferedStream"/> yourself for underlying stream
96-
/// for wrapper stream such as <seealso cref="System.IO.Compression.DeflateStream"/>, <see cref="System.Security.Cryptography.CryptoStream"/>, etc.
95+
/// Logically, it is preferred that you should wrap with <c>System.IO.BufferedStream</c> yourself for underlying stream
96+
/// for wrapper stream such as <c>System.IO.Compression.DeflateStream</c>, <c>System.Security.Cryptography.CryptoStream</c>, etc.
9797
/// </para>
9898
/// </remarks>
9999
/// <seealso cref="BufferSize"/>

src/MsgPack/Serialization/MessagePackSerializer`1.cs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -527,7 +527,7 @@ protected internal virtual Task PackToAsyncCore( Packer packer, T objectTree, Ca
527527
/// The implementation of this class returns <c>null</c> for nullable types (that is, all reference types and <see cref="Nullable{T}"/>); otherwise, throws <see cref="System.Runtime.Serialization.SerializationException"/>.
528528
/// </para>
529529
/// <para>
530-
/// Custom serializers can override this method to provide custom nil representation. For example, built-in <see cref="DBNull"/> serializer overrides this method to return <see cref="DBNull.Value"/> instead of <c>null</c>.
530+
/// Custom serializers can override this method to provide custom nil representation. For example, built-in <c>DBNull</c> serializer overrides this method to return <c>DBNull.Value</c> instead of <c>null</c>.
531531
/// </para>
532532
/// </remarks>
533533
protected internal virtual T UnpackNil()

src/MsgPack/Serialization/PackHelpers.cs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
#region -- License Terms --
1+
#region -- License Terms --
22
//
33
// MessagePack for CLI
44
//
@@ -312,7 +312,7 @@ IDictionary<string, Action<Packer, TObject>> operations
312312
/// <see cref="PackToMapParameters{T}.Packer"/> of <paramref name="parameter"/> is <c>null</c>.
313313
/// </exception>
314314
/// <exception cref="ArgumentException">
315-
/// <see cref="PackToMapAsyncParameters{T}.Operations"/> of <paramref name="parameter"/> is <c>null</c>.
315+
/// <c>PackToMapAsyncParameters{T}.Operations</c> of <paramref name="parameter"/> is <c>null</c>.
316316
/// </exception>
317317
#if !UNITY || MSGPACK_UNITY_FULL
318318
[EditorBrowsable( EditorBrowsableState.Never )]

src/MsgPack/Serialization/SerializationCompatibilityOptions.cs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -106,7 +106,7 @@ public PackerCompatibilityOptions PackerCompatibilityOptions
106106
/// </value>
107107
/// <remarks>
108108
/// Historically, MessagePack for CLI ignored packability interfaces (<see cref="IPackable"/>, <see cref="IUnpackable"/>,
109-
/// <see cref="IAsyncPackable"/> and <see cref="IAsyncUnpackable"/>) for collection which implements <see cref="IEquatable{T}"/> (except <see cref="String"/> and its kinds).
109+
/// <c>IAsyncPackable"</c> and <c>IAsyncUnpackable</c>) for collection which implements <see cref="IEquatable{T}"/> (except <see cref="String"/> and its kinds).
110110
/// As of 0.7, the generator respects such interfaces even if the target type is collection.
111111
/// Although this behavior is desirable and correct, setting this property <c>true</c> turn out the new behavior for backward compatibility.
112112
/// </remarks>

0 commit comments

Comments
 (0)