Fix: "<inheritdocs/>" -> "<inheritdoc/>"

lumip · lumip · commit fa9246b3231c · 2021-03-13T16:10:44.000+02:00
diff --git a/CompactCryptoGroupAlgebra.OpenSsl/BigNumber.cs b/CompactCryptoGroupAlgebra.OpenSsl/BigNumber.cs
@@ -141,7 +141,7 @@ public BigInteger ToBigInteger()
             return integer;
         }
 
-        /// <inheritdocs />
+        /// <inheritdoc />
         public override bool Equals(object? obj)
         {        
             var other = obj as BigNumber;
@@ -153,13 +153,13 @@ public override bool Equals(object? obj)
             return (BigNumberHandle.Compare(this.Handle, other.Handle) == 0);
         }
         
-        /// <inheritdocs />
+        /// <inheritdoc />
         public override int GetHashCode()
         {
             return ToBigInteger().GetHashCode();
         }
 
-        /// <inheritdocs />
+        /// <inheritdoc />
         public override string ToString()
         {
             return ToBigInteger().ToString();
@@ -268,7 +268,7 @@ public BigNumber ModReciprocal(BigNumber modulo)
             }
         }
 
-        /// <inheritdocs />
+        /// <inheritdoc />
         public void Dispose()
         {
             Dispose(disposing: true);
diff --git a/CompactCryptoGroupAlgebra.OpenSsl/EllipticCurves/ECPoint.cs b/CompactCryptoGroupAlgebra.OpenSsl/EllipticCurves/ECPoint.cs
@@ -85,7 +85,7 @@ public bool IsAtInfinity
             }
         }
 
-        /// <inheritdocs />
+        /// <inheritdoc />
         public override bool Equals(object? obj)
         {
             ECPoint? other = obj as ECPoint;
@@ -97,7 +97,7 @@ public override bool Equals(object? obj)
             }
         }
         
-        /// <inheritdocs />
+        /// <inheritdoc />
         public override int GetHashCode()
         {
             return new BigInteger(ToBytes()).GetHashCode();
@@ -145,7 +145,7 @@ private void Dispose(bool disposing)
 
         }
 
-        /// <inheritdocs />
+        /// <inheritdoc />
         public void Dispose()
         {
             Dispose(disposing: true);
diff --git a/CompactCryptoGroupAlgebra.OpenSsl/EllipticCurves/EllipticCurveAlgebra.cs b/CompactCryptoGroupAlgebra.OpenSsl/EllipticCurves/EllipticCurveAlgebra.cs
@@ -46,7 +46,7 @@ public EllipticCurveAlgebra(EllipticCurveID curveId)
 
         private BigPrime? _order;
 
-        /// <inheritdocs />
+        /// <inheritdoc />
         public BigPrime Order
         {
             get
@@ -74,7 +74,7 @@ public BigPrime Order
             }
         }
 
-        /// <inheritdocs />
+        /// <inheritdoc />
         public ECPoint Generator
         {
             get
@@ -86,7 +86,7 @@ public ECPoint Generator
 
         private ECPoint? _neutralElement;
 
-        /// <inheritdocs />
+        /// <inheritdoc />
         public ECPoint NeutralElement
         {
             get
@@ -108,7 +108,7 @@ public ECPoint NeutralElement
 
         private BigInteger? _cofactor;
 
-        /// <inheritdocs />
+        /// <inheritdoc />
         public BigInteger Cofactor
         {
             get
@@ -132,7 +132,7 @@ public BigInteger Cofactor
             }
         }
 
-        /// <inheritdocs />
+        /// <inheritdoc />
         public int ElementBitLength 
         {
             get
@@ -141,7 +141,7 @@ public int ElementBitLength
             }
         }
 
-        /// <inheritdocs />
+        /// <inheritdoc />
         public int OrderBitLength
         {
             get
@@ -150,7 +150,7 @@ public int OrderBitLength
             }
         }
 
-        /// <inheritdocs />
+        /// <inheritdoc />
         public ECPoint Add(ECPoint left, ECPoint right)
         {
             using (var ctx = BigNumberContextHandle.Create())
@@ -161,13 +161,13 @@ public ECPoint Add(ECPoint left, ECPoint right)
             }
         }
 
-        /// <inheritdocs />
+        /// <inheritdoc />
         public ECPoint FromBytes(byte[] buffer)
         {
             return ECPoint.CreateFromBytes(Handle, buffer);
         }
 
-        /// <inheritdocs />
+        /// <inheritdoc />
         public ECPoint GenerateElement(SecureBigNumber index)
         {
             using (var ctx = BigNumberContextHandle.CreateSecure())
@@ -178,7 +178,7 @@ public ECPoint GenerateElement(SecureBigNumber index)
             }
         }
 
-        /// <inheritdocs />
+        /// <inheritdoc />
         public bool IsPotentialElement(ECPoint element)
         {
             using (var ctx = BigNumberContextHandle.Create())
@@ -187,7 +187,7 @@ public bool IsPotentialElement(ECPoint element)
             }
         }
 
-        /// <inheritdocs />
+        /// <inheritdoc />
         public bool IsSafeElement(ECPoint element)
         {
             if (!IsPotentialElement(element)) return false;
@@ -203,7 +203,7 @@ public bool IsSafeElement(ECPoint element)
             return true;
         }
 
-        /// <inheritdocs />
+        /// <inheritdoc />
         public ECPoint MultiplyScalar(ECPoint e, SecureBigNumber k)
         {
             using (var ctx = BigNumberContextHandle.CreateSecure())
@@ -214,7 +214,7 @@ public ECPoint MultiplyScalar(ECPoint e, SecureBigNumber k)
             }
         }
 
-        /// <inheritdocs />
+        /// <inheritdoc />
         public ECPoint Negate(ECPoint element)
         {
             using (var ctx = BigNumberContextHandle.Create())
@@ -225,13 +225,13 @@ public ECPoint Negate(ECPoint element)
             }
         }
 
-        /// <inheritdocs />
+        /// <inheritdoc />
         public byte[] ToBytes(ECPoint element)
         {
             return element.ToBytes(GroupPointEncoding);
         }
 
-        /// <inheritdocs />
+        /// <inheritdoc />
         public (SecureBigNumber, ECPoint) GenerateRandomElement(RandomNumberGenerator randomNumberGenerator)
         {
             using (var keyHandle = ECKeyHandle.Create())
@@ -261,7 +261,7 @@ public byte[] ToBytes(ECPoint element)
             }
         }
 
-        /// <inheritdocs />
+        /// <inheritdoc />
         public void Dispose()
         {
             Dispose(true);
@@ -276,7 +276,7 @@ private void Dispose(bool disposing)
             }
         }
 
-        /// <inheritdocs />
+        /// <inheritdoc />
         public override bool Equals(object? obj)
         {
             EllipticCurveAlgebra? other = obj as EllipticCurveAlgebra;
@@ -288,7 +288,7 @@ public override bool Equals(object? obj)
             }
         }
         
-        /// <inheritdocs />
+        /// <inheritdoc />
         public override int GetHashCode()
         {
             int hashCode = 55837;
diff --git a/CompactCryptoGroupAlgebra.OpenSsl/Internal/Native/BigNumberContextHandle.cs b/CompactCryptoGroupAlgebra.OpenSsl/Internal/Native/BigNumberContextHandle.cs
@@ -85,7 +85,7 @@ internal BigNumberContextHandle(IntPtr handle, bool ownsHandle) : base(ownsHandl
             }
         }
 
-        /// <inheritdocs />
+        /// <inheritdoc />
         protected override bool ReleaseHandle()
         {
             Debug.Assert(!IsInvalid);
diff --git a/CompactCryptoGroupAlgebra.OpenSsl/Internal/Native/BigNumberHandle.cs b/CompactCryptoGroupAlgebra.OpenSsl/Internal/Native/BigNumberHandle.cs
@@ -236,7 +236,7 @@ private BigNumberHandle(IntPtr handle, bool ownsHandle) : base(ownsHandle)
             }
         }
 
-        /// <inheritdocs />
+        /// <inheritdoc />
         protected override bool ReleaseHandle()
         {
             Debug.Assert(!IsInvalid);
diff --git a/CompactCryptoGroupAlgebra.OpenSsl/Internal/Native/BigNumberMontgomeryContextHandle.cs b/CompactCryptoGroupAlgebra.OpenSsl/Internal/Native/BigNumberMontgomeryContextHandle.cs
@@ -61,7 +61,7 @@ private BigNumberMontgomeryContextHandle(IntPtr handle, bool ownsHandle) : base(
             }
         }
 
-        /// <inheritdocs />
+        /// <inheritdoc />
         protected override bool ReleaseHandle()
         {
             Debug.Assert(!IsInvalid);
diff --git a/CompactCryptoGroupAlgebra.OpenSsl/Internal/Native/ECGroupHandle.cs b/CompactCryptoGroupAlgebra.OpenSsl/Internal/Native/ECGroupHandle.cs
@@ -158,7 +158,7 @@ internal ECGroupHandle(IntPtr handle, bool ownsHandle) : base(ownsHandle)
             }
         }
 
-        /// <inheritdocs />
+        /// <inheritdoc />
         protected override bool ReleaseHandle()
         {
             Debug.Assert(!IsInvalid);
diff --git a/CompactCryptoGroupAlgebra.OpenSsl/Internal/Native/ECKeyHandle.cs b/CompactCryptoGroupAlgebra.OpenSsl/Internal/Native/ECKeyHandle.cs
@@ -115,7 +115,7 @@ internal ECKeyHandle(IntPtr handle, bool ownsHandle) : base(ownsHandle)
             }
         }
 
-        /// <inheritdocs />
+        /// <inheritdoc />
         protected override bool ReleaseHandle()
         {
             Debug.Assert(!IsInvalid);
diff --git a/CompactCryptoGroupAlgebra.OpenSsl/Internal/Native/ECPointHandle.cs b/CompactCryptoGroupAlgebra.OpenSsl/Internal/Native/ECPointHandle.cs
@@ -206,7 +206,7 @@ internal ECPointHandle(IntPtr handle, bool ownsHandle) : base(ownsHandle)
             }
         }
 
-        /// <inheritdocs />
+        /// <inheritdoc />
         protected override bool ReleaseHandle()
         {
             EC_POINT_clear_free(this.handle);
diff --git a/CompactCryptoGroupAlgebra.OpenSsl/Internal/Native/NativeHandle.cs b/CompactCryptoGroupAlgebra.OpenSsl/Internal/Native/NativeHandle.cs
@@ -21,7 +21,7 @@ protected NativeHandle()
         }
 #endif // FEATURE_CORECLR
 
-        /// <inheritdocs />
+        /// <inheritdoc />
         public override bool IsInvalid
         {
             get
diff --git a/CompactCryptoGroupAlgebra.OpenSsl/Multiplicative/MultiplicativeGroupAlgebra.cs b/CompactCryptoGroupAlgebra.OpenSsl/Multiplicative/MultiplicativeGroupAlgebra.cs
diff --git a/CompactCryptoGroupAlgebra.OpenSsl/SecureBigNumber.cs b/CompactCryptoGroupAlgebra.OpenSsl/SecureBigNumber.cs
diff --git a/CompactCryptoGroupAlgebra/EllipticCurves/CurveGroupAlgebra.cs b/CompactCryptoGroupAlgebra/EllipticCurves/CurveGroupAlgebra.cs

Original file line number	Diff line number	Diff line change
`@@ -141,7 +141,7 @@ public BigInteger ToBigInteger()`
`141`	`141`	`return integer;`
`142`	`142`	`}`
`143`	`143`
`144`		`- /// <inheritdocs />`
	`144`	`+ /// <inheritdoc />`
`145`	`145`	`public override bool Equals(object? obj)`
`146`	`146`	`{`
`147`	`147`	`var other = obj as BigNumber;`
`@@ -153,13 +153,13 @@ public override bool Equals(object? obj)`
`153`	`153`	`return (BigNumberHandle.Compare(this.Handle, other.Handle) == 0);`
`154`	`154`	`}`
`155`	`155`
`156`		`- /// <inheritdocs />`
	`156`	`+ /// <inheritdoc />`
`157`	`157`	`public override int GetHashCode()`
`158`	`158`	`{`
`159`	`159`	`return ToBigInteger().GetHashCode();`
`160`	`160`	`}`
`161`	`161`
`162`		`- /// <inheritdocs />`
	`162`	`+ /// <inheritdoc />`
`163`	`163`	`public override string ToString()`
`164`	`164`	`{`
`165`	`165`	`return ToBigInteger().ToString();`
`@@ -268,7 +268,7 @@ public BigNumber ModReciprocal(BigNumber modulo)`
`268`	`268`	`}`
`269`	`269`	`}`
`270`	`270`
`271`		`- /// <inheritdocs />`
	`271`	`+ /// <inheritdoc />`
`272`	`272`	`public void Dispose()`
`273`	`273`	`{`
`274`	`274`	`Dispose(disposing: true);`
Original file line number	Diff line number	Diff line change
`@@ -85,7 +85,7 @@ public bool IsAtInfinity`
`85`	`85`	`}`
`86`	`86`	`}`
`87`	`87`
`88`		`- /// <inheritdocs />`
	`88`	`+ /// <inheritdoc />`
`89`	`89`	`public override bool Equals(object? obj)`
`90`	`90`	`{`
`91`	`91`	`ECPoint? other = obj as ECPoint;`
`@@ -97,7 +97,7 @@ public override bool Equals(object? obj)`
`97`	`97`	`}`
`98`	`98`	`}`
`99`	`99`
`100`		`- /// <inheritdocs />`
	`100`	`+ /// <inheritdoc />`
`101`	`101`	`public override int GetHashCode()`
`102`	`102`	`{`
`103`	`103`	`return new BigInteger(ToBytes()).GetHashCode();`
`@@ -145,7 +145,7 @@ private void Dispose(bool disposing)`
`145`	`145`
`146`	`146`	`}`
`147`	`147`
`148`		`- /// <inheritdocs />`
	`148`	`+ /// <inheritdoc />`
`149`	`149`	`public void Dispose()`
`150`	`150`	`{`
`151`	`151`	`Dispose(disposing: true);`
Original file line number	Diff line number	Diff line change
`@@ -46,7 +46,7 @@ public EllipticCurveAlgebra(EllipticCurveID curveId)`
`46`	`46`
`47`	`47`	`private BigPrime? _order;`
`48`	`48`
`49`		`- /// <inheritdocs />`
	`49`	`+ /// <inheritdoc />`
`50`	`50`	`public BigPrime Order`
`51`	`51`	`{`
`52`	`52`	`get`
`@@ -74,7 +74,7 @@ public BigPrime Order`
`74`	`74`	`}`
`75`	`75`	`}`
`76`	`76`
`77`		`- /// <inheritdocs />`
	`77`	`+ /// <inheritdoc />`
`78`	`78`	`public ECPoint Generator`
`79`	`79`	`{`
`80`	`80`	`get`
`@@ -86,7 +86,7 @@ public ECPoint Generator`
`86`	`86`
`87`	`87`	`private ECPoint? _neutralElement;`
`88`	`88`
`89`		`- /// <inheritdocs />`
	`89`	`+ /// <inheritdoc />`
`90`	`90`	`public ECPoint NeutralElement`
`91`	`91`	`{`
`92`	`92`	`get`
`@@ -108,7 +108,7 @@ public ECPoint NeutralElement`
`108`	`108`
`109`	`109`	`private BigInteger? _cofactor;`
`110`	`110`
`111`		`- /// <inheritdocs />`
	`111`	`+ /// <inheritdoc />`
`112`	`112`	`public BigInteger Cofactor`
`113`	`113`	`{`
`114`	`114`	`get`
`@@ -132,7 +132,7 @@ public BigInteger Cofactor`
`132`	`132`	`}`
`133`	`133`	`}`
`134`	`134`
`135`		`- /// <inheritdocs />`
	`135`	`+ /// <inheritdoc />`
`136`	`136`	`public int ElementBitLength`
`137`	`137`	`{`
`138`	`138`	`get`
`@@ -141,7 +141,7 @@ public int ElementBitLength`
`141`	`141`	`}`
`142`	`142`	`}`
`143`	`143`
`144`		`- /// <inheritdocs />`
	`144`	`+ /// <inheritdoc />`
`145`	`145`	`public int OrderBitLength`
`146`	`146`	`{`
`147`	`147`	`get`
`@@ -150,7 +150,7 @@ public int OrderBitLength`
`150`	`150`	`}`
`151`	`151`	`}`
`152`	`152`
`153`		`- /// <inheritdocs />`
	`153`	`+ /// <inheritdoc />`
`154`	`154`	`public ECPoint Add(ECPoint left, ECPoint right)`
`155`	`155`	`{`
`156`	`156`	`using (var ctx = BigNumberContextHandle.Create())`
`@@ -161,13 +161,13 @@ public ECPoint Add(ECPoint left, ECPoint right)`
`161`	`161`	`}`
`162`	`162`	`}`
`163`	`163`
`164`		`- /// <inheritdocs />`
	`164`	`+ /// <inheritdoc />`
`165`	`165`	`public ECPoint FromBytes(byte[] buffer)`
`166`	`166`	`{`
`167`	`167`	`return ECPoint.CreateFromBytes(Handle, buffer);`
`168`	`168`	`}`
`169`	`169`
`170`		`- /// <inheritdocs />`
	`170`	`+ /// <inheritdoc />`
`171`	`171`	`public ECPoint GenerateElement(SecureBigNumber index)`
`172`	`172`	`{`
`173`	`173`	`using (var ctx = BigNumberContextHandle.CreateSecure())`
`@@ -178,7 +178,7 @@ public ECPoint GenerateElement(SecureBigNumber index)`
`178`	`178`	`}`
`179`	`179`	`}`
`180`	`180`
`181`		`- /// <inheritdocs />`
	`181`	`+ /// <inheritdoc />`
`182`	`182`	`public bool IsPotentialElement(ECPoint element)`
`183`	`183`	`{`
`184`	`184`	`using (var ctx = BigNumberContextHandle.Create())`
`@@ -187,7 +187,7 @@ public bool IsPotentialElement(ECPoint element)`
`187`	`187`	`}`
`188`	`188`	`}`
`189`	`189`
`190`		`- /// <inheritdocs />`
	`190`	`+ /// <inheritdoc />`
`191`	`191`	`public bool IsSafeElement(ECPoint element)`
`192`	`192`	`{`
`193`	`193`	`if (!IsPotentialElement(element)) return false;`
`@@ -203,7 +203,7 @@ public bool IsSafeElement(ECPoint element)`
`203`	`203`	`return true;`
`204`	`204`	`}`
`205`	`205`
`206`		`- /// <inheritdocs />`
	`206`	`+ /// <inheritdoc />`
`207`	`207`	`public ECPoint MultiplyScalar(ECPoint e, SecureBigNumber k)`
`208`	`208`	`{`
`209`	`209`	`using (var ctx = BigNumberContextHandle.CreateSecure())`
`@@ -214,7 +214,7 @@ public ECPoint MultiplyScalar(ECPoint e, SecureBigNumber k)`
`214`	`214`	`}`
`215`	`215`	`}`
`216`	`216`
`217`		`- /// <inheritdocs />`
	`217`	`+ /// <inheritdoc />`
`218`	`218`	`public ECPoint Negate(ECPoint element)`
`219`	`219`	`{`
`220`	`220`	`using (var ctx = BigNumberContextHandle.Create())`
`@@ -225,13 +225,13 @@ public ECPoint Negate(ECPoint element)`
`225`	`225`	`}`
`226`	`226`	`}`
`227`	`227`
`228`		`- /// <inheritdocs />`
	`228`	`+ /// <inheritdoc />`
`229`	`229`	`public byte[] ToBytes(ECPoint element)`
`230`	`230`	`{`
`231`	`231`	`return element.ToBytes(GroupPointEncoding);`
`232`	`232`	`}`
`233`	`233`
`234`		`- /// <inheritdocs />`
	`234`	`+ /// <inheritdoc />`
`235`	`235`	`public (SecureBigNumber, ECPoint) GenerateRandomElement(RandomNumberGenerator randomNumberGenerator)`
`236`	`236`	`{`
`237`	`237`	`using (var keyHandle = ECKeyHandle.Create())`
`@@ -261,7 +261,7 @@ public byte[] ToBytes(ECPoint element)`
`261`	`261`	`}`
`262`	`262`	`}`
`263`	`263`
`264`		`- /// <inheritdocs />`
	`264`	`+ /// <inheritdoc />`
`265`	`265`	`public void Dispose()`
`266`	`266`	`{`
`267`	`267`	`Dispose(true);`
`@@ -276,7 +276,7 @@ private void Dispose(bool disposing)`
`276`	`276`	`}`
`277`	`277`	`}`
`278`	`278`
`279`		`- /// <inheritdocs />`
	`279`	`+ /// <inheritdoc />`
`280`	`280`	`public override bool Equals(object? obj)`
`281`	`281`	`{`
`282`	`282`	`EllipticCurveAlgebra? other = obj as EllipticCurveAlgebra;`
`@@ -288,7 +288,7 @@ public override bool Equals(object? obj)`
`288`	`288`	`}`
`289`	`289`	`}`
`290`	`290`
`291`		`- /// <inheritdocs />`
	`291`	`+ /// <inheritdoc />`
`292`	`292`	`public override int GetHashCode()`
`293`	`293`	`{`
`294`	`294`	`int hashCode = 55837;`
Original file line number	Diff line number	Diff line change
`@@ -85,7 +85,7 @@ internal BigNumberContextHandle(IntPtr handle, bool ownsHandle) : base(ownsHandl`
`85`	`85`	`}`
`86`	`86`	`}`
`87`	`87`
`88`		`- /// <inheritdocs />`
	`88`	`+ /// <inheritdoc />`
`89`	`89`	`protected override bool ReleaseHandle()`
`90`	`90`	`{`
`91`	`91`	`Debug.Assert(!IsInvalid);`
Original file line number	Diff line number	Diff line change
`@@ -236,7 +236,7 @@ private BigNumberHandle(IntPtr handle, bool ownsHandle) : base(ownsHandle)`
`236`	`236`	`}`
`237`	`237`	`}`
`238`	`238`
`239`		`- /// <inheritdocs />`
	`239`	`+ /// <inheritdoc />`
`240`	`240`	`protected override bool ReleaseHandle()`
`241`	`241`	`{`
`242`	`242`	`Debug.Assert(!IsInvalid);`
Original file line number	Diff line number	Diff line change
`@@ -61,7 +61,7 @@ private BigNumberMontgomeryContextHandle(IntPtr handle, bool ownsHandle) : base(`
`61`	`61`	`}`
`62`	`62`	`}`
`63`	`63`
`64`		`- /// <inheritdocs />`
	`64`	`+ /// <inheritdoc />`
`65`	`65`	`protected override bool ReleaseHandle()`
`66`	`66`	`{`
`67`	`67`	`Debug.Assert(!IsInvalid);`
Original file line number	Diff line number	Diff line change
`@@ -158,7 +158,7 @@ internal ECGroupHandle(IntPtr handle, bool ownsHandle) : base(ownsHandle)`
`158`	`158`	`}`
`159`	`159`	`}`
`160`	`160`
`161`		`- /// <inheritdocs />`
	`161`	`+ /// <inheritdoc />`
`162`	`162`	`protected override bool ReleaseHandle()`
`163`	`163`	`{`
`164`	`164`	`Debug.Assert(!IsInvalid);`
Original file line number	Diff line number	Diff line change
`@@ -115,7 +115,7 @@ internal ECKeyHandle(IntPtr handle, bool ownsHandle) : base(ownsHandle)`
`115`	`115`	`}`
`116`	`116`	`}`
`117`	`117`
`118`		`- /// <inheritdocs />`
	`118`	`+ /// <inheritdoc />`
`119`	`119`	`protected override bool ReleaseHandle()`
`120`	`120`	`{`
`121`	`121`	`Debug.Assert(!IsInvalid);`
Original file line number	Diff line number	Diff line change
`@@ -206,7 +206,7 @@ internal ECPointHandle(IntPtr handle, bool ownsHandle) : base(ownsHandle)`
`206`	`206`	`}`
`207`	`207`	`}`
`208`	`208`
`209`		`- /// <inheritdocs />`
	`209`	`+ /// <inheritdoc />`
`210`	`210`	`protected override bool ReleaseHandle()`
`211`	`211`	`{`
`212`	`212`	`EC_POINT_clear_free(this.handle);`
Original file line number	Diff line number	Diff line change
`@@ -21,7 +21,7 @@ protected NativeHandle()`
`21`	`21`	`}`
`22`	`22`	`#endif // FEATURE_CORECLR`
`23`	`23`
`24`		`- /// <inheritdocs />`
	`24`	`+ /// <inheritdoc />`
`25`	`25`	`public override bool IsInvalid`
`26`	`26`	`{`
`27`	`27`	`get`