8000 Add missing XML comments to public members · openssl-net/openssl-net@acfcedd · GitHub
[go: up one dir, main page]
Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly
Appearance settings
This repository was archived by the owner on Dec 15, 2022. It is now read-only.

Commit acfcedd

Browse files
author
Frank Laub
committed
Add missing XML comments to public members
1 parent da49368 commit acfcedd

File tree

16 files changed

+503
-185
lines changed

16 files changed

+503
-185
lines changed

‎ManagedOpenSsl/Core/BigNumber.cs

Lines changed: 42 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -91,7 +91,7 @@ public static BigNumber FromDecimalString(string str)
9191

9292
var ret = Native.BN_dec2bn(out ptr, buf);
9393
if (ret <= 0)
94-
throw new OpenSslException();
94+
throw new OpenSslException();
9595

9696
return new BigNumber(ptr, true);
9797
}
@@ -108,7 +108,7 @@ public static BigNumber FromHexString(string str)
108108

109109
var ret = Native.BN_hex2bn(out ptr, buf);
110110
if (ret <= 0)
111-
throw new OpenSslException();
111+
throw new OpenSslException();
112112

113113
return new BigNumber(ptr, true);
114114
}
@@ -174,7 +174,7 @@ public static implicit operator byte[](BigNumber rhs)
174174

175175
return bytes;
176176
}
177-
177+
178178
/// <summary>
179179
/// Calls BN_bn2bin()
180180
/// </summary>
@@ -261,7 +261,7 @@ public static BigNumber PseudoNextRange(BigNumber range)
261261
/// <param name="lhs"></param>
262262
/// <param name="rhs"></param>
263263
/// <returns></returns>
264-
public static BigNumber operator + (BigNumber lhs, BigNumber rhs)
264+
public static BigNumber operator +(BigNumber lhs, BigNumber rhs)
265265
{
266266
var ret = new BigNumber();
267267
Native.ExpectSuccess(Native.BN_add(ret.Handle, lhs.Handle, rhs.Handle));
@@ -351,7 +351,8 @@ public override void Print(BIO bio)
351351
/// <summary>
352352
/// Calls BN_free()
353353
/// </summary>
354-
protected override void OnDispose() {
354+
protected override void OnDispose()
355+
{
355356
Native.BN_free(ptr);
356357
}
357358

@@ -394,7 +395,7 @@ public Native.bn_gencb_st CallbackStruct
394395
get { return gencb; }
395396
}
396397

397-
public GeneratorThunk(GeneratorHandler client, object arg)
398+
public GeneratorThunk(GeneratorHandler client, object arg)
398399
{
399400
OnGenerator = client;
400401
this.arg = arg;
@@ -410,11 +411,11 @@ internal int OnGeneratorThunk(int p, int n, IntPtr arg)
410411
{
411412
try
412413
{
413-
return OnGenerator(p, n, this.arg);
414+
return OnGenerator(p, n, this.arg);
414415
}
415416
catch (Exception)
416417
{
417-
return 0;
418+
return 0;
418419
}
419420
}
420421
else
@@ -427,27 +428,50 @@ internal int OnGeneratorThunk(int p, int n, IntPtr arg)
427428
}
428429

429430
#endregion
430-
431+
431432
#region Context
433+
/// <summary>
434+
/// Wraps BN_CTX
435+
/// </summary>
432436
public class Context : Base
433437
{
438+
/// <summary>
439+
/// Calls BN_CTX_new()
440+
/// </summary>
434441
public Context()
435-
: base(Native.ExpectNonNull(Native.BN_CTX_new()), true) {
442+
: base(Native.ExpectNonNull(Native.BN_CTX_new()), true)
443+
{
436444
}
437-
438-
public BigNumber BigNumber {
445+
446+
/// <summary>
447+
/// Returns BN_CTX_get()
448+
/// </summary>
449+
public BigNumber BigNumber
450+
{
439451
get { return new BigNumber(Native.ExpectNonNull(Native.BN_CTX_get(ptr)), false); }
440452
}
441-
442-
public void Start() {
453+
454+
/// <summary>
455+
/// Calls BN_CTX_start()
456+
/// </summary>
457+
public void Start()
458+
{
443459
Native.BN_CTX_start(ptr);
444460
}
445-
446-
public void End() {
461+
462+
/// <summary>
463+
/// Calls BN_CTX_end()
464+
/// </summary>
465+
public void End()
466+
{
447467
Native.BN_CTX_end(ptr);
448468
}
449-
450-
protected override void OnDispose() {
469+
470+
/// <summary>
471+
/// Calls BN_CTX_free()
472+
/// </summary>
473+
protected override void OnDispose()
474+
{
451475
Native.BN_CTX_free(ptr);
452476
}
453477
}

‎ManagedOpenSsl/Core/Crypto.cs

Lines changed: 0 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -127,14 +127,6 @@ public static string Blowfish_Options
127127
get { return Native.StaticString(Native.BF_options()); }
128128
}
129129

130-
/// <summary>
131-
/// Calls CRYPTO_malloc_debug_init()
132-
/// </summary>
133-
public static void MallocDebugInit()
134-
{
135-
Native.CRYPTO_malloc_debug_init();
136-
}
137-
138130
/// <summary>
139131
/// Calls CRYPTO_dbg_set_options()
140132
/// </summary>

‎ManagedOpenSsl/Core/MemoryTracker.cs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -19,8 +19,8 @@ public class MemoryTracker
1919
/// </summary>
2020
public static void Start()
2121
{
22-
leaked = 0;
23-
CryptoUtil.MallocDebugInit();
22+
leaked = 0;
23+
Native.CRYPTO_malloc_debug_init();
2424
CryptoUtil.SetDebugOptions(DebugOptions.All);
2525
CryptoUtil.SetMemoryCheck(MemoryCheck.On);
2626
}

‎ManagedOpenSsl/Core/Objects.cs

Lines changed: 87 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -25,43 +25,130 @@
2525

2626< EED3 /code>
namespace OpenSSL.Core
2727
{
28+
/// <summary>
29+
///
30+
/// </summary>
2831
public class Objects
2932
{
33+
/// <summary>
34+
///
35+
/// </summary>
3036
public class NID
3137
{
38+
/// <summary>
39+
/// 0
40+
/// </summary>
3241
public static Asn1Object undef = new Asn1Object(0);
42+
/// <summary>
43+
/// 406
44+
/// </summary>
3345
public static Asn1Object X9_62_prime_field = new Asn1Object(406);
46+
/// <summary>
47+
/// 409
48+
/// </summary>
3449
public static Asn1Object X9_62_prime192v1 = new Asn1Object(409);
50+
/// <summary>
51+
/// 410
52+
/// </summary>
3553
public static Asn1Object X9_62_prime192v2 = new Asn1Object(410);
54+
/// <summary>
55+
/// 411
56+
/// </summary>
3657
public static Asn1Object X9_62_prime192v3 = new Asn1Object(411);
58+
/// <summary>
59+
/// 412
60+
/// </summary>
3761
public static Asn1Object X9_62_prime239v1 = new Asn1Object(412);
62+
/// <summary>
63+
/// 413
64+
/// </summary>
3865
public static Asn1Object X9_62_prime239v2 = new Asn1Object(413);
66+
/// <summary>
67+
/// 414
68+
/// </summary>
3969
public static Asn1Object X9_62_prime239v3 = new Asn1Object(414);
70+
/// <summary>
71+
/// 415
72+
/// </summary>
4073
public static Asn1Object X9_62_prime256v1 = new Asn1Object(415);
4174

75+
/// <summary>
76+
/// 688
77+
/// </summary>
4278
public static Asn1Object X9_62_c2tnb191v1 = new Asn1Object(688);
79+
/// <summary>
80+
/// 694
81+
/// </summary>
4382
public static Asn1Object X9_62_c2tnb239v1 = new Asn1Object(694);
4483

84+
/// <summary>
85+
/// 713
86+
/// </summary>
4587
public static Asn1Object secp224r1 = new Asn1Object(713);
88+
/// <summary>
89+
/// 715
90+
/// </summary>
4691
public static Asn1Object secp384r1 = new Asn1Object(715);
92+
/// <summary>
93+
/// 716
94+
/// </summary>
4795
public static Asn1Object secp521r1 = new Asn1Object(716);
4896

97+
/// <summary>
98+
/// 721
99+
/// </summary>
49100
public static Asn1Object sect163k1 = new Asn1Object(721);
101+
/// <summary>
102+
/// 723
103+
/// </summary>
50104
public static Asn1Object sect163r2 = new Asn1Object(723);
105+
/// <summary>
106+
/// 726
107+
/// </summary>
51108
public static Asn1Object sect233k1 = new Asn1Object(726);
109+
/// <summary>
110+
/// 727
111+
/// </summary>
52112
public static Asn1Object sect233r1 = new Asn1Object(727);
113+
/// <summary>
114+
/// 729
115+
/// </summary>
53116
public static Asn1Object sect283k1 = new Asn1Object(729);
117+
/// <summary>
118+
/// 730
119+
/// </summary>
54120
public static Asn1Object sect283r1 = new Asn1Object(730);
121+
/// <summary>
122+
/// 731
123+
/// </summary>
55124
public static Asn1Object sect409k1 = new Asn1Object(731);
125+
/// <summary>
126+
/// 732
127+
/// </summary>
56128
public static Asn1Object sect409r1 = new Asn1Object(732);
129+
/// <summary>
130+
/// 733
131+
/// </summary>
57132
public static Asn1Object sect571k1 = new Asn1Object(733);
133+
/// <summary>
134+
/// 734
135+
/// </summary>
58136
public static Asn1Object sect571r1 = new Asn1Object(734);
59137

138+
/// <summary>
139+
/// 750
140+
/// </summary>
60141
public static Asn1Object ipsec4 = new Asn1Object(750);
61142
}
62143

144+
/// <summary>
145+
///
146+
/// </summary>
63147
public class SN
64148
{
149+
/// <summary>
150+
/// prime192v1
151+
/// </summary>
65152
public static Asn1Object X9_62_prime192v1 = new Asn1Object("prime192v1");
66153
}
67154
}

0 commit comments

Comments
 (0)
0