@@ -99,12 +99,12 @@ public SemVersion(Version version)
99
99
/// Converts the string representation of a semantic version to its <see cref="SemVersion"/> equivalent.
100
100
/// </summary>
101
101
/// <param name="version">The version string.</param>
102
- /// <param name="strict">If set to <see langword="true"/> minor and patch version are required.
102
+ /// <param name="strict">If set to <see langword="true"/> minor and patch version are required,
103
103
/// otherwise they are optional.</param>
104
104
/// <returns>The <see cref="SemVersion"/> object.</returns>
105
105
/// <exception cref="ArgumentNullException">The <paramref name="version"/> is <see langword="null"/>.</exception>
106
- /// <exception cref="ArgumentException">The version number has an invalid format.</exception>
107
- /// <exception cref="InvalidOperationException">The version number is missing Minor or Patch versions when they are required .</exception>
106
+ /// <exception cref="ArgumentException">The <paramref name="version"/> has an invalid format.</exception>
107
+ /// <exception cref="InvalidOperationException">The <paramref name=" version"/> is missing Minor or Patch versions and <paramref name="strict"/> is <see langword="true"/> .</exception>
108
108
/// <exception cref="OverflowException">The Major, Minor, or Patch versions are larger than <code>int.MaxValue</code>.</exception>
109
109
public static SemVersion Parse ( string version , bool strict = false )
110
110
{
@@ -142,7 +142,7 @@ public static SemVersion Parse(string version, bool strict = false)
142
142
/// <param name="semver">When the method returns, contains a <see cref="SemVersion"/> instance equivalent
143
143
/// to the version string passed in, if the version string was valid, or <see langword="null"/> if the
144
144
/// version string was not valid.</param>
145
- /// <param name="strict">If set to <see langword="true"/> minor and patch version are required.
145
+ /// <param name="strict">If set to <see langword="true"/> minor and patch version are required,
146
146
/// otherwise they are optional.</param>
147
147
/// <returns><see langword="false"/> when a invalid version string is passed, otherwise <see langword="true"/>.</returns>
148
148
public static bool TryParse ( string version , out SemVersion semver , bool strict = false )
@@ -186,7 +186,7 @@ public static bool TryParse(string version, out SemVersion semver, bool strict =
186
186
/// </summary>
187
187
/// <param name="versionA">The first version to compare.</param>
188
188
/// <param name="versionB">The second version to compare.</param>
189
- /// <returns><see langword="true"/> if the two values are equal; otherwise, <see langword="false"/>.</returns>
189
+ /// <returns><see langword="true"/> if the two values are equal, otherwise <see langword="false"/>.</returns>
190
190
public static bool Equals ( SemVersion versionA , SemVersion versionB )
191
191
{
192
192
if ( ReferenceEquals ( versionA , versionB ) ) return true ;
@@ -199,7 +199,7 @@ public static bool Equals(SemVersion versionA, SemVersion versionB)
199
199
/// </summary>
200
200
/// <param name="versionA">The first version to compare.</param>
201
201
/// <param name="versionB">The second version to compare.</param>
202
- /// <returns>A signed number indicating the relative values of <code> versionA</code > and <code> versionB</code >.</returns>
202
+ /// <returns>A signed number indicating the relative values of <paramref name=" versionA"/ > and <paramref name=" versionB"/ >.</returns>
203
203
public static int Compare ( SemVersion versionA , SemVersion versionB )
204
204
{
205
205
if ( ReferenceEquals ( versionA , versionB ) ) return 0 ;
@@ -218,9 +218,13 @@ public static int Compare(SemVersion versionA, SemVersion versionB)
218
218
/// <param name="build">The value to replace the build metadata or <see langword="null"/> to leave it unchanged.</param>
219
219
/// <returns>The new version object.</returns>
220
220
/// <remarks>
221
- /// The change method is intended to be called using named argument syntax.
222
- /// For example, to change the patch version, use <code>version.Change(patch: 4)</code> .
221
+ /// The change method is intended to be called using named argument syntax, passing only
222
+ /// those fields to be changed .
223
223
/// </remarks>
224
+ /// <example>
225
+ /// To change only the patch version:
226
+ /// <code>version.Change(patch: 4)</code>
227
+ /// </example>
224
228
public SemVersion Change ( int ? major = null , int ? minor = null , int ? patch = null ,
225
229
string prerelease = null , string build = null )
226
230
{
@@ -433,7 +437,7 @@ private static int CompareComponent(string a, string b, bool nonemptyIsLower = f
433
437
/// </summary>
434
438
/// <param name="obj">The <see cref="object" /> to compare with this instance.</param>
435
439
/// <returns>
436
- /// <see langword="true"/> if the specified <see cref="object" /> is equal to this instance; otherwise, <see langword="false"/>.
440
+ /// <see langword="true"/> if the specified <see cref="object" /> is equal to this instance, otherwise <see langword="false"/>.
437
441
/// </returns>
438
442
/// <exception cref="InvalidCastException">The <paramref name="obj"/> is not a <see cref="SemVersion"/>.</exception>
439
443
public override bool Equals ( object obj )
0 commit comments