-
Notifications
You must be signed in to change notification settings - Fork 0
/
Comments.xml
309 lines (309 loc) · 17.5 KB
/
Comments.xml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
<?xml version="1.0"?>
<doc>
<assembly>
<name>Penguin.Extensions.String</name>
</assembly>
<members>
<member name="M:Penguin.Extensions.Strings.Compatibility.StringExtensions.IsNullOrWhiteSpace(System.String)">
<summary>
Adds the ability to call IsNullOrWhiteSpace as an extension
</summary>
<param name="value">The value to check</param>
<returns>A bool representing the return of String.IsNullOrWhitespace(value)</returns>
</member>
<member name="M:Penguin.Extensions.Strings.Html.StringExtensions.GetElementsWithAttributeValue(System.String,System.String,System.String)">
<summary>
Returns a list of strings representing HTML elements with a certain attribute value
</summary>
<param name="input">The HTML string to search</param>
<param name="attr">The Attribute to search for</param>
<param name="value">The value of the attribute to be searched for</param>
<returns></returns>
</member>
<member name="M:Penguin.Extensions.Strings.Html.StringExtensions.GetFirstAttribute(System.String,System.String)">
<summary>
Returns the first matching HTML attribute value in the source string
</summary>
<param name="input">The HTML string to search</param>
<param name="attr">The Attribute to search for</param>
<returns>The value of the attribute being searched for</returns>
</member>
<member name="M:Penguin.Extensions.Strings.Html.StringExtensions.GetUnclosedElements(System.String,System.String)">
<summary>
Attempts to find HTML elements that are not properly closed, for validation
</summary>
<param name="input">The input string to search</param>
<param name="element">The element to search for</param>
<returns></returns>
</member>
<member name="M:Penguin.Extensions.Strings.Html.StringExtensions.InnerHtml(System.String)">
<summary>
Returns the InnerHtml of the element (text between > and lt;)
</summary>
<param name="input">The HTML string representing the element</param>
<returns></returns>
</member>
<member name="M:Penguin.Extensions.Strings.Security.SecureStringExtensions.ToInsecureString(System.Security.SecureString)">
<summary>
Converts a SecureString to a String
</summary>
<param name="instr">The SecureString to convert</param>
<returns></returns>
</member>
<member name="M:Penguin.Extensions.Strings.Security.SecureStringExtensions.ValueEquals(System.Security.SecureString,System.Security.SecureString)">
<summary>
Tests two SecureStrings for equality
</summary>
<param name="a">The first string to compare</param>
<param name="b">The second string to compare</param>
<returns></returns>
</member>
<member name="M:Penguin.Extensions.Strings.Security.StringExtensions.ComputeSha256Hash(System.String)">
<summary>
Computes an SHA256 hash
</summary>
<param name="input">The string to hash</param>
<returns>The hashed string</returns>
</member>
<member name="M:Penguin.Extensions.Strings.Security.StringExtensions.ComputeSha1Hash(System.String)">
<summary>
Computes an SHA1 hash
</summary>
<param name="input">The string to hash</param>
<returns>The hashed string</returns>
</member>
<member name="M:Penguin.Extensions.Strings.Security.StringExtensions.SHA512(System.String,System.Byte[])">
<summary>
Generates a salted MD5 hash of the string
</summary>
<param name="plainText">The input string</param>
<param name="saltBytes">Optional bytes to override the default salt</param>
<returns>The hashed string</returns>
</member>
<member name="M:Penguin.Extensions.Strings.Security.StringExtensions.ComputeSha512Hash(System.String,System.Byte[])">
<summary>
Generates a salted MD5 hash of the string
</summary>
<param name="input">The input string</param>
<param name="saltBytes">Optional bytes to override the default salt</param>
<returns>The hashed string</returns>
</member>
<member name="M:Penguin.Extensions.Strings.StringExtensions.ToNumeric(System.String)">
<summary>
Strips non-numeric characters from a string
</summary>
<param name="input">The original value</param>
<returns>The value without non-numeric characters</returns>
</member>
<member name="M:Penguin.Extensions.Strings.StringExtensions.AllIndexesOf(System.String,System.String,System.StringComparison)">
<summary>
Returns a list of indexes for the specified string
</summary>
<param name="str">The source string</param>
<param name="value">The string to find</param>
<param name="comparisonType">The comparison type to pass into the index function</param>
<returns>A list of indexes where the value is found</returns>
</member>
<member name="M:Penguin.Extensions.Strings.StringExtensions.Contains(System.String,System.String,System.StringComparison)">
<summary>
Checks if the parent string contains the substring, with optional case inequality
</summary>
<param name="s">The source string</param>
<param name="search">The substring to search for</param>
<param name="comparisonType">The comparison type to pass into the index function</param>
<returns>A value indicating if the substring was found</returns>
</member>
<member name="M:Penguin.Extensions.Strings.StringExtensions.Enclose(System.String,System.String,System.Boolean)">
<summary>
Finds a substring between two anchor characters. Allows for nested
</summary>
<param name="input">The string to search</param>
<param name="openingclosing">The opening and closing character</param>
<param name="inclusive">Bool indicating whether or not the returned string should include the enclosing characters</param>
<returns>The substring between the nested characters</returns>
</member>
<member name="M:Penguin.Extensions.Strings.StringExtensions.Enclose(System.String,System.String,System.String,System.Boolean)">
<summary>
Finds a substring between two anchor characters. Allows for nested
</summary>
<param name="input">The string to search</param>
<param name="opening">The opening character</param>
<param name="closing">The closing character</param>
<param name="inclusive"></param>
<returns>The substring between the nested characters</returns>
</member>
<member name="M:Penguin.Extensions.Strings.StringExtensions.From(System.String,System.String,System.Boolean,System.StringComparison)">
<summary>
Returns the portion of the source string after the first instance of the delimiter
</summary>
<param name="s">The source string</param>
<param name="fromText">The delimiter</param>
<param name="inclusive">A bool indicating whether or not the delimiter should be returned with the result</param>
<param name="comparison">The string comparison to use when searching for a match</param>
<returns>The substring found after the first instance of the delimiter</returns>
</member>
<member name="M:Penguin.Extensions.Strings.StringExtensions.TrimLines(System.String)">
<summary>
Splits a string on \r and \n\ (individually) and returns any "lines" in trimmed form, that are not null or whitespace
</summary>
<param name="s">The string to split</param>
<returns>Any trimmed lines that are not null or whitespace</returns>
</member>
<member name="M:Penguin.Extensions.Strings.StringExtensions.FromLast(System.String,System.String)">
<summary>
Returns the portion of the source string after the last instance of the delimiter
</summary>
<param name="s">The source string</param>
<param name="fromText">The delimiter</param>
<returns>The substring found after the last instance of the delimiter</returns>
</member>
<member name="M:Penguin.Extensions.Strings.StringExtensions.FromLast(System.String,System.Char)">
<summary>
Returns the portion of the source string after the last instance of the delimiter
</summary>
<param name="s">The source string</param>
<param name="fromText">The delimiter</param>
<returns>The substring found after the last instance of the delimiter</returns>
</member>
<member name="M:Penguin.Extensions.Strings.StringExtensions.Left(System.String,System.Int32)">
<summary>
Returns the leftmost portion of a string of a specified length
</summary>
<param name="str">The source string</param>
<param name="count">The number of characters to return</param>
<returns>A substring of the specified length from the source string</returns>
</member>
<member name="M:Penguin.Extensions.Strings.StringExtensions.Remove(System.String,System.String)">
<summary>
Removes all instances of the specified string, from the source (using Replace)
</summary>
<param name="input">The source string</param>
<param name="toRemove">The substring to remove</param>
<returns>The source string without any instances of the specified substring</returns>
</member>
<member name="M:Penguin.Extensions.Strings.StringExtensions.ReplaceAt(System.String,System.Int32,System.Char)">
<summary>
Replaces a character at the specified index with another character
</summary>
<param name="input">The source string</param>
<param name="index">The index at which to replace the character</param>
<param name="newChar">The new character to insert</param>
<returns>A new string with the character replaced</returns>
</member>
<member name="M:Penguin.Extensions.Strings.StringExtensions.Right(System.String,System.Int32)">
<summary>
Returns the rightmost portion of a string of a specified length
</summary>
<param name="str">The source string</param>
<param name="count">The number of characters to return</param>
<returns>The rightmost portion of the source string of a specified length</returns>
</member>
<member name="M:Penguin.Extensions.Strings.StringExtensions.Split(System.String,System.String,System.Boolean,System.StringSplitOptions)">
<summary>
Splits a string on a delimiter
</summary>
<param name="input">The source string</param>
<param name="spliton">The delimiter to split on</param>
<param name="preserveSplit">A bool indicating whether or not to append the delimiter back to the results</param>
<param name="options">String split options for the initial split</param>
<returns>An array of strings</returns>
</member>
<member name="M:Penguin.Extensions.Strings.StringExtensions.SplitCamelCase(System.String)">
<summary>
Splits a CamelCase string on each uppercase letter by adding a space in front of each
</summary>
<param name="str">The string to split</param>
<returns>A string where each uppercase letter is preceded by a space</returns>
</member>
<member name="M:Penguin.Extensions.Strings.StringExtensions.SplitQuotedString(System.Collections.Generic.IEnumerable{System.Char},Penguin.Extensions.Strings.QuotedStringOptions)">
<summary>
Splits a CSV row on the specified delimeter. Supports quoted
</summary>
<param name="toSplit">The string to split</param>
<param name="options">Optional options to use when splitting</param>
<returns>An IEnumerable used to obtain the split values</returns>
</member>
<member name="M:Penguin.Extensions.Strings.StringExtensions.To(System.String,System.String,System.Boolean,System.StringComparison)">
<summary>
Returns the portion of a string up until the first instance of a delimiter
</summary>
<param name="s">The source</param>
<param name="toText">The delimeter</param>
<param name="inclusive">A bool indicating whether or not the delimiter should be included in the return</param>
<param name="comparison">String comparison options</param>
<returns>The portion of a string up until the first instance of a delimiter</returns>
</member>
<member name="M:Penguin.Extensions.Strings.StringExtensions.ToAlphaNumeric(System.String)">
<summary>
Strips non-alphanumeric characters from the string
</summary>
<param name="str">The source string</param>
<returns>The source string in AlphaNumeric</returns>
</member>
<member name="M:Penguin.Extensions.Strings.StringExtensions.ToDictionary(System.String,System.Char,System.Char)">
<summary>
Splits a string into a dictionary as denoted by the provided K/V separator and KVP delimeter characters
</summary>
<param name="source">The source string to split</param>
<param name="delimeter">The character that separates the key value pairs</param>
<param name="separator">The character that separates the key and value within the pair</param>
<returns>A dictionary representing the values</returns>
</member>
<member name="M:Penguin.Extensions.Strings.StringExtensions.ToBase64(System.String,System.Text.Encoding)">
<summary>
Converts a string to Base64 encoding
</summary>
<param name="input">the string to convert</param>
<param name="encoding">Optional Encoding. UTF8 default</param>
<returns></returns>
</member>
<member name="M:Penguin.Extensions.Strings.StringExtensions.FromBase64(System.String,System.Text.Encoding)">
<summary>
Converts a string from Base64 encoding
</summary>
<param name="input">the string to convert</param>
<param name="encoding">Optional Encoding. UTF8 default</param>
<returns></returns>
</member>
<member name="M:Penguin.Extensions.Strings.StringExtensions.ToInt(System.String)">
<summary>
Parses a string to its Int value by stripping out invalid characters
</summary>
<param name="input">The input string to parse</param>
<returns>An integer representing the string value, or 0 if empty</returns>
</member>
<member name="M:Penguin.Extensions.Strings.StringExtensions.ToLast(System.String,System.String,System.Boolean,System.StringComparison)">
<summary>
Returns a portion of a string up to the last instance of a specified delimiter
</summary>
<param name="s">The source string</param>
<param name="toText">The delimiter</param>
<param name="inclusive">Whether or not to return the delimiter as part of result</param>
<param name="comparison">The string comparison to use when searching</param>
<returns>A portion of a string up to the last instance of a specified delimiter</returns>
</member>
<member name="M:Penguin.Extensions.Strings.StringExtensions.ToLast(System.String,System.Char,System.Boolean)">
<summary>
Returns a portion of a string up to the last instance of a specified delimiter
</summary>
<param name="s">The source string</param>
<param name="toText">The delimiter</param>
<param name="inclusive">Whether or not to return the delimiter as part of result</param>
<returns>A portion of a string up to the last instance of a specified delimiter</returns>
</member>
<member name="M:Penguin.Extensions.Strings.Validation.StringExtensions.IsValidEmail(System.String)">
<summary>
Attempts to validate whether or not a string represents a valid email address
</summary>
<param name="str">The string to validate</param>
<returns>A bool representing whether or not the email is valid</returns>
</member>
<member name="M:Penguin.Extensions.Strings.Validation.StringExtensions.IsValidUrl(System.String)">
<summary>
Attempts to validate whether or not a string represents a valid Url
</summary>
<param name="toTest">The string to validate</param>
<returns>A bool representing whether or not the Url is valid</returns>
</member>
</members>
</doc>