Skip to content

Commit 696f028

Browse files
lextmlextm
committed
Improve XML documentation for methods and parameters across multiple files
1 parent 2a75ece commit 696f028

20 files changed

+50
-43
lines changed

‎SharpSnmpLib/Counter64.cs‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -128,7 +128,7 @@ public void AppendBytesTo(Stream stream)
128128
/// <summary>
129129
/// Returns a <see cref="UInt64"/> that represents a <see cref="Counter64"/>.
130130
/// </summary>
131-
/// <returns></returns>
131+
/// <returns>A <see cref="UInt64"/> that represents a <see cref="Counter64"/>.</returns>
132132
[CLSCompliant(false)]
133133
public ulong ToUInt64()
134134
{
@@ -138,7 +138,7 @@ public ulong ToUInt64()
138138
/// <summary>
139139
/// Returns a <see cref="String"/> that represents this <see cref="Counter64"/>.
140140
/// </summary>
141-
/// <returns></returns>
141+
/// <returns>A <see cref="String"/> that represents this <see cref="Counter64"/>.</returns>
142142
public override string ToString()
143143
{
144144
return ToUInt64().ToString(CultureInfo.InvariantCulture);

‎SharpSnmpLib/DataFactory.cs‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@ public static class DataFactory
4141
/// Creates an <see cref="ISnmpData"/> instance from buffer.
4242
/// </summary>
4343
/// <param name="buffer">Buffer</param>
44-
/// <returns></returns>
44+
/// <returns>An <see cref="ISnmpData"/> instance created from the specified buffer.</returns>
4545
public static ISnmpData CreateSnmpData(byte[] buffer)
4646
{
4747
if (buffer == null)
@@ -57,7 +57,7 @@ public static ISnmpData CreateSnmpData(byte[] buffer)
5757
/// </summary>
5858
/// <param name="stream">Stream.</param>
5959
/// <param name="type">Type code.</param>
60-
/// <returns></returns>
60+
/// <returns>An <see cref="ISnmpData"/> instance created from the specified stream and type code.</returns>
6161
public static ISnmpData CreateSnmpData(int type, Stream stream)
6262
{
6363
if (stream == null)
@@ -115,7 +115,7 @@ public static ISnmpData CreateSnmpData(int type, Stream stream)
115115
/// <param name="buffer">Buffer</param>
116116
/// <param name="index">Index</param>
117117
/// <param name="count">Count</param>
118-
/// <returns></returns>
118+
/// <returns>An <see cref="ISnmpData"/> instance created from the specified buffer, index, and count.</returns>
119119
public static ISnmpData CreateSnmpData(byte[] buffer, int index, int count)
120120
{
121121
if (buffer == null)
@@ -131,7 +131,7 @@ public static ISnmpData CreateSnmpData(byte[] buffer, int index, int count)
131131
/// Creates an <see cref="ISnmpData"/> instance from stream.
132132
/// </summary>
133133
/// <param name="stream">Stream</param>
134-
/// <returns></returns>
134+
/// <returns>An <see cref="ISnmpData"/> instance created from the specified stream.</returns>
135135
public static ISnmpData CreateSnmpData(Stream stream)
136136
{
137137
if (stream == null)

‎SharpSnmpLib/EndOfMibView.cs‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -143,7 +143,7 @@ public void AppendBytesTo(Stream stream)
143143
/// <summary>
144144
/// Returns a <see cref="String"/> that represents this <see cref="Null"/>.
145145
/// </summary>
146-
/// <returns></returns>
146+
/// <returns>A <see cref="String"/> that represents this <see cref="Null"/>.</returns>
147147
public override string ToString()
148148
{
149149
return "EndOfMibView";

‎SharpSnmpLib/Gauge32.cs‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -102,7 +102,7 @@ public void AppendBytesTo(Stream stream)
102102
/// <summary>
103103
/// Returns a <see cref="UInt32"/> that represents a <see cref="Gauge32"/>.
104104
/// </summary>
105-
/// <returns></returns>
105+
/// <returns>A <see cref="UInt32"/> that represents a <see cref="Gauge32"/>.</returns>
106106
[CLSCompliant(false)]
107107
public uint ToUInt32()
108108
{
@@ -112,7 +112,7 @@ public uint ToUInt32()
112112
/// <summary>
113113
/// Returns a <see cref="String"/> that represents this <see cref="Gauge32"/>.
114114
/// </summary>
115-
/// <returns></returns>
115+
/// <returns>A <see cref="String"/> that represents this <see cref="Gauge32"/>.</returns>
116116
public override string ToString()
117117
{
118118
return ToUInt32().ToString(CultureInfo.InvariantCulture);

‎SharpSnmpLib/GetBulkRequestPdu.cs‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -131,7 +131,7 @@ public void AppendBytesTo(Stream stream)
131131
/// <summary>
132132
/// Returns a <see cref="string"/> that represents this <see cref="GetBulkRequestPdu"/>.
133133
/// </summary>
134-
/// <returns></returns>
134+
/// <returns>A <see cref="string"/> that represents this <see cref="GetBulkRequestPdu"/>.</returns>
135135
public override string ToString()
136136
{
137137
return string.Format(

‎SharpSnmpLib/GetNextRequestPdu.cs‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -128,7 +128,7 @@ public void AppendBytesTo(Stream stream)
128128
/// <summary>
129129
/// Returns a <see cref="string"/> that represents this <see cref="GetNextRequestPdu"/>.
130130
/// </summary>
131-
/// <returns></returns>
131+
/// <returns>A <see cref="string"/> that represents this <see cref="GetNextRequestPdu"/>.</returns>
132132
public override string ToString()
133133
{
134134
return string.Format(

‎SharpSnmpLib/GetRequestPdu.cs‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -121,7 +121,7 @@ public void AppendBytesTo(Stream stream)
121121
/// <summary>
122122
/// Returns a <see cref="string"/> that represents this <see cref="GetRequestPdu"/>.
123123
/// </summary>
124-
/// <returns></returns>
124+
/// <returns>A <see cref="string"/> that represents this <see cref="GetRequestPdu"/>.</returns>
125125
public override string ToString()
126126
{
127127
return string.Format(

‎SharpSnmpLib/Header.cs‎

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -107,7 +107,9 @@ public Header(Integer32? messageId, Integer32 maxMessageSize, Levels securityLev
107107
/// <summary>
108108
/// Converts to <see cref="Sequence"/> object.
109109
/// </summary>
110-
/// <returns></returns>
110+
/// <returns>
111+
/// The <see cref="Sequence"/> object.
112+
/// </returns>
111113
public Sequence ToSequence()
112114
{
113115
return _container ??= new Sequence(null, _messageId, _maxSize, _messageId == null ? null : _flags, _securityModel);
@@ -117,7 +119,9 @@ public Sequence ToSequence()
117119
/// Gets the data.
118120
/// </summary>
119121
/// <param name="version">The version.</param>
120-
/// <returns></returns>
122+
/// <returns>
123+
/// The <see cref="ISnmpData"/> object.
124+
/// </returns>
121125
public ISnmpData? GetData(VersionCode version)
122126
{
123127
return version == VersionCode.V3 ? ToSequence() : null;

‎SharpSnmpLib/IP.cs‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -202,7 +202,7 @@ public byte[] GetRaw()
202202
/// <summary>
203203
/// Returns a <see cref="String"/> that represents this <see cref="IP"/>.
204204
/// </summary>
205-
/// <returns></returns>
205+
/// <returns>A <see cref="String"/> that represents this <see cref="IP"/>.</returns>
206206
public override string ToString()
207207
{
208208
return $"{_ip[0]}.{_ip[1]}.{_ip[2]}.{_ip[3]}";

‎SharpSnmpLib/ISegment.cs‎

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -28,13 +28,15 @@ public interface ISegment
2828
/// Gets the data.
2929
/// </summary>
3030
/// <param name="version">The version.</param>
31-
/// <returns></returns>
31+
/// <returns>
32+
/// The data, or <c>null</c> if not available.</returns>
3233
ISnmpData? GetData(VersionCode version);
3334

3435
/// <summary>
3536
/// Converts to <see cref="Sequence"/> object.
3637
/// </summary>
37-
/// <returns></returns>
38+
/// <returns>
39+
/// A <see cref="Sequence"/> object representing this segment.</returns>
3840
Sequence ToSequence();
3941
}
4042
}

0 commit comments

Comments
 (0)