Thread: NullableTypes/src/Types NullableGuid.cs,1.8,1.9
Status: Inactive
Brought to you by:
lukadotnet
From: Damien G. <dam...@us...> - 2005-10-30 15:38:29
|
Update of /cvsroot/nullabletypes/NullableTypes/src/Types In directory sc8-pr-cvs1.sourceforge.net:/tmp/cvs-serv16997/src/Types Modified Files: NullableGuid.cs Log Message: Correct some XML documentation comments as per issue #1342422. Index: NullableGuid.cs =================================================================== RCS file: /cvsroot/nullabletypes/NullableTypes/src/Types/NullableGuid.cs,v retrieving revision 1.8 retrieving revision 1.9 diff -C2 -d -r1.8 -r1.9 *** NullableGuid.cs 24 Oct 2005 21:28:57 -0000 1.8 --- NullableGuid.cs 30 Oct 2005 15:38:15 -0000 1.9 *************** *** 14,17 **** --- 14,18 ---- // 26-Sep-2005 DamienG Bugfix Change ToNullableString to cast via NullableString. // 11-Oct-2005 DamienG Upgrade Clean up and add missing XML documentation. + // 30-Oct-2005 Damieng Bugfix Correct some XML documentation comments as per issue #1342422. // *************** *** 133,139 **** /// </summary> /// <param name="o">An object to compare, or <see langword="null"/>.</param> ! /// <returns></returns> /// <exception cref="System.ArgumentException"><paramref name="o"/> is not a <see cref="NullableGuid"/>.</exception> ! public int CompareTo(object o) { if (o == null)return 1; if (!(o is NullableGuid)) --- 134,165 ---- /// </summary> /// <param name="o">An object to compare, or <see langword="null"/>.</param> ! /// <returns> ! /// A signed number indicating the relative values of the instance and value. ! /// <list type="table"> ! /// <listheader> ! /// <term>Value</term> ! /// <description>Description</description> ! /// </listheader> ! /// <item> ! /// <term>A negative integer</term> ! /// <description>The value of this instance is less than the value of <paramref="value" />.</description> ! /// </item> ! /// <item> ! /// <term>Zero</term> ! /// <description>The value of this instance is equal to the value of <paramref="value" />.</description> ! /// </item> ! /// <item> ! /// <term>A positive integer</term> ! /// <description> ! /// The value of this instance is greater than the value of <paramref name="value"/> ! /// <para>-or-</para> ! /// <paramref name="value"/> is a null reference (Nothing). ! /// </description> ! /// </item> ! /// </list> ! /// </returns> /// <exception cref="System.ArgumentException"><paramref name="o"/> is not a <see cref="NullableGuid"/>.</exception> ! public int CompareTo(object o) ! { if (o == null)return 1; if (!(o is NullableGuid)) *************** *** 166,172 **** --- 192,200 ---- /// <param name="g1">A <see cref="NullableGuid"/> object.</param> /// <param name="g2">A <see cref="NullableGuid"/> object.</param> + /// <returns> /// <see cref="NullableBoolean.Null"/> if either <paramref name="g1"/> or <paramref name="g2"/> are <see cref="Null"/>, /// <see cref="NullableBoolean.True"/> if the values of <paramref name="g1"/> and <paramref name="g2"/> are equal, /// <see cref="NullableBoolean.False"/> if the values of <paramref name="g1"/> and <paramref name="g2"/> are not equal. + /// </returns> public static NullableBoolean operator == (NullableGuid g1, NullableGuid g2) { if (g1.IsNull || g2.IsNull) return NullableBoolean.Null; *************** *** 179,185 **** --- 207,215 ---- /// <param name="g1">A <see cref="NullableGuid"/> object.</param> /// <param name="g2">A <see cref="NullableGuid"/> object.</param> + /// <returns> /// <see cref="NullableBoolean.Null"/> if either <paramref name="g1"/> or <paramref name="g2"/> are <see cref="Null"/>, /// <see cref="NullableBoolean.True"/> if the values of <paramref name="g1"/> and <paramref name="g2"/> are not equal, /// <see cref="NullableBoolean.False"/> if the values of <paramref name="g1"/> and <paramref name="g2"/> are equal. + /// </returns> public static NullableBoolean operator != (NullableGuid g1, NullableGuid g2) { if (g1.IsNull || g2.IsNull) return NullableBoolean.Null; *************** *** 192,199 **** /// <param name="g1">A <see cref="NullableGuid"/>.</param> /// <param name="g2">A <see cref="NullableGuid"/>.</param> /// <see cref="NullableBoolean.Null"/> if either <paramref name="g1"/> or <paramref name="g2"/> are <see cref="Null"/>, /// <see cref="NullableBoolean.True"/> if the values of <paramref name="g1"/> and <paramref name="g2"/> are equal, /// <see cref="NullableBoolean.False"/> if the values of <paramref name="g1"/> and <paramref name="g2"/> are not equal. ! public static NullableBoolean Equals(NullableGuid g1, NullableGuid g2) { return (g1 == g2); } --- 222,231 ---- /// <param name="g1">A <see cref="NullableGuid"/>.</param> /// <param name="g2">A <see cref="NullableGuid"/>.</param> + /// <returns> /// <see cref="NullableBoolean.Null"/> if either <paramref name="g1"/> or <paramref name="g2"/> are <see cref="Null"/>, /// <see cref="NullableBoolean.True"/> if the values of <paramref name="g1"/> and <paramref name="g2"/> are equal, /// <see cref="NullableBoolean.False"/> if the values of <paramref name="g1"/> and <paramref name="g2"/> are not equal. ! /// </returns> ! public static NullableBoolean Equals(NullableGuid g1, NullableGuid g2) { return (g1 == g2); } *************** *** 292,297 **** /// Contains the <see cref="System.Guid"/> this instance represents if it is not <see cref="Null"/>. /// </summary> /// <exception cref="NullableNullValueException">instance is <see cref="Null"/>.</exception> ! public sys.Guid Value { get { if (IsNull) --- 324,334 ---- /// Contains the <see cref="System.Guid"/> this instance represents if it is not <see cref="Null"/>. /// </summary> + /// <value> + /// A GUID is a 128-bit integer (16 bytes) that can be used across all computers and networks wherever a unique identifier is required. + /// Such an identifier has a very low probability of being duplicated. + /// </value> /// <exception cref="NullableNullValueException">instance is <see cref="Null"/>.</exception> ! public sys.Guid Value ! { get { if (IsNull) |