diff --git a/CapyKit/CapyKit.csproj b/CapyKit/CapyKit.csproj index 8b7df7b..5e7c51b 100644 --- a/CapyKit/CapyKit.csproj +++ b/CapyKit/CapyKit.csproj @@ -1,19 +1,10 @@  - - net8.0 - enable - enable - True - README.md - 1.0.2 - - - - - True - \ - - + + net8.0 + enable + enable + True + diff --git a/CapyKit/Helpers/SecurityHelper.cs b/CapyKit/Helpers/SecurityHelper.cs index fecdc18..9f58541 100644 --- a/CapyKit/Helpers/SecurityHelper.cs +++ b/CapyKit/Helpers/SecurityHelper.cs @@ -100,7 +100,7 @@ namespace CapyKit.Helpers /// public static Password GetPassword(string password, params object[] args) { - var salt = SecurityHelper.GetSalt; + var salt = SecurityHelper.GetRandomBytes(SecurityHelper.SALT_SIZE); return GetPassword(password, salt, args); } @@ -278,29 +278,11 @@ namespace CapyKit.Helpers return buffer.ToString(); } - /// Generates a random byte array that can act as a salt. - /// - /// A default length of is provided as a sane default. Larger values can be used for increased - /// entropy. - /// - /// (Optional) The desired length of the generated byte array. - /// An array of byte. - public static byte[] GetSalt(int length = SALT_SIZE) - { - return GetRandomBytes(length); - } - /// Generates a new byte array of the specified length with random values. /// The desired length of the generated byte array. /// A new byte array of the specified length filled with random values. private static byte[] GetRandomBytes(int length) { - if(length <= 0) - { - CapyEventReporter.EmitEvent(EventLevel.Error, "Length must be greater than 0."); - return GetRandomBytes(16); - } - var buffer = new byte[length]; using (var rng = RandomNumberGenerator.Create()) { diff --git a/Documentation/Content/Welcome.aml b/Documentation/Content/Welcome.aml index 7b71a49..59bfe8b 100644 --- a/Documentation/Content/Welcome.aml +++ b/Documentation/Content/Welcome.aml @@ -2,36 +2,54 @@ - - Welcome to the official documentation for CapyKit – your go-to utility kit for boosting productivity in any .NET project. - Originally born out of the HappyCapy project, CapyKit is now fully open for the community, - offering a wide array of C# utilities and extensions. - - - - Whether you're looking to integrate some handy extensions into your existing project or you're exploring what - CapyKit can do for your next venture, you've come to the right place! - + This is a sample conceptual topic. You can use this as a starting point for adding more conceptual +content to your help project.
Getting Started - - This documentation is generated directly from the source code and is constantly evolving as the project progresses. - To dive in, check out the full reference material and guides in the [CapyKit Documentation](R_Project_Documentation.md). - + To get started, add a documentation source to the project (a Visual Studio solution, project, or +assembly and XML comments file). See the Getting Started topics in the Sandcastle Help +File Builder's help file for more information. The following default items are included in this project: - - If you're new to the project, bear with us while things are still transitioning from the private repository. - We're working hard to make this resource the best it can be. - + + + ContentLayout.content - Use the content layout file to manage the +conceptual content in the project and define its layout in the table of contents. + - - For a complete overview of the automatically generated documentation, start by exploring the - [API and Utilities Reference](R_Project_Documentation.md) - + + The .\media folder - Place images in this folder that you will reference +from conceptual content using medialLink or mediaLinkInline +elements. If you will not have any images in the file, you may remove this folder. + + + + The .\icons folder - This contains a default logo for the help file. You +may replace it or remove it and the folder if not wanted. If removed or if you change the file name, update +the Transform Args project properties page by removing or changing the filename in the +logoFile transform argument. Note that unlike images referenced from conceptual topics, +the logo file should have its BuildAction property set to Content. + + + + The .\Content folder - Use this to store your conceptual topics. You may +name the files and organize them however you like. One suggestion is to lay the files out on disk as you have +them in the content layout file as shown in this project but the choice is yours. Files can be added via the +Solution Explorer or from within the content layout file editor. Files must appear in the content layout file +in order to be compiled into the help file. + + + + See the Conceptual Content topics in the Sandcastle Help File Builder's +help file for more information. See the Sandcastle MAML Guide for details on Microsoft +Assistance Markup Language (MAML) which is used to create these topics.
+ + + +
diff --git a/Documentation/ContentLayout.content b/Documentation/ContentLayout.content index 5613b7b..dce8e69 100644 --- a/Documentation/ContentLayout.content +++ b/Documentation/ContentLayout.content @@ -1,6 +1,6 @@  - + diff --git a/Documentation/Documentation.shfbproj b/Documentation/Documentation.shfbproj index b523cef..d362909 100644 --- a/Documentation/Documentation.shfbproj +++ b/Documentation/Documentation.shfbproj @@ -62,16 +62,6 @@ False Msdn True - Welcome to the official documentation for CapyKit, a powerful collection of C# utilities designed to enhance your .NET projects. Below, you&#39%3bll find a list of namespaces included in the library, each offering a unique set of tools, extensions, and helpers to streamline your development process. - - -Core utilities and foundational methods for the CapyKit library. -Custom attributes for simplifying .NET code behavior. -Commonly used enumerations for value comparison and logic. -Extension methods for enhancing .NET classes and simplifying operations. -Utility classes for tasks like data manipulation and reflection. -Unit tests ensuring CapyKit functions as expected. -Contains unit tests specifically focused on verifying the correctness of the code in `CapyKit.Helpers`. diff --git a/Documentation/Help/849aa079-3d64-4cf1-966f-44af23c73160.md b/Documentation/Help/849aa079-3d64-4cf1-966f-44af23c73160.md index bbb85dd..a9b780c 100644 --- a/Documentation/Help/849aa079-3d64-4cf1-966f-44af23c73160.md +++ b/Documentation/Help/849aa079-3d64-4cf1-966f-44af23c73160.md @@ -1,14 +1,27 @@ # CapyKit - C# Utilities -Welcome to the official documentation for CapyKit – your go-to utility kit for boosting productivity in any .NET project. Originally born out of the *HappyCapy* project, CapyKit is now fully open for the community, offering a wide array of C# utilities and extensions. - -Whether you're looking to integrate some handy extensions into your existing project or you're exploring what CapyKit can do for your next venture, you've come to the right place! +This is a sample conceptual topic. You can use this as a starting point for adding more conceptual content to your help project. ## Getting Started -This documentation is generated directly from the source code and is constantly evolving as the project progresses. To dive in, check out the full reference material and guides in the [CapyKit Documentation](R_Project_Documentation.md). +To get started, add a documentation source to the project (a Visual Studio solution, project, or assembly and XML comments file). See the **Getting Started** topics in the Sandcastle Help File Builder's help file for more information. The following default items are included in this project: +
  • ContentLayout.content - Use the content layout file to manage the conceptual content in the project and define its layout in the table of contents.

  • -If you're new to the project, bear with us while things are still transitioning from the private repository. We're working hard to make this resource the best it can be. +The .\media folder - Place images in this folder that you will reference from conceptual content using medialLink or mediaLinkInline elements. If you will not have any images in the file, you may remove this folder.

  • -For a complete overview of the automatically generated documentation, start by exploring the [API and Utilities Reference](R_Project_Documentation.md) +The .\icons folder - This contains a default logo for the help file. You may replace it or remove it and the folder if not wanted. If removed or if you change the file name, update the Transform Args project properties page by removing or changing the filename in the logoFile transform argument. Note that unlike images referenced from conceptual topics, the logo file should have its BuildAction property set to Content.

  • + +The .\Content folder - Use this to store your conceptual topics. You may name the files and organize them however you like. One suggestion is to lay the files out on disk as you have them in the content layout file as shown in this project but the choice is yours. Files can be added via the Solution Explorer or from within the content layout file editor. Files must appear in the content layout file in order to be compiled into the help file.

+ + + + +See the **Conceptual Content** topics in the Sandcastle Help File Builder's help file for more information. See the **Sandcastle MAML Guide** for details on Microsoft Assistance Markup Language (MAML) which is used to create these topics. + + +## See Also + + +#### Other Resources +[7d36447b-0aab-4ce9-b5ed-e60ec5bee103] diff --git a/Documentation/Help/F_CapyKit_CapyEventReporter_uniqueIdentifiers.md b/Documentation/Help/F_CapyKit_CapyEventReporter_uniqueIdentifiers.md index ebd7cf2..da508ae 100644 --- a/Documentation/Help/F_CapyKit_CapyEventReporter_uniqueIdentifiers.md +++ b/Documentation/Help/F_CapyKit_CapyEventReporter_uniqueIdentifiers.md @@ -7,7 +7,7 @@ A hash set storing unique identifiers for events intended to only be emitted onc ## Definition **Namespace:** CapyKit -**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.2 +**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0 **C#** ``` C# diff --git a/Documentation/Help/F_CapyKit_Helpers_CalculationHelper_EARTH_RADIUS_KILOMETERS.md b/Documentation/Help/F_CapyKit_Helpers_CalculationHelper_EARTH_RADIUS_KILOMETERS.md index 2426a1e..777c5d2 100644 --- a/Documentation/Help/F_CapyKit_Helpers_CalculationHelper_EARTH_RADIUS_KILOMETERS.md +++ b/Documentation/Help/F_CapyKit_Helpers_CalculationHelper_EARTH_RADIUS_KILOMETERS.md @@ -7,7 +7,7 @@ The earth's radius in kilometers. ## Definition **Namespace:** CapyKit.Helpers -**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.2 +**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0 **C#** ``` C# diff --git a/Documentation/Help/F_CapyKit_Helpers_CalculationHelper_MILES_PER_KILOMETER.md b/Documentation/Help/F_CapyKit_Helpers_CalculationHelper_MILES_PER_KILOMETER.md index e03bec3..fdbad0f 100644 --- a/Documentation/Help/F_CapyKit_Helpers_CalculationHelper_MILES_PER_KILOMETER.md +++ b/Documentation/Help/F_CapyKit_Helpers_CalculationHelper_MILES_PER_KILOMETER.md @@ -7,7 +7,7 @@ Ratio of miles per kilometer . ## Definition **Namespace:** CapyKit.Helpers -**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.2 +**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0 **C#** ``` C# diff --git a/Documentation/Help/F_CapyKit_Helpers_CalculationHelper_chars.md b/Documentation/Help/F_CapyKit_Helpers_CalculationHelper_chars.md index e8986ea..457bb61 100644 --- a/Documentation/Help/F_CapyKit_Helpers_CalculationHelper_chars.md +++ b/Documentation/Help/F_CapyKit_Helpers_CalculationHelper_chars.md @@ -7,7 +7,7 @@ The valid hexidecimal characters. ## Definition **Namespace:** CapyKit.Helpers -**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.2 +**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0 **C#** ``` C# diff --git a/Documentation/Help/F_CapyKit_Helpers_EncryptionHelper_encryptionKey.md b/Documentation/Help/F_CapyKit_Helpers_EncryptionHelper_encryptionKey.md index 8ecd21d..8e199db 100644 --- a/Documentation/Help/F_CapyKit_Helpers_EncryptionHelper_encryptionKey.md +++ b/Documentation/Help/F_CapyKit_Helpers_EncryptionHelper_encryptionKey.md @@ -7,7 +7,7 @@ ## Definition **Namespace:** CapyKit.Helpers -**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.2 +**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0 **C#** ``` C# diff --git a/Documentation/Help/F_CapyKit_Helpers_SecurityHelper_LOWER_CASE_CHARACTERS.md b/Documentation/Help/F_CapyKit_Helpers_SecurityHelper_LOWER_CASE_CHARACTERS.md index 2102328..4129067 100644 --- a/Documentation/Help/F_CapyKit_Helpers_SecurityHelper_LOWER_CASE_CHARACTERS.md +++ b/Documentation/Help/F_CapyKit_Helpers_SecurityHelper_LOWER_CASE_CHARACTERS.md @@ -7,7 +7,7 @@ A string of all the lower case characters. ## Definition **Namespace:** CapyKit.Helpers -**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.2 +**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0 **C#** ``` C# diff --git a/Documentation/Help/F_CapyKit_Helpers_SecurityHelper_NUMBER_CHARACTERS.md b/Documentation/Help/F_CapyKit_Helpers_SecurityHelper_NUMBER_CHARACTERS.md index 5f093d8..02f1ab6 100644 --- a/Documentation/Help/F_CapyKit_Helpers_SecurityHelper_NUMBER_CHARACTERS.md +++ b/Documentation/Help/F_CapyKit_Helpers_SecurityHelper_NUMBER_CHARACTERS.md @@ -7,7 +7,7 @@ A string of all the numeric characters. ## Definition **Namespace:** CapyKit.Helpers -**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.2 +**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0 **C#** ``` C# diff --git a/Documentation/Help/F_CapyKit_Helpers_SecurityHelper_SALT_SIZE.md b/Documentation/Help/F_CapyKit_Helpers_SecurityHelper_SALT_SIZE.md index 233fd9a..66241dd 100644 --- a/Documentation/Help/F_CapyKit_Helpers_SecurityHelper_SALT_SIZE.md +++ b/Documentation/Help/F_CapyKit_Helpers_SecurityHelper_SALT_SIZE.md @@ -7,7 +7,7 @@ Default size to use when generating a new salt. ## Definition **Namespace:** CapyKit.Helpers -**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.2 +**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0 **C#** ``` C# diff --git a/Documentation/Help/F_CapyKit_Helpers_SecurityHelper_SPECIAL_CHARACTERS.md b/Documentation/Help/F_CapyKit_Helpers_SecurityHelper_SPECIAL_CHARACTERS.md index ad166cd..c65f8b5 100644 --- a/Documentation/Help/F_CapyKit_Helpers_SecurityHelper_SPECIAL_CHARACTERS.md +++ b/Documentation/Help/F_CapyKit_Helpers_SecurityHelper_SPECIAL_CHARACTERS.md @@ -7,7 +7,7 @@ A string of the most common non-alphanumeric characters. ## Definition **Namespace:** CapyKit.Helpers -**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.2 +**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0 **C#** ``` C# diff --git a/Documentation/Help/F_CapyKit_Helpers_SecurityHelper_UPPER_CASE_CHARACTERS.md b/Documentation/Help/F_CapyKit_Helpers_SecurityHelper_UPPER_CASE_CHARACTERS.md index fead002..65e6cb5 100644 --- a/Documentation/Help/F_CapyKit_Helpers_SecurityHelper_UPPER_CASE_CHARACTERS.md +++ b/Documentation/Help/F_CapyKit_Helpers_SecurityHelper_UPPER_CASE_CHARACTERS.md @@ -7,7 +7,7 @@ A string of all the upper case characters. ## Definition **Namespace:** CapyKit.Helpers -**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.2 +**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0 **C#** ``` C# diff --git a/Documentation/Help/F_CapyKit_Helpers_SettingsHelper_accessor.md b/Documentation/Help/F_CapyKit_Helpers_SettingsHelper_accessor.md index 65e5c4b..07de635 100644 --- a/Documentation/Help/F_CapyKit_Helpers_SettingsHelper_accessor.md +++ b/Documentation/Help/F_CapyKit_Helpers_SettingsHelper_accessor.md @@ -7,7 +7,7 @@ Private delegate function that retrieves a setting with the given `key`. ## Definition **Namespace:** CapyKit.Helpers -**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.2 +**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0 **C#** ``` C# diff --git a/Documentation/Help/F_CapyKit_Helpers_SettingsHelper_detector.md b/Documentation/Help/F_CapyKit_Helpers_SettingsHelper_detector.md index 2aec8d0..ff1f3fd 100644 --- a/Documentation/Help/F_CapyKit_Helpers_SettingsHelper_detector.md +++ b/Documentation/Help/F_CapyKit_Helpers_SettingsHelper_detector.md @@ -7,7 +7,7 @@ Private delegate function that detects if a setting with a given `key` exists. R ## Definition **Namespace:** CapyKit.Helpers -**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.2 +**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0 **C#** ``` C# diff --git a/Documentation/Help/F_CapyKit_Password_pbkdf2Algorithm.md b/Documentation/Help/F_CapyKit_Password_pbkdf2Algorithm.md index 6f25590..3236cd3 100644 --- a/Documentation/Help/F_CapyKit_Password_pbkdf2Algorithm.md +++ b/Documentation/Help/F_CapyKit_Password_pbkdf2Algorithm.md @@ -7,7 +7,7 @@ ## Definition **Namespace:** CapyKit -**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.2 +**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0 **C#** ``` C# diff --git a/Documentation/Help/F_CapyKit_Pbkdf2Algorithm_ITERATIONS.md b/Documentation/Help/F_CapyKit_Pbkdf2Algorithm_ITERATIONS.md index 371015f..326a4a9 100644 --- a/Documentation/Help/F_CapyKit_Pbkdf2Algorithm_ITERATIONS.md +++ b/Documentation/Help/F_CapyKit_Pbkdf2Algorithm_ITERATIONS.md @@ -7,7 +7,7 @@ The default number of iterations. ## Definition **Namespace:** CapyKit -**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.2 +**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0 **C#** ``` C# diff --git a/Documentation/Help/F_CapyKit_Pbkdf2Algorithm_LENGTH.md b/Documentation/Help/F_CapyKit_Pbkdf2Algorithm_LENGTH.md index 196b2c5..496b597 100644 --- a/Documentation/Help/F_CapyKit_Pbkdf2Algorithm_LENGTH.md +++ b/Documentation/Help/F_CapyKit_Pbkdf2Algorithm_LENGTH.md @@ -7,7 +7,7 @@ ## Definition **Namespace:** CapyKit -**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.2 +**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0 **C#** ``` C# diff --git a/Documentation/Help/F_CapyKit_PoolItem_1_index.md b/Documentation/Help/F_CapyKit_PoolItem_1_index.md index acb8a76..fd339f7 100644 --- a/Documentation/Help/F_CapyKit_PoolItem_1_index.md +++ b/Documentation/Help/F_CapyKit_PoolItem_1_index.md @@ -7,7 +7,7 @@ The zero-based index of the pooled item. ## Definition **Namespace:** CapyKit -**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.2 +**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0 **C#** ``` C# diff --git a/Documentation/Help/F_CapyKit_PoolItem_1_item.md b/Documentation/Help/F_CapyKit_PoolItem_1_item.md index ed795c9..b24426e 100644 --- a/Documentation/Help/F_CapyKit_PoolItem_1_item.md +++ b/Documentation/Help/F_CapyKit_PoolItem_1_item.md @@ -7,7 +7,7 @@ The pooled item. ## Definition **Namespace:** CapyKit -**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.2 +**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0 **C#** ``` C# diff --git a/Documentation/Help/F_CapyKit_PoolItem_1_locked.md b/Documentation/Help/F_CapyKit_PoolItem_1_locked.md index cf14bc6..d61fd4d 100644 --- a/Documentation/Help/F_CapyKit_PoolItem_1_locked.md +++ b/Documentation/Help/F_CapyKit_PoolItem_1_locked.md @@ -7,7 +7,7 @@ A flag indicating whether the item is locked or not. ## Definition **Namespace:** CapyKit -**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.2 +**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0 **C#** ``` C# diff --git a/Documentation/Help/F_CapyKit_PoolItem_1_typeName.md b/Documentation/Help/F_CapyKit_PoolItem_1_typeName.md index 87488bf..8c7d2be 100644 --- a/Documentation/Help/F_CapyKit_PoolItem_1_typeName.md +++ b/Documentation/Help/F_CapyKit_PoolItem_1_typeName.md @@ -7,7 +7,7 @@ The name of the pooled item CapyKit -**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.2 +**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0 **C#** ``` C# diff --git a/Documentation/Help/F_CapyKit_Pool_1_poolItemCollection.md b/Documentation/Help/F_CapyKit_Pool_1_poolItemCollection.md index b605351..d1adbc4 100644 --- a/Documentation/Help/F_CapyKit_Pool_1_poolItemCollection.md +++ b/Documentation/Help/F_CapyKit_Pool_1_poolItemCollection.md @@ -7,7 +7,7 @@ The collection of pooled items. ## Definition **Namespace:** CapyKit -**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.2 +**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0 **C#** ``` C# diff --git a/Documentation/Help/F_CapyKit_Pool_1_poolSize.md b/Documentation/Help/F_CapyKit_Pool_1_poolSize.md index 62d5afb..f80dc82 100644 --- a/Documentation/Help/F_CapyKit_Pool_1_poolSize.md +++ b/Documentation/Help/F_CapyKit_Pool_1_poolSize.md @@ -7,7 +7,7 @@ ## Definition **Namespace:** CapyKit -**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.2 +**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0 **C#** ``` C# diff --git a/Documentation/Help/F_CapyKit_PropertyComparer_2_expression.md b/Documentation/Help/F_CapyKit_PropertyComparer_2_expression.md index 05beb81..f672804 100644 --- a/Documentation/Help/F_CapyKit_PropertyComparer_2_expression.md +++ b/Documentation/Help/F_CapyKit_PropertyComparer_2_expression.md @@ -7,7 +7,7 @@ The expression to retrieve the property. ## Definition **Namespace:** CapyKit -**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.2 +**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0 **C#** ``` C# diff --git a/Documentation/Help/F_Tests_Helpers_SecurityHelperTests_Password.md b/Documentation/Help/F_Tests_Helpers_SecurityHelperTests_Password.md deleted file mode 100644 index 8308cae..0000000 --- a/Documentation/Help/F_Tests_Helpers_SecurityHelperTests_Password.md +++ /dev/null @@ -1,31 +0,0 @@ -# Password Field - - -\[Missing <summary> documentation for "F:Tests.Helpers.SecurityHelperTests.Password"\] - - - -## Definition -**Namespace:** Tests.Helpers -**Assembly:** Tests (in Tests.exe) Version: 1.0.0 - -**C#** -``` C# -private const string Password = "TestPassword" -``` -**F#** -``` F# -static val mutable private Password: string -``` - - - -#### Field Value -String - -## See Also - - -#### Reference -SecurityHelperTests Class -Tests.Helpers Namespace diff --git a/Documentation/Help/F_Tests_Helpers_SecurityHelperTests_Salt.md b/Documentation/Help/F_Tests_Helpers_SecurityHelperTests_Salt.md deleted file mode 100644 index f6e35c5..0000000 --- a/Documentation/Help/F_Tests_Helpers_SecurityHelperTests_Salt.md +++ /dev/null @@ -1,31 +0,0 @@ -# Salt Field - - -\[Missing <summary> documentation for "F:Tests.Helpers.SecurityHelperTests.Salt"\] - - - -## Definition -**Namespace:** Tests.Helpers -**Assembly:** Tests (in Tests.exe) Version: 1.0.0 - -**C#** -``` C# -private static readonly byte[] Salt -``` -**F#** -``` F# -static val private Salt: byte[] -``` - - - -#### Field Value -Byte[] - -## See Also - - -#### Reference -SecurityHelperTests Class -Tests.Helpers Namespace diff --git a/Documentation/Help/F_Tests_StringExtensionTests_Replacement.md b/Documentation/Help/F_Tests_StringExtensions_Replacement.md similarity index 84% rename from Documentation/Help/F_Tests_StringExtensionTests_Replacement.md rename to Documentation/Help/F_Tests_StringExtensions_Replacement.md index 81d09df..940c109 100644 --- a/Documentation/Help/F_Tests_StringExtensionTests_Replacement.md +++ b/Documentation/Help/F_Tests_StringExtensions_Replacement.md @@ -1,7 +1,7 @@ # Replacement Field -\[Missing <summary> documentation for "F:Tests.StringExtensionTests.Replacement"\] +\[Missing <summary> documentation for "F:Tests.StringExtensions.Replacement"\] @@ -27,5 +27,5 @@ static val mutable private Replacement: string #### Reference -StringExtensionTests Class +StringExtensions Class Tests Namespace diff --git a/Documentation/Help/Fields_T_Tests_Helpers_SecurityHelperTests.md b/Documentation/Help/Fields_T_Tests_Helpers_SecurityHelperTests.md deleted file mode 100644 index 254e1ac..0000000 --- a/Documentation/Help/Fields_T_Tests_Helpers_SecurityHelperTests.md +++ /dev/null @@ -1,21 +0,0 @@ -# SecurityHelperTests Fields - - - - -## Fields - - - - - - - -
Password 
Salt 
- -## See Also - - -#### Reference -SecurityHelperTests Class -Tests.Helpers Namespace diff --git a/Documentation/Help/Fields_T_Tests_StringExtensionTests.md b/Documentation/Help/Fields_T_Tests_StringExtensionTests.md deleted file mode 100644 index 69d91c2..0000000 --- a/Documentation/Help/Fields_T_Tests_StringExtensionTests.md +++ /dev/null @@ -1,18 +0,0 @@ -# StringExtensionTests Fields - - - - -## Fields - - - - -
Replacement 
- -## See Also - - -#### Reference -StringExtensionTests Class -Tests Namespace diff --git a/Documentation/Help/Fields_T_Tests_StringExtensions.md b/Documentation/Help/Fields_T_Tests_StringExtensions.md new file mode 100644 index 0000000..9bb583a --- /dev/null +++ b/Documentation/Help/Fields_T_Tests_StringExtensions.md @@ -0,0 +1,18 @@ +# StringExtensions Fields + + + + +## Fields + + + + +
Replacement 
+ +## See Also + + +#### Reference +StringExtensions Class +Tests Namespace diff --git a/Documentation/Help/Home.md b/Documentation/Help/Home.md index bbb85dd..a9b780c 100644 --- a/Documentation/Help/Home.md +++ b/Documentation/Help/Home.md @@ -1,14 +1,27 @@ # CapyKit - C# Utilities -Welcome to the official documentation for CapyKit – your go-to utility kit for boosting productivity in any .NET project. Originally born out of the *HappyCapy* project, CapyKit is now fully open for the community, offering a wide array of C# utilities and extensions. - -Whether you're looking to integrate some handy extensions into your existing project or you're exploring what CapyKit can do for your next venture, you've come to the right place! +This is a sample conceptual topic. You can use this as a starting point for adding more conceptual content to your help project. ## Getting Started -This documentation is generated directly from the source code and is constantly evolving as the project progresses. To dive in, check out the full reference material and guides in the [CapyKit Documentation](R_Project_Documentation.md). +To get started, add a documentation source to the project (a Visual Studio solution, project, or assembly and XML comments file). See the **Getting Started** topics in the Sandcastle Help File Builder's help file for more information. The following default items are included in this project: +
  • ContentLayout.content - Use the content layout file to manage the conceptual content in the project and define its layout in the table of contents.

  • -If you're new to the project, bear with us while things are still transitioning from the private repository. We're working hard to make this resource the best it can be. +The .\media folder - Place images in this folder that you will reference from conceptual content using medialLink or mediaLinkInline elements. If you will not have any images in the file, you may remove this folder.

  • -For a complete overview of the automatically generated documentation, start by exploring the [API and Utilities Reference](R_Project_Documentation.md) +The .\icons folder - This contains a default logo for the help file. You may replace it or remove it and the folder if not wanted. If removed or if you change the file name, update the Transform Args project properties page by removing or changing the filename in the logoFile transform argument. Note that unlike images referenced from conceptual topics, the logo file should have its BuildAction property set to Content.

  • + +The .\Content folder - Use this to store your conceptual topics. You may name the files and organize them however you like. One suggestion is to lay the files out on disk as you have them in the content layout file as shown in this project but the choice is yours. Files can be added via the Solution Explorer or from within the content layout file editor. Files must appear in the content layout file in order to be compiled into the help file.

+ + + + +See the **Conceptual Content** topics in the Sandcastle Help File Builder's help file for more information. See the **Sandcastle MAML Guide** for details on Microsoft Assistance Markup Language (MAML) which is used to create these topics. + + +## See Also + + +#### Other Resources +[7d36447b-0aab-4ce9-b5ed-e60ec5bee103] diff --git a/Documentation/Help/M_CapyKit_Attributes_EnumerationAttribute_1__ctor.md b/Documentation/Help/M_CapyKit_Attributes_EnumerationAttribute_1__ctor.md index 3058fa6..f99e237 100644 --- a/Documentation/Help/M_CapyKit_Attributes_EnumerationAttribute_1__ctor.md +++ b/Documentation/Help/M_CapyKit_Attributes_EnumerationAttribute_1__ctor.md @@ -7,7 +7,7 @@ Gets the value of the enumeration represented by this attribute. ## Definition **Namespace:** CapyKit.Attributes -**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.2 +**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0 **C#** ``` C# diff --git a/Documentation/Help/M_CapyKit_Attributes_EnumerationDescriptionAttribute__ctor.md b/Documentation/Help/M_CapyKit_Attributes_EnumerationDescriptionAttribute__ctor.md index 1f12a23..1ab3c06 100644 --- a/Documentation/Help/M_CapyKit_Attributes_EnumerationDescriptionAttribute__ctor.md +++ b/Documentation/Help/M_CapyKit_Attributes_EnumerationDescriptionAttribute__ctor.md @@ -7,7 +7,7 @@ Initializes a new instance of the CapyKit.Attributes -**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.2 +**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0 **C#** ``` C# diff --git a/Documentation/Help/M_CapyKit_Attributes_ValueFormatAttribute_GetFormatParameterizedString.md b/Documentation/Help/M_CapyKit_Attributes_ValueFormatAttribute_GetFormatParameterizedString.md index 46ba5ae..aaea897 100644 --- a/Documentation/Help/M_CapyKit_Attributes_ValueFormatAttribute_GetFormatParameterizedString.md +++ b/Documentation/Help/M_CapyKit_Attributes_ValueFormatAttribute_GetFormatParameterizedString.md @@ -7,7 +7,7 @@ Gets a parameterized formatted string for the specified index. ## Definition **Namespace:** CapyKit.Attributes -**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.2 +**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0 **C#** ``` C# diff --git a/Documentation/Help/M_CapyKit_Attributes_ValueFormatAttribute__ctor.md b/Documentation/Help/M_CapyKit_Attributes_ValueFormatAttribute__ctor.md index 710dfdc..75a6a45 100644 --- a/Documentation/Help/M_CapyKit_Attributes_ValueFormatAttribute__ctor.md +++ b/Documentation/Help/M_CapyKit_Attributes_ValueFormatAttribute__ctor.md @@ -7,7 +7,7 @@ Default constructor. Initializes a new instance of the CapyKit.Attributes -**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.2 +**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0 **C#** ``` C# diff --git a/Documentation/Help/M_CapyKit_Attributes_ValueFormatAttribute__ctor_1.md b/Documentation/Help/M_CapyKit_Attributes_ValueFormatAttribute__ctor_1.md index 88a3678..44acc73 100644 --- a/Documentation/Help/M_CapyKit_Attributes_ValueFormatAttribute__ctor_1.md +++ b/Documentation/Help/M_CapyKit_Attributes_ValueFormatAttribute__ctor_1.md @@ -7,7 +7,7 @@ Constructor. Initializes a new instance of the CapyKit.Attributes -**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.2 +**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0 **C#** ``` C# diff --git a/Documentation/Help/M_CapyKit_CapyEventArgs__ctor.md b/Documentation/Help/M_CapyKit_CapyEventArgs__ctor.md index 8a385f7..656358a 100644 --- a/Documentation/Help/M_CapyKit_CapyEventArgs__ctor.md +++ b/Documentation/Help/M_CapyKit_CapyEventArgs__ctor.md @@ -7,7 +7,7 @@ Initializes a new instance of the CapyEventArgs class with the specified event l ## Definition **Namespace:** CapyKit -**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.2 +**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0 **C#** ``` C# diff --git a/Documentation/Help/M_CapyKit_CapyEventReporter_EmitEvent.md b/Documentation/Help/M_CapyKit_CapyEventReporter_EmitEvent.md index 79617fa..22679d8 100644 --- a/Documentation/Help/M_CapyKit_CapyEventReporter_EmitEvent.md +++ b/Documentation/Help/M_CapyKit_CapyEventReporter_EmitEvent.md @@ -7,7 +7,7 @@ Emits an event with the given severity level, message, and method name. ## Definition **Namespace:** CapyKit -**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.2 +**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0 **C#** ``` C# diff --git a/Documentation/Help/M_CapyKit_CapyEventReporter_EmitEventOnce.md b/Documentation/Help/M_CapyKit_CapyEventReporter_EmitEventOnce.md index fb1604f..39a420c 100644 --- a/Documentation/Help/M_CapyKit_CapyEventReporter_EmitEventOnce.md +++ b/Documentation/Help/M_CapyKit_CapyEventReporter_EmitEventOnce.md @@ -7,7 +7,7 @@ Emits an event with the given severity level, message, unique identifier, and me ## Definition **Namespace:** CapyKit -**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.2 +**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0 **C#** ``` C# diff --git a/Documentation/Help/M_CapyKit_CapyEventReporter_Subscribe.md b/Documentation/Help/M_CapyKit_CapyEventReporter_Subscribe.md index 6a2667f..6b59e8f 100644 --- a/Documentation/Help/M_CapyKit_CapyEventReporter_Subscribe.md +++ b/Documentation/Help/M_CapyKit_CapyEventReporter_Subscribe.md @@ -7,7 +7,7 @@ Subscribes the specified event handler to the event with the given subscription ## Definition **Namespace:** CapyKit -**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.2 +**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0 **C#** ``` C# diff --git a/Documentation/Help/M_CapyKit_CapyEventReporter_Unsubscribe.md b/Documentation/Help/M_CapyKit_CapyEventReporter_Unsubscribe.md index f4ce1fa..9d187de 100644 --- a/Documentation/Help/M_CapyKit_CapyEventReporter_Unsubscribe.md +++ b/Documentation/Help/M_CapyKit_CapyEventReporter_Unsubscribe.md @@ -7,7 +7,7 @@ Unsubscribes the specified event handler from the event with the given origin. ## Definition **Namespace:** CapyKit -**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.2 +**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0 **C#** ``` C# diff --git a/Documentation/Help/M_CapyKit_CapyEventReporter__cctor.md b/Documentation/Help/M_CapyKit_CapyEventReporter__cctor.md index 7cfbf2a..a0a3b3b 100644 --- a/Documentation/Help/M_CapyKit_CapyEventReporter__cctor.md +++ b/Documentation/Help/M_CapyKit_CapyEventReporter__cctor.md @@ -7,7 +7,7 @@ Initializes the static fields of the Ca ## Definition **Namespace:** CapyKit -**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.2 +**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0 **C#** ``` C# diff --git a/Documentation/Help/M_CapyKit_EncryptedValue_1__ctor.md b/Documentation/Help/M_CapyKit_EncryptedValue_1__ctor.md index e66bc59..f57f350 100644 --- a/Documentation/Help/M_CapyKit_EncryptedValue_1__ctor.md +++ b/Documentation/Help/M_CapyKit_EncryptedValue_1__ctor.md @@ -7,7 +7,7 @@ Initializes a new instance of the Encryp ## Definition **Namespace:** CapyKit -**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.2 +**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0 **C#** ``` C# diff --git a/Documentation/Help/M_CapyKit_Extensions_EnumerationExtensions_GetDescription.md b/Documentation/Help/M_CapyKit_Extensions_EnumerationExtensions_GetDescription.md index 47466bb..211fda4 100644 --- a/Documentation/Help/M_CapyKit_Extensions_EnumerationExtensions_GetDescription.md +++ b/Documentation/Help/M_CapyKit_Extensions_EnumerationExtensions_GetDescription.md @@ -7,7 +7,7 @@ An CapyKit.Extensions -**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.2 +**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0 **C#** ``` C# diff --git a/Documentation/Help/M_CapyKit_Extensions_EnumerationExtensions_GetName.md b/Documentation/Help/M_CapyKit_Extensions_EnumerationExtensions_GetName.md index 3f856d4..f16b2c8 100644 --- a/Documentation/Help/M_CapyKit_Extensions_EnumerationExtensions_GetName.md +++ b/Documentation/Help/M_CapyKit_Extensions_EnumerationExtensions_GetName.md @@ -7,7 +7,7 @@ An CapyKit.Extensions -**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.2 +**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0 **C#** ``` C# diff --git a/Documentation/Help/M_CapyKit_Extensions_EnumerationExtensions_GetPrettyName.md b/Documentation/Help/M_CapyKit_Extensions_EnumerationExtensions_GetPrettyName.md index c8846d8..1d4105f 100644 --- a/Documentation/Help/M_CapyKit_Extensions_EnumerationExtensions_GetPrettyName.md +++ b/Documentation/Help/M_CapyKit_Extensions_EnumerationExtensions_GetPrettyName.md @@ -7,7 +7,7 @@ An CapyKit.Extensions -**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.2 +**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0 **C#** ``` C# diff --git a/Documentation/Help/M_CapyKit_Extensions_EnumerationExtensions_GetValue.md b/Documentation/Help/M_CapyKit_Extensions_EnumerationExtensions_GetValue.md index 2410590..bbe927e 100644 --- a/Documentation/Help/M_CapyKit_Extensions_EnumerationExtensions_GetValue.md +++ b/Documentation/Help/M_CapyKit_Extensions_EnumerationExtensions_GetValue.md @@ -7,7 +7,7 @@ An CapyKit.Extensions -**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.2 +**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0 **C#** ``` C# diff --git a/Documentation/Help/M_CapyKit_Extensions_EnumerationExtensions_Parse__1.md b/Documentation/Help/M_CapyKit_Extensions_EnumerationExtensions_Parse__1.md index 5acf6b4..4ae73ae 100644 --- a/Documentation/Help/M_CapyKit_Extensions_EnumerationExtensions_Parse__1.md +++ b/Documentation/Help/M_CapyKit_Extensions_EnumerationExtensions_Parse__1.md @@ -7,7 +7,7 @@ A *T* extension method that parses a string into an enumeration. ## Definition **Namespace:** CapyKit.Extensions -**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.2 +**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0 **C#** ``` C# diff --git a/Documentation/Help/M_CapyKit_Extensions_EnumerationExtensions_Parse__1_1.md b/Documentation/Help/M_CapyKit_Extensions_EnumerationExtensions_Parse__1_1.md index c4d41dd..4611b77 100644 --- a/Documentation/Help/M_CapyKit_Extensions_EnumerationExtensions_Parse__1_1.md +++ b/Documentation/Help/M_CapyKit_Extensions_EnumerationExtensions_Parse__1_1.md @@ -7,7 +7,7 @@ A *T* extension method that parses a string into an enumeration. ## Definition **Namespace:** CapyKit.Extensions -**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.2 +**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0 **C#** ``` C# diff --git a/Documentation/Help/M_CapyKit_Extensions_LINQExtensions_Distinct__2.md b/Documentation/Help/M_CapyKit_Extensions_LINQExtensions_Distinct__2.md index e9d861c..da320d0 100644 --- a/Documentation/Help/M_CapyKit_Extensions_LINQExtensions_Distinct__2.md +++ b/Documentation/Help/M_CapyKit_Extensions_LINQExtensions_Distinct__2.md @@ -7,7 +7,7 @@ Enumerates distinct items in this collection as defined by the key *property*. ## Definition **Namespace:** CapyKit.Extensions -**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.2 +**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0 **C#** ``` C# diff --git a/Documentation/Help/M_CapyKit_Extensions_LINQExtensions_Filter__1.md b/Documentation/Help/M_CapyKit_Extensions_LINQExtensions_Filter__1.md index d8d2b01..26f3f35 100644 --- a/Documentation/Help/M_CapyKit_Extensions_LINQExtensions_Filter__1.md +++ b/Documentation/Help/M_CapyKit_Extensions_LINQExtensions_Filter__1.md @@ -7,7 +7,7 @@ Filters out items matching a *predicate* from the collection. ## Definition **Namespace:** CapyKit.Extensions -**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.2 +**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0 **C#** ``` C# diff --git a/Documentation/Help/M_CapyKit_Extensions_LINQExtensions_Filter__1_1.md b/Documentation/Help/M_CapyKit_Extensions_LINQExtensions_Filter__1_1.md index f2b5cb9..abbaccf 100644 --- a/Documentation/Help/M_CapyKit_Extensions_LINQExtensions_Filter__1_1.md +++ b/Documentation/Help/M_CapyKit_Extensions_LINQExtensions_Filter__1_1.md @@ -7,7 +7,7 @@ Filters out items matching a *predicate* from the collection. ## Definition **Namespace:** CapyKit.Extensions -**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.2 +**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0 **C#** ``` C# diff --git a/Documentation/Help/M_CapyKit_Extensions_LINQExtensions_LeftOuterJoin__4.md b/Documentation/Help/M_CapyKit_Extensions_LINQExtensions_LeftOuterJoin__4.md index 36abaf3..ed67780 100644 --- a/Documentation/Help/M_CapyKit_Extensions_LINQExtensions_LeftOuterJoin__4.md +++ b/Documentation/Help/M_CapyKit_Extensions_LINQExtensions_LeftOuterJoin__4.md @@ -7,7 +7,7 @@ An IEnumable<T> extension method that left outer join. ## Definition **Namespace:** CapyKit.Extensions -**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.2 +**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0 **C#** ``` C# diff --git a/Documentation/Help/M_CapyKit_Extensions_LINQExtensions_LeftOuterJoin__4_1.md b/Documentation/Help/M_CapyKit_Extensions_LINQExtensions_LeftOuterJoin__4_1.md index cc20bc0..8be52b5 100644 --- a/Documentation/Help/M_CapyKit_Extensions_LINQExtensions_LeftOuterJoin__4_1.md +++ b/Documentation/Help/M_CapyKit_Extensions_LINQExtensions_LeftOuterJoin__4_1.md @@ -7,7 +7,7 @@ An IQueryable<T> extension method that left outer join. ## Definition **Namespace:** CapyKit.Extensions -**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.2 +**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0 **C#** ``` C# diff --git a/Documentation/Help/M_CapyKit_Extensions_LINQExtensions_LeftOuterJoin__4_2.md b/Documentation/Help/M_CapyKit_Extensions_LINQExtensions_LeftOuterJoin__4_2.md index 718ebb4..0fab33a 100644 --- a/Documentation/Help/M_CapyKit_Extensions_LINQExtensions_LeftOuterJoin__4_2.md +++ b/Documentation/Help/M_CapyKit_Extensions_LINQExtensions_LeftOuterJoin__4_2.md @@ -7,7 +7,7 @@ An IQueryable<T> extension method that left outer join. ## Definition **Namespace:** CapyKit.Extensions -**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.2 +**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0 **C#** ``` C# diff --git a/Documentation/Help/M_CapyKit_Extensions_LINQExtensions_PageCount__1.md b/Documentation/Help/M_CapyKit_Extensions_LINQExtensions_PageCount__1.md index 8662316..d4dad69 100644 --- a/Documentation/Help/M_CapyKit_Extensions_LINQExtensions_PageCount__1.md +++ b/Documentation/Help/M_CapyKit_Extensions_LINQExtensions_PageCount__1.md @@ -7,7 +7,7 @@ The number of pages of *pageSize* size in the given collection. ## Definition **Namespace:** CapyKit.Extensions -**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.2 +**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0 **C#** ``` C# diff --git a/Documentation/Help/M_CapyKit_Extensions_LINQExtensions_PageCount__1_1.md b/Documentation/Help/M_CapyKit_Extensions_LINQExtensions_PageCount__1_1.md index b415adb..7cc6bec 100644 --- a/Documentation/Help/M_CapyKit_Extensions_LINQExtensions_PageCount__1_1.md +++ b/Documentation/Help/M_CapyKit_Extensions_LINQExtensions_PageCount__1_1.md @@ -7,7 +7,7 @@ The number of pages of *pageSize* size in the given collection. ## Definition **Namespace:** CapyKit.Extensions -**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.2 +**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0 **C#** ``` C# diff --git a/Documentation/Help/M_CapyKit_Extensions_LINQExtensions_Page__1.md b/Documentation/Help/M_CapyKit_Extensions_LINQExtensions_Page__1.md index 75b1743..74df094 100644 --- a/Documentation/Help/M_CapyKit_Extensions_LINQExtensions_Page__1.md +++ b/Documentation/Help/M_CapyKit_Extensions_LINQExtensions_Page__1.md @@ -7,7 +7,7 @@ Get a page of items from a collection, skipping *pageNumber* pages of *pageSize* ## Definition **Namespace:** CapyKit.Extensions -**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.2 +**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0 **C#** ``` C# diff --git a/Documentation/Help/M_CapyKit_Extensions_LINQExtensions_Page__1_1.md b/Documentation/Help/M_CapyKit_Extensions_LINQExtensions_Page__1_1.md index 080f06e..7f35261 100644 --- a/Documentation/Help/M_CapyKit_Extensions_LINQExtensions_Page__1_1.md +++ b/Documentation/Help/M_CapyKit_Extensions_LINQExtensions_Page__1_1.md @@ -7,7 +7,7 @@ Get a page of items from a collection, skipping *pageNumber* pages of *pageSize* ## Definition **Namespace:** CapyKit.Extensions -**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.2 +**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0 **C#** ``` C# diff --git a/Documentation/Help/M_CapyKit_Extensions_StringExtensions_IfNullOrEmpty.md b/Documentation/Help/M_CapyKit_Extensions_StringExtensions_IfNullOrEmpty.md index 8dc972f..00b6d31 100644 --- a/Documentation/Help/M_CapyKit_Extensions_StringExtensions_IfNullOrEmpty.md +++ b/Documentation/Help/M_CapyKit_Extensions_StringExtensions_IfNullOrEmpty.md @@ -7,7 +7,7 @@ Replaces a null or empty string with a specified replacement string. ## Definition **Namespace:** CapyKit.Extensions -**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.2 +**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0 **C#** ``` C# diff --git a/Documentation/Help/M_CapyKit_Extensions_StringExtensions_IfNullOrWhiteSpace.md b/Documentation/Help/M_CapyKit_Extensions_StringExtensions_IfNullOrWhiteSpace.md index db44c57..b9224b0 100644 --- a/Documentation/Help/M_CapyKit_Extensions_StringExtensions_IfNullOrWhiteSpace.md +++ b/Documentation/Help/M_CapyKit_Extensions_StringExtensions_IfNullOrWhiteSpace.md @@ -7,7 +7,7 @@ Replaces a null or whitespace string with a specified replacement string. ## Definition **Namespace:** CapyKit.Extensions -**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.2 +**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0 **C#** ``` C# diff --git a/Documentation/Help/M_CapyKit_Helpers_CalculationHelper_CalculateHash.md b/Documentation/Help/M_CapyKit_Helpers_CalculationHelper_CalculateHash.md index 9a7223b..8b2a0dc 100644 --- a/Documentation/Help/M_CapyKit_Helpers_CalculationHelper_CalculateHash.md +++ b/Documentation/Help/M_CapyKit_Helpers_CalculationHelper_CalculateHash.md @@ -7,7 +7,7 @@ Calculates the hash of a given string using an CapyKit.Helpers -**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.2 +**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0 **C#** ``` C# diff --git a/Documentation/Help/M_CapyKit_Helpers_CalculationHelper_CalculateHexHash.md b/Documentation/Help/M_CapyKit_Helpers_CalculationHelper_CalculateHexHash.md index 2deba62..07ce2a8 100644 --- a/Documentation/Help/M_CapyKit_Helpers_CalculationHelper_CalculateHexHash.md +++ b/Documentation/Help/M_CapyKit_Helpers_CalculationHelper_CalculateHexHash.md @@ -7,7 +7,7 @@ Calculates the hexadecimal hash. ## Definition **Namespace:** CapyKit.Helpers -**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.2 +**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0 **C#** ``` C# diff --git a/Documentation/Help/M_CapyKit_Helpers_CalculationHelper_DegreesToRadians.md b/Documentation/Help/M_CapyKit_Helpers_CalculationHelper_DegreesToRadians.md index 0adda4b..3cd35c2 100644 --- a/Documentation/Help/M_CapyKit_Helpers_CalculationHelper_DegreesToRadians.md +++ b/Documentation/Help/M_CapyKit_Helpers_CalculationHelper_DegreesToRadians.md @@ -7,7 +7,7 @@ Convers degrees to radians. ## Definition **Namespace:** CapyKit.Helpers -**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.2 +**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0 **C#** ``` C# diff --git a/Documentation/Help/M_CapyKit_Helpers_CalculationHelper_GetDistance.md b/Documentation/Help/M_CapyKit_Helpers_CalculationHelper_GetDistance.md index 073b882..50937a3 100644 --- a/Documentation/Help/M_CapyKit_Helpers_CalculationHelper_GetDistance.md +++ b/Documentation/Help/M_CapyKit_Helpers_CalculationHelper_GetDistance.md @@ -7,7 +7,7 @@ Gets the distance between two points on earth using the `haversine` formula. ## Definition **Namespace:** CapyKit.Helpers -**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.2 +**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0 **C#** ``` C# diff --git a/Documentation/Help/M_CapyKit_Helpers_CalculationHelper_GetDistance_1.md b/Documentation/Help/M_CapyKit_Helpers_CalculationHelper_GetDistance_1.md index 5b5c15b..bff9246 100644 --- a/Documentation/Help/M_CapyKit_Helpers_CalculationHelper_GetDistance_1.md +++ b/Documentation/Help/M_CapyKit_Helpers_CalculationHelper_GetDistance_1.md @@ -7,7 +7,7 @@ Gets the distance between two points on earth using the `haversine` formula. ## Definition **Namespace:** CapyKit.Helpers -**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.2 +**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0 **C#** ``` C# diff --git a/Documentation/Help/M_CapyKit_Helpers_CalculationHelper_KilometersToMiles.md b/Documentation/Help/M_CapyKit_Helpers_CalculationHelper_KilometersToMiles.md index cae0b20..da17e87 100644 --- a/Documentation/Help/M_CapyKit_Helpers_CalculationHelper_KilometersToMiles.md +++ b/Documentation/Help/M_CapyKit_Helpers_CalculationHelper_KilometersToMiles.md @@ -7,7 +7,7 @@ Converts kilometers to miles. ## Definition **Namespace:** CapyKit.Helpers -**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.2 +**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0 **C#** ``` C# diff --git a/Documentation/Help/M_CapyKit_Helpers_CalculationHelper_MilesToKilometers.md b/Documentation/Help/M_CapyKit_Helpers_CalculationHelper_MilesToKilometers.md index f47e184..fc87480 100644 --- a/Documentation/Help/M_CapyKit_Helpers_CalculationHelper_MilesToKilometers.md +++ b/Documentation/Help/M_CapyKit_Helpers_CalculationHelper_MilesToKilometers.md @@ -7,7 +7,7 @@ Converts miles to kilometers. ## Definition **Namespace:** CapyKit.Helpers -**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.2 +**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0 **C#** ``` C# diff --git a/Documentation/Help/M_CapyKit_Helpers_CalculationHelper_RadiansToDegrees.md b/Documentation/Help/M_CapyKit_Helpers_CalculationHelper_RadiansToDegrees.md index ff988ad..f7ce870 100644 --- a/Documentation/Help/M_CapyKit_Helpers_CalculationHelper_RadiansToDegrees.md +++ b/Documentation/Help/M_CapyKit_Helpers_CalculationHelper_RadiansToDegrees.md @@ -7,7 +7,7 @@ Converts radians to degrees. ## Definition **Namespace:** CapyKit.Helpers -**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.2 +**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0 **C#** ``` C# diff --git a/Documentation/Help/M_CapyKit_Helpers_CompressionHelper_Compress.md b/Documentation/Help/M_CapyKit_Helpers_CompressionHelper_Compress.md index a1a298b..a4e5adf 100644 --- a/Documentation/Help/M_CapyKit_Helpers_CompressionHelper_Compress.md +++ b/Documentation/Help/M_CapyKit_Helpers_CompressionHelper_Compress.md @@ -7,7 +7,7 @@ Compresses a given object using the `gzip` algorithm. ## Definition **Namespace:** CapyKit.Helpers -**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.2 +**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0 **C#** ``` C# diff --git a/Documentation/Help/M_CapyKit_Helpers_CompressionHelper_CompressToString.md b/Documentation/Help/M_CapyKit_Helpers_CompressionHelper_CompressToString.md index 82af704..88a27fe 100644 --- a/Documentation/Help/M_CapyKit_Helpers_CompressionHelper_CompressToString.md +++ b/Documentation/Help/M_CapyKit_Helpers_CompressionHelper_CompressToString.md @@ -7,7 +7,7 @@ Compresses a given object to a string using `base64` encoding of `gzip` format. ## Definition **Namespace:** CapyKit.Helpers -**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.2 +**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0 **C#** ``` C# diff --git a/Documentation/Help/M_CapyKit_Helpers_CompressionHelper_DecompressToString.md b/Documentation/Help/M_CapyKit_Helpers_CompressionHelper_DecompressToString.md index 8e9cc24..69d1481 100644 --- a/Documentation/Help/M_CapyKit_Helpers_CompressionHelper_DecompressToString.md +++ b/Documentation/Help/M_CapyKit_Helpers_CompressionHelper_DecompressToString.md @@ -7,7 +7,7 @@ Decompresses the given `base64` string in `gzip` format. ## Definition **Namespace:** CapyKit.Helpers -**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.2 +**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0 **C#** ``` C# diff --git a/Documentation/Help/M_CapyKit_Helpers_CompressionHelper_Decompress__1.md b/Documentation/Help/M_CapyKit_Helpers_CompressionHelper_Decompress__1.md index 3234969..8be696a 100644 --- a/Documentation/Help/M_CapyKit_Helpers_CompressionHelper_Decompress__1.md +++ b/Documentation/Help/M_CapyKit_Helpers_CompressionHelper_Decompress__1.md @@ -7,7 +7,7 @@ Decompresses a given compressed `gzip` byte stream. ## Definition **Namespace:** CapyKit.Helpers -**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.2 +**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0 **C#** ``` C# diff --git a/Documentation/Help/M_CapyKit_Helpers_CompressionHelper_Decompress__1_1.md b/Documentation/Help/M_CapyKit_Helpers_CompressionHelper_Decompress__1_1.md index b6bcb4f..70f07f8 100644 --- a/Documentation/Help/M_CapyKit_Helpers_CompressionHelper_Decompress__1_1.md +++ b/Documentation/Help/M_CapyKit_Helpers_CompressionHelper_Decompress__1_1.md @@ -7,7 +7,7 @@ Decompresses a given `base64` encoded string of `gzip` format. ## Definition **Namespace:** CapyKit.Helpers -**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.2 +**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0 **C#** ``` C# diff --git a/Documentation/Help/M_CapyKit_Helpers_EncryptionHelper__ctor.md b/Documentation/Help/M_CapyKit_Helpers_EncryptionHelper__ctor.md index 9c041c3..bbc467d 100644 --- a/Documentation/Help/M_CapyKit_Helpers_EncryptionHelper__ctor.md +++ b/Documentation/Help/M_CapyKit_Helpers_EncryptionHelper__ctor.md @@ -7,7 +7,7 @@ Initializes a new instance of the CapyKit.Helpers -**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.2 +**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0 **C#** ``` C# diff --git a/Documentation/Help/M_CapyKit_Helpers_IEncryptionAlgorithm_Decrypt__1.md b/Documentation/Help/M_CapyKit_Helpers_IEncryptionAlgorithm_Decrypt__1.md index 6837732..55fbaaa 100644 --- a/Documentation/Help/M_CapyKit_Helpers_IEncryptionAlgorithm_Decrypt__1.md +++ b/Documentation/Help/M_CapyKit_Helpers_IEncryptionAlgorithm_Decrypt__1.md @@ -7,7 +7,7 @@ ## Definition **Namespace:** CapyKit.Helpers -**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.2 +**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0 **C#** ``` C# diff --git a/Documentation/Help/M_CapyKit_Helpers_IEncryptionAlgorithm_Encrypt__1.md b/Documentation/Help/M_CapyKit_Helpers_IEncryptionAlgorithm_Encrypt__1.md index d6eb039..f60d5e9 100644 --- a/Documentation/Help/M_CapyKit_Helpers_IEncryptionAlgorithm_Encrypt__1.md +++ b/Documentation/Help/M_CapyKit_Helpers_IEncryptionAlgorithm_Encrypt__1.md @@ -7,7 +7,7 @@ ## Definition **Namespace:** CapyKit.Helpers -**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.2 +**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0 **C#** ``` C# diff --git a/Documentation/Help/M_CapyKit_Helpers_LanguageHelper_CamelCaseToHumanReadable.md b/Documentation/Help/M_CapyKit_Helpers_LanguageHelper_CamelCaseToHumanReadable.md index 12791be..1f96a5e 100644 --- a/Documentation/Help/M_CapyKit_Helpers_LanguageHelper_CamelCaseToHumanReadable.md +++ b/Documentation/Help/M_CapyKit_Helpers_LanguageHelper_CamelCaseToHumanReadable.md @@ -7,7 +7,7 @@ Converts camel case text to human readable text. ## Definition **Namespace:** CapyKit.Helpers -**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.2 +**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0 **C#** ``` C# diff --git a/Documentation/Help/M_CapyKit_Helpers_LanguageHelper__ctor.md b/Documentation/Help/M_CapyKit_Helpers_LanguageHelper__ctor.md index 6dd041e..f2e125c 100644 --- a/Documentation/Help/M_CapyKit_Helpers_LanguageHelper__ctor.md +++ b/Documentation/Help/M_CapyKit_Helpers_LanguageHelper__ctor.md @@ -7,7 +7,7 @@ Initializes a new instance of the ## Definition **Namespace:** CapyKit.Helpers -**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.2 +**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0 **C#** ``` C# diff --git a/Documentation/Help/M_CapyKit_Helpers_SecurityHelper_CompareHashedPassword.md b/Documentation/Help/M_CapyKit_Helpers_SecurityHelper_CompareHashedPassword.md index e50e486..17b8413 100644 --- a/Documentation/Help/M_CapyKit_Helpers_SecurityHelper_CompareHashedPassword.md +++ b/Documentation/Help/M_CapyKit_Helpers_SecurityHelper_CompareHashedPassword.md @@ -7,7 +7,7 @@ Compares an unencrypted *password* with a stored, encrypted *existingPassword*. ## Definition **Namespace:** CapyKit.Helpers -**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.2 +**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0 **C#** ``` C# diff --git a/Documentation/Help/M_CapyKit_Helpers_SecurityHelper_CompareHashedPassword__1.md b/Documentation/Help/M_CapyKit_Helpers_SecurityHelper_CompareHashedPassword__1.md index 20805ec..a7e17bc 100644 --- a/Documentation/Help/M_CapyKit_Helpers_SecurityHelper_CompareHashedPassword__1.md +++ b/Documentation/Help/M_CapyKit_Helpers_SecurityHelper_CompareHashedPassword__1.md @@ -7,7 +7,7 @@ Compares an unencrypted *password* with a stored, encrypted *existingPassword*. ## Definition **Namespace:** CapyKit.Helpers -**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.2 +**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0 **C#** ``` C# diff --git a/Documentation/Help/M_CapyKit_Helpers_SecurityHelper_CompareSessionID.md b/Documentation/Help/M_CapyKit_Helpers_SecurityHelper_CompareSessionID.md index 2abfa63..1f3d688 100644 --- a/Documentation/Help/M_CapyKit_Helpers_SecurityHelper_CompareSessionID.md +++ b/Documentation/Help/M_CapyKit_Helpers_SecurityHelper_CompareSessionID.md @@ -7,7 +7,7 @@ Compares two session identifiers. ## Definition **Namespace:** CapyKit.Helpers -**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.2 +**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0 **C#** ``` C# diff --git a/Documentation/Help/M_CapyKit_Helpers_SecurityHelper_CompareStrings.md b/Documentation/Help/M_CapyKit_Helpers_SecurityHelper_CompareStrings.md index 4cda0e2..9b26c4a 100644 --- a/Documentation/Help/M_CapyKit_Helpers_SecurityHelper_CompareStrings.md +++ b/Documentation/Help/M_CapyKit_Helpers_SecurityHelper_CompareStrings.md @@ -7,7 +7,7 @@ Compare two strings as case sensative. ## Definition **Namespace:** CapyKit.Helpers -**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.2 +**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0 **C#** ``` C# diff --git a/Documentation/Help/M_CapyKit_Helpers_SecurityHelper_GetPassword__1.md b/Documentation/Help/M_CapyKit_Helpers_SecurityHelper_GetPassword__1.md index d8a08b4..685c41b 100644 --- a/Documentation/Help/M_CapyKit_Helpers_SecurityHelper_GetPassword__1.md +++ b/Documentation/Help/M_CapyKit_Helpers_SecurityHelper_GetPassword__1.md @@ -7,7 +7,7 @@ Retrieves a Password object using the specif ## Definition **Namespace:** CapyKit.Helpers -**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.2 +**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0 **C#** ``` C# diff --git a/Documentation/Help/M_CapyKit_Helpers_SecurityHelper_GetPassword__1_1.md b/Documentation/Help/M_CapyKit_Helpers_SecurityHelper_GetPassword__1_1.md index 6d3af4f..8f16d4c 100644 --- a/Documentation/Help/M_CapyKit_Helpers_SecurityHelper_GetPassword__1_1.md +++ b/Documentation/Help/M_CapyKit_Helpers_SecurityHelper_GetPassword__1_1.md @@ -7,7 +7,7 @@ Retrieves a Password object using the specif ## Definition **Namespace:** CapyKit.Helpers -**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.2 +**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0 **C#** ``` C# diff --git a/Documentation/Help/M_CapyKit_Helpers_SecurityHelper_GetRandomBytes.md b/Documentation/Help/M_CapyKit_Helpers_SecurityHelper_GetRandomBytes.md index 596978f..6732430 100644 --- a/Documentation/Help/M_CapyKit_Helpers_SecurityHelper_GetRandomBytes.md +++ b/Documentation/Help/M_CapyKit_Helpers_SecurityHelper_GetRandomBytes.md @@ -7,7 +7,7 @@ Generates a new byte array of the specified length with random values. ## Definition **Namespace:** CapyKit.Helpers -**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.2 +**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0 **C#** ``` C# diff --git a/Documentation/Help/M_CapyKit_Helpers_SecurityHelper_GetRandomPassword.md b/Documentation/Help/M_CapyKit_Helpers_SecurityHelper_GetRandomPassword.md index 3cd8b12..1cacbdc 100644 --- a/Documentation/Help/M_CapyKit_Helpers_SecurityHelper_GetRandomPassword.md +++ b/Documentation/Help/M_CapyKit_Helpers_SecurityHelper_GetRandomPassword.md @@ -7,7 +7,7 @@ Gets a cryptographically strong random password. ## Definition **Namespace:** CapyKit.Helpers -**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.2 +**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0 **C#** ``` C# diff --git a/Documentation/Help/M_CapyKit_Helpers_SecurityHelper_GetRandomString.md b/Documentation/Help/M_CapyKit_Helpers_SecurityHelper_GetRandomString.md index 0dfe8ed..490598d 100644 --- a/Documentation/Help/M_CapyKit_Helpers_SecurityHelper_GetRandomString.md +++ b/Documentation/Help/M_CapyKit_Helpers_SecurityHelper_GetRandomString.md @@ -7,7 +7,7 @@ A convenience method to generate a random string of the specified length using a ## Definition **Namespace:** CapyKit.Helpers -**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.2 +**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0 **C#** ``` C# diff --git a/Documentation/Help/M_CapyKit_Helpers_SecurityHelper_GetRandomString_1.md b/Documentation/Help/M_CapyKit_Helpers_SecurityHelper_GetRandomString_1.md index afcb575..c815580 100644 --- a/Documentation/Help/M_CapyKit_Helpers_SecurityHelper_GetRandomString_1.md +++ b/Documentation/Help/M_CapyKit_Helpers_SecurityHelper_GetRandomString_1.md @@ -7,7 +7,7 @@ Gets a cryptographically strong random string using the character values found i ## Definition **Namespace:** CapyKit.Helpers -**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.2 +**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0 **C#** ``` C# diff --git a/Documentation/Help/M_CapyKit_Helpers_SecurityHelper_GetSalt.md b/Documentation/Help/M_CapyKit_Helpers_SecurityHelper_GetSalt.md deleted file mode 100644 index dc91e1d..0000000 --- a/Documentation/Help/M_CapyKit_Helpers_SecurityHelper_GetSalt.md +++ /dev/null @@ -1,45 +0,0 @@ -# GetSalt Method - - -Generates a random byte array that can act as a salt. - - - -## Definition -**Namespace:** CapyKit.Helpers -**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.2 - -**C#** -``` C# -public static byte[] GetSalt( - int length = 32 -) -``` -**F#** -``` F# -static member GetSalt : - ?length : int -(* Defaults: - let _length = defaultArg length 32 -*) --> byte[] -``` - - - -#### Parameters -
  Int32  (Optional)
(Optional) The desired length of the generated byte array.
- -#### Return Value -Byte[] -An array of byte. - -## Remarks -A default length of SALT_SIZE is provided as a sane default. Larger values can be used for increased entropy. - -## See Also - - -#### Reference -SecurityHelper Class -CapyKit.Helpers Namespace diff --git a/Documentation/Help/M_CapyKit_Helpers_SecurityHelper_GetValidCharacterComposition.md b/Documentation/Help/M_CapyKit_Helpers_SecurityHelper_GetValidCharacterComposition.md index 8e77c2b..98d4b9d 100644 --- a/Documentation/Help/M_CapyKit_Helpers_SecurityHelper_GetValidCharacterComposition.md +++ b/Documentation/Help/M_CapyKit_Helpers_SecurityHelper_GetValidCharacterComposition.md @@ -7,7 +7,7 @@ Static method that returns a valid character composition based on the given Vali ## Definition **Namespace:** CapyKit.Helpers -**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.2 +**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0 **C#** ``` C# diff --git a/Documentation/Help/M_CapyKit_Helpers_SecurityHelper_Pbkdf2.md b/Documentation/Help/M_CapyKit_Helpers_SecurityHelper_Pbkdf2.md index 48d9aff..68ef968 100644 --- a/Documentation/Help/M_CapyKit_Helpers_SecurityHelper_Pbkdf2.md +++ b/Documentation/Help/M_CapyKit_Helpers_SecurityHelper_Pbkdf2.md @@ -7,7 +7,7 @@ Generates a new Password object using the PB ## Definition **Namespace:** CapyKit.Helpers -**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.2 +**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0 **C#** ``` C# diff --git a/Documentation/Help/M_CapyKit_Helpers_SecurityHelper_Pbkdf2_1.md b/Documentation/Help/M_CapyKit_Helpers_SecurityHelper_Pbkdf2_1.md index e098c9a..d6e1a6d 100644 --- a/Documentation/Help/M_CapyKit_Helpers_SecurityHelper_Pbkdf2_1.md +++ b/Documentation/Help/M_CapyKit_Helpers_SecurityHelper_Pbkdf2_1.md @@ -7,7 +7,7 @@ Generates a new Password object using the PB ## Definition **Namespace:** CapyKit.Helpers -**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.2 +**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0 **C#** ``` C# diff --git a/Documentation/Help/M_CapyKit_Helpers_SecurityHelper__ctor.md b/Documentation/Help/M_CapyKit_Helpers_SecurityHelper__ctor.md index c48ebfe..50dd73e 100644 --- a/Documentation/Help/M_CapyKit_Helpers_SecurityHelper__ctor.md +++ b/Documentation/Help/M_CapyKit_Helpers_SecurityHelper__ctor.md @@ -7,7 +7,7 @@ Initializes a new instance of the ## Definition **Namespace:** CapyKit.Helpers -**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.2 +**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0 **C#** ``` C# diff --git a/Documentation/Help/M_CapyKit_Helpers_SerializationHelper_Deserialize__1.md b/Documentation/Help/M_CapyKit_Helpers_SerializationHelper_Deserialize__1.md index ff8c810..4166924 100644 --- a/Documentation/Help/M_CapyKit_Helpers_SerializationHelper_Deserialize__1.md +++ b/Documentation/Help/M_CapyKit_Helpers_SerializationHelper_Deserialize__1.md @@ -7,7 +7,7 @@ Deserializes an object to a given *T* type. ## Definition **Namespace:** CapyKit.Helpers -**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.2 +**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0 **C#** ``` C# diff --git a/Documentation/Help/M_CapyKit_Helpers_SerializationHelper_Deserialize__1_1.md b/Documentation/Help/M_CapyKit_Helpers_SerializationHelper_Deserialize__1_1.md index c2cf48a..39db726 100644 --- a/Documentation/Help/M_CapyKit_Helpers_SerializationHelper_Deserialize__1_1.md +++ b/Documentation/Help/M_CapyKit_Helpers_SerializationHelper_Deserialize__1_1.md @@ -7,7 +7,7 @@ Deserializes an object to a given *T* type. ## Definition **Namespace:** CapyKit.Helpers -**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.2 +**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0 **C#** ``` C# diff --git a/Documentation/Help/M_CapyKit_Helpers_SerializationHelper_Deserialize__1_2.md b/Documentation/Help/M_CapyKit_Helpers_SerializationHelper_Deserialize__1_2.md index 543602d..c5dbe5b 100644 --- a/Documentation/Help/M_CapyKit_Helpers_SerializationHelper_Deserialize__1_2.md +++ b/Documentation/Help/M_CapyKit_Helpers_SerializationHelper_Deserialize__1_2.md @@ -7,7 +7,7 @@ Deserializes a `JSON` encoded string to the given *T*. ## Definition **Namespace:** CapyKit.Helpers -**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.2 +**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0 **C#** ``` C# diff --git a/Documentation/Help/M_CapyKit_Helpers_SerializationHelper_SerializeToBytes.md b/Documentation/Help/M_CapyKit_Helpers_SerializationHelper_SerializeToBytes.md index 394d9c1..e948224 100644 --- a/Documentation/Help/M_CapyKit_Helpers_SerializationHelper_SerializeToBytes.md +++ b/Documentation/Help/M_CapyKit_Helpers_SerializationHelper_SerializeToBytes.md @@ -7,7 +7,7 @@ Serializes an object to a byte array. ## Definition **Namespace:** CapyKit.Helpers -**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.2 +**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0 **C#** ``` C# diff --git a/Documentation/Help/M_CapyKit_Helpers_SerializationHelper_SerializeToString.md b/Documentation/Help/M_CapyKit_Helpers_SerializationHelper_SerializeToString.md index f522e7d..6e122c4 100644 --- a/Documentation/Help/M_CapyKit_Helpers_SerializationHelper_SerializeToString.md +++ b/Documentation/Help/M_CapyKit_Helpers_SerializationHelper_SerializeToString.md @@ -7,7 +7,7 @@ Serializes an object to a `JSON` encoded string. ## Definition **Namespace:** CapyKit.Helpers -**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.2 +**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0 **C#** ``` C# diff --git a/Documentation/Help/M_CapyKit_Helpers_SettingsHelper_GetApplicationSetting__1.md b/Documentation/Help/M_CapyKit_Helpers_SettingsHelper_GetApplicationSetting__1.md index 99cf26c..bd34ef8 100644 --- a/Documentation/Help/M_CapyKit_Helpers_SettingsHelper_GetApplicationSetting__1.md +++ b/Documentation/Help/M_CapyKit_Helpers_SettingsHelper_GetApplicationSetting__1.md @@ -7,7 +7,7 @@ Retrieves a setting with the given `key`. ## Definition **Namespace:** CapyKit.Helpers -**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.2 +**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0 **C#** ``` C# diff --git a/Documentation/Help/M_CapyKit_Helpers_SettingsHelper_SetAccessorMethod.md b/Documentation/Help/M_CapyKit_Helpers_SettingsHelper_SetAccessorMethod.md index cc6dc07..a8a075a 100644 --- a/Documentation/Help/M_CapyKit_Helpers_SettingsHelper_SetAccessorMethod.md +++ b/Documentation/Help/M_CapyKit_Helpers_SettingsHelper_SetAccessorMethod.md @@ -7,7 +7,7 @@ Sets the function used to retrieve application settings. ## Definition **Namespace:** CapyKit.Helpers -**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.2 +**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0 **C#** ``` C# diff --git a/Documentation/Help/M_CapyKit_Helpers_SettingsHelper_SetDetectorMethod.md b/Documentation/Help/M_CapyKit_Helpers_SettingsHelper_SetDetectorMethod.md index c073c12..b20ea0a 100644 --- a/Documentation/Help/M_CapyKit_Helpers_SettingsHelper_SetDetectorMethod.md +++ b/Documentation/Help/M_CapyKit_Helpers_SettingsHelper_SetDetectorMethod.md @@ -7,7 +7,7 @@ Sets the function used to detect if an application setting with a given `key` ex ## Definition **Namespace:** CapyKit.Helpers -**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.2 +**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0 **C#** ``` C# diff --git a/Documentation/Help/M_CapyKit_Helpers_SettingsHelper__cctor.md b/Documentation/Help/M_CapyKit_Helpers_SettingsHelper__cctor.md index 5cce33b..be3366c 100644 --- a/Documentation/Help/M_CapyKit_Helpers_SettingsHelper__cctor.md +++ b/Documentation/Help/M_CapyKit_Helpers_SettingsHelper__cctor.md @@ -7,7 +7,7 @@ Initializes the static fields of the CapyKit.Helpers -**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.2 +**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0 **C#** ``` C# diff --git a/Documentation/Help/M_CapyKit_IPasswordAlgorithm_Compare.md b/Documentation/Help/M_CapyKit_IPasswordAlgorithm_Compare.md index 6ea73b7..e41d3a4 100644 --- a/Documentation/Help/M_CapyKit_IPasswordAlgorithm_Compare.md +++ b/Documentation/Help/M_CapyKit_IPasswordAlgorithm_Compare.md @@ -7,7 +7,7 @@ Compares the given plaintext password with an encrypted value using PBKDF2 algor ## Definition **Namespace:** CapyKit -**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.2 +**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0 **C#** ``` C# diff --git a/Documentation/Help/M_CapyKit_IPasswordAlgorithm_Encrypt.md b/Documentation/Help/M_CapyKit_IPasswordAlgorithm_Encrypt.md index 86d5ed7..f131f35 100644 --- a/Documentation/Help/M_CapyKit_IPasswordAlgorithm_Encrypt.md +++ b/Documentation/Help/M_CapyKit_IPasswordAlgorithm_Encrypt.md @@ -7,7 +7,7 @@ Encrypts the given password using a defined algorithm. ## Definition **Namespace:** CapyKit -**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.2 +**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0 **C#** ``` C# diff --git a/Documentation/Help/M_CapyKit_Password_Equals.md b/Documentation/Help/M_CapyKit_Password_Equals.md index 050eb2b..70e01ee 100644 --- a/Documentation/Help/M_CapyKit_Password_Equals.md +++ b/Documentation/Help/M_CapyKit_Password_Equals.md @@ -7,7 +7,7 @@ Determines whether the specified object is equal to the current object. ## Definition **Namespace:** CapyKit -**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.2 +**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0 **C#** ``` C# diff --git a/Documentation/Help/M_CapyKit_Password_ToString.md b/Documentation/Help/M_CapyKit_Password_ToString.md index 6a44542..f5f96ae 100644 --- a/Documentation/Help/M_CapyKit_Password_ToString.md +++ b/Documentation/Help/M_CapyKit_Password_ToString.md @@ -7,7 +7,7 @@ Returns a string that represents the current object. ## Definition **Namespace:** CapyKit -**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.2 +**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0 **C#** ``` C# diff --git a/Documentation/Help/M_CapyKit_Password__cctor.md b/Documentation/Help/M_CapyKit_Password__cctor.md index 4f93361..9a69166 100644 --- a/Documentation/Help/M_CapyKit_Password__cctor.md +++ b/Documentation/Help/M_CapyKit_Password__cctor.md @@ -7,7 +7,7 @@ Initializes the static fields of the PasswordCapyKit -**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.2 +**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0 **C#** ``` C# diff --git a/Documentation/Help/M_CapyKit_Password__ctor.md b/Documentation/Help/M_CapyKit_Password__ctor.md index 992a922..ba77be7 100644 --- a/Documentation/Help/M_CapyKit_Password__ctor.md +++ b/Documentation/Help/M_CapyKit_Password__ctor.md @@ -7,7 +7,7 @@ Constructor. ## Definition **Namespace:** CapyKit -**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.2 +**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0 **C#** ``` C# diff --git a/Documentation/Help/M_CapyKit_Password_op_Equality.md b/Documentation/Help/M_CapyKit_Password_op_Equality.md index b45b0c0..3147058 100644 --- a/Documentation/Help/M_CapyKit_Password_op_Equality.md +++ b/Documentation/Help/M_CapyKit_Password_op_Equality.md @@ -7,7 +7,7 @@ ## Definition **Namespace:** CapyKit -**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.2 +**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0 **C#** ``` C# diff --git a/Documentation/Help/M_CapyKit_Password_op_Inequality.md b/Documentation/Help/M_CapyKit_Password_op_Inequality.md index b42b208..05c7af3 100644 --- a/Documentation/Help/M_CapyKit_Password_op_Inequality.md +++ b/Documentation/Help/M_CapyKit_Password_op_Inequality.md @@ -7,7 +7,7 @@ ## Definition **Namespace:** CapyKit -**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.2 +**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0 **C#** ``` C# diff --git a/Documentation/Help/M_CapyKit_Pbkdf2Algorithm_Encrypt.md b/Documentation/Help/M_CapyKit_Pbkdf2Algorithm_Encrypt.md index 73e056c..51f2469 100644 --- a/Documentation/Help/M_CapyKit_Pbkdf2Algorithm_Encrypt.md +++ b/Documentation/Help/M_CapyKit_Pbkdf2Algorithm_Encrypt.md @@ -7,7 +7,7 @@ Encrypts the given password using a PBKDF2 algorithm. ## Definition **Namespace:** CapyKit -**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.2 +**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0 **C#** ``` C# diff --git a/Documentation/Help/M_CapyKit_Pbkdf2Algorithm__ctor.md b/Documentation/Help/M_CapyKit_Pbkdf2Algorithm__ctor.md index 1ad9e1c..2e28fef 100644 --- a/Documentation/Help/M_CapyKit_Pbkdf2Algorithm__ctor.md +++ b/Documentation/Help/M_CapyKit_Pbkdf2Algorithm__ctor.md @@ -7,7 +7,7 @@ Initializes a new instance of the Pbkdf2A ## Definition **Namespace:** CapyKit -**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.2 +**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0 **C#** ``` C# diff --git a/Documentation/Help/M_CapyKit_PoolItem_1_ReleaseLock.md b/Documentation/Help/M_CapyKit_PoolItem_1_ReleaseLock.md index 91f8e2b..bdb9d54 100644 --- a/Documentation/Help/M_CapyKit_PoolItem_1_ReleaseLock.md +++ b/Documentation/Help/M_CapyKit_PoolItem_1_ReleaseLock.md @@ -7,7 +7,7 @@ Releases the lock on the item. ## Definition **Namespace:** CapyKit -**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.2 +**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0 **C#** ``` C# diff --git a/Documentation/Help/M_CapyKit_PoolItem_1_SetLock.md b/Documentation/Help/M_CapyKit_PoolItem_1_SetLock.md index 490ed62..b93cb85 100644 --- a/Documentation/Help/M_CapyKit_PoolItem_1_SetLock.md +++ b/Documentation/Help/M_CapyKit_PoolItem_1_SetLock.md @@ -7,7 +7,7 @@ Sets the lock on the item indicating that it is in use. ## Definition **Namespace:** CapyKit -**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.2 +**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0 **C#** ``` C# diff --git a/Documentation/Help/M_CapyKit_PoolItem_1_ToString.md b/Documentation/Help/M_CapyKit_PoolItem_1_ToString.md index af2d95c..6737239 100644 --- a/Documentation/Help/M_CapyKit_PoolItem_1_ToString.md +++ b/Documentation/Help/M_CapyKit_PoolItem_1_ToString.md @@ -7,7 +7,7 @@ Returns a string that represents the current object and its lock state. ## Definition **Namespace:** CapyKit -**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.2 +**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0 **C#** ``` C# diff --git a/Documentation/Help/M_CapyKit_PoolItem_1__ctor.md b/Documentation/Help/M_CapyKit_PoolItem_1__ctor.md index d736af2..841e7f3 100644 --- a/Documentation/Help/M_CapyKit_PoolItem_1__ctor.md +++ b/Documentation/Help/M_CapyKit_PoolItem_1__ctor.md @@ -7,7 +7,7 @@ Initializes a new instance of the PoolItem(T)< ## Definition **Namespace:** CapyKit -**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.2 +**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0 **C#** ``` C# diff --git a/Documentation/Help/M_CapyKit_Pool_1_FillPoolItemCollection.md b/Documentation/Help/M_CapyKit_Pool_1_FillPoolItemCollection.md index 76648ed..cf2d166 100644 --- a/Documentation/Help/M_CapyKit_Pool_1_FillPoolItemCollection.md +++ b/Documentation/Help/M_CapyKit_Pool_1_FillPoolItemCollection.md @@ -7,7 +7,7 @@ Fill the pool item collection from an existing *T* collection. ## Definition **Namespace:** CapyKit -**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.2 +**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0 **C#** ``` C# diff --git a/Documentation/Help/M_CapyKit_Pool_1_FillPoolItemCollection_1.md b/Documentation/Help/M_CapyKit_Pool_1_FillPoolItemCollection_1.md index b3f8c3c..1ef506f 100644 --- a/Documentation/Help/M_CapyKit_Pool_1_FillPoolItemCollection_1.md +++ b/Documentation/Help/M_CapyKit_Pool_1_FillPoolItemCollection_1.md @@ -7,7 +7,7 @@ Initializes the pool with the specified number of items using the default constr ## Definition **Namespace:** CapyKit -**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.2 +**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0 **C#** ``` C# diff --git a/Documentation/Help/M_CapyKit_Pool_1_FillPoolItemCollection_2.md b/Documentation/Help/M_CapyKit_Pool_1_FillPoolItemCollection_2.md index e0508f7..21a7d62 100644 --- a/Documentation/Help/M_CapyKit_Pool_1_FillPoolItemCollection_2.md +++ b/Documentation/Help/M_CapyKit_Pool_1_FillPoolItemCollection_2.md @@ -7,7 +7,7 @@ Initializes the pool with the specified number of items using the specified cons ## Definition **Namespace:** CapyKit -**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.2 +**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0 **C#** ``` C# diff --git a/Documentation/Help/M_CapyKit_Pool_1_GetAvailableItem.md b/Documentation/Help/M_CapyKit_Pool_1_GetAvailableItem.md index 7708a49..2fc7a2e 100644 --- a/Documentation/Help/M_CapyKit_Pool_1_GetAvailableItem.md +++ b/Documentation/Help/M_CapyKit_Pool_1_GetAvailableItem.md @@ -7,7 +7,7 @@ Gets the first available item from the pool and sets its lock. ## Definition **Namespace:** CapyKit -**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.2 +**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0 **C#** ``` C# diff --git a/Documentation/Help/M_CapyKit_Pool_1_ReleaseItem.md b/Documentation/Help/M_CapyKit_Pool_1_ReleaseItem.md index 4c80142..cea70f3 100644 --- a/Documentation/Help/M_CapyKit_Pool_1_ReleaseItem.md +++ b/Documentation/Help/M_CapyKit_Pool_1_ReleaseItem.md @@ -7,7 +7,7 @@ Releases the lock on the specified item and returns it to the pool. ## Definition **Namespace:** CapyKit -**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.2 +**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0 **C#** ``` C# diff --git a/Documentation/Help/M_CapyKit_Pool_1__ctor.md b/Documentation/Help/M_CapyKit_Pool_1__ctor.md index d94cd4f..24d6908 100644 --- a/Documentation/Help/M_CapyKit_Pool_1__ctor.md +++ b/Documentation/Help/M_CapyKit_Pool_1__ctor.md @@ -7,7 +7,7 @@ Initializes a new instance of the Pool(T) clas ## Definition **Namespace:** CapyKit -**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.2 +**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0 **C#** ``` C# diff --git a/Documentation/Help/M_CapyKit_Pool_1__ctor_1.md b/Documentation/Help/M_CapyKit_Pool_1__ctor_1.md index 975f1fe..133e3d0 100644 --- a/Documentation/Help/M_CapyKit_Pool_1__ctor_1.md +++ b/Documentation/Help/M_CapyKit_Pool_1__ctor_1.md @@ -7,7 +7,7 @@ Initializes a new instance of the Pool(T) clas ## Definition **Namespace:** CapyKit -**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.2 +**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0 **C#** ``` C# diff --git a/Documentation/Help/M_CapyKit_Pool_1__ctor_2.md b/Documentation/Help/M_CapyKit_Pool_1__ctor_2.md index 030ba0e..2c1956d 100644 --- a/Documentation/Help/M_CapyKit_Pool_1__ctor_2.md +++ b/Documentation/Help/M_CapyKit_Pool_1__ctor_2.md @@ -7,7 +7,7 @@ Initializes a new instance of the Pool(T) clas ## Definition **Namespace:** CapyKit -**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.2 +**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0 **C#** ``` C# diff --git a/Documentation/Help/M_CapyKit_PropertyComparer_2_Equals.md b/Documentation/Help/M_CapyKit_PropertyComparer_2_Equals.md index 426638d..0fbf47f 100644 --- a/Documentation/Help/M_CapyKit_PropertyComparer_2_Equals.md +++ b/Documentation/Help/M_CapyKit_PropertyComparer_2_Equals.md @@ -7,7 +7,7 @@ Determines whether the specified properties are equal. ## Definition **Namespace:** CapyKit -**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.2 +**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0 **C#** ``` C# diff --git a/Documentation/Help/M_CapyKit_PropertyComparer_2_GetHashCode.md b/Documentation/Help/M_CapyKit_PropertyComparer_2_GetHashCode.md index 4ea0e0f..bd016c3 100644 --- a/Documentation/Help/M_CapyKit_PropertyComparer_2_GetHashCode.md +++ b/Documentation/Help/M_CapyKit_PropertyComparer_2_GetHashCode.md @@ -7,7 +7,7 @@ Returns a hash code for the specified object. ## Definition **Namespace:** CapyKit -**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.2 +**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0 **C#** ``` C# diff --git a/Documentation/Help/M_CapyKit_PropertyComparer_2__ctor.md b/Documentation/Help/M_CapyKit_PropertyComparer_2__ctor.md index 338da86..c638f6f 100644 --- a/Documentation/Help/M_CapyKit_PropertyComparer_2__ctor.md +++ b/Documentation/Help/M_CapyKit_PropertyComparer_2__ctor.md @@ -7,7 +7,7 @@ Constructor. ## Definition **Namespace:** CapyKit -**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.2 +**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0 **C#** ``` C# diff --git a/Documentation/Help/M_Tests_Helpers_SecurityHelperTests_CompareHashedPassword_WithDifferentPassword_ShouldReturnFalse.md b/Documentation/Help/M_Tests_Helpers_SecurityHelperTests_CompareHashedPassword_WithDifferentPassword_ShouldReturnFalse.md deleted file mode 100644 index 0f73c48..0000000 --- a/Documentation/Help/M_Tests_Helpers_SecurityHelperTests_CompareHashedPassword_WithDifferentPassword_ShouldReturnFalse.md +++ /dev/null @@ -1,30 +0,0 @@ -# CompareHashedPassword_WithDifferentPassword_ShouldReturnFalse Method - - -\[Missing <summary> documentation for "M:Tests.Helpers.SecurityHelperTests.CompareHashedPassword_WithDifferentPassword_ShouldReturnFalse"\] - - - -## Definition -**Namespace:** Tests.Helpers -**Assembly:** Tests (in Tests.exe) Version: 1.0.0 - -**C#** -``` C# -[TestAttribute] -public void CompareHashedPassword_WithDifferentPassword_ShouldReturnFalse() -``` -**F#** -``` F# -[] -member CompareHashedPassword_WithDifferentPassword_ShouldReturnFalse : unit -> unit -``` - - - -## See Also - - -#### Reference -SecurityHelperTests Class -Tests.Helpers Namespace diff --git a/Documentation/Help/M_Tests_Helpers_SecurityHelperTests_CompareHashedPassword_WithSamePassword_ShouldReturnTrue.md b/Documentation/Help/M_Tests_Helpers_SecurityHelperTests_CompareHashedPassword_WithSamePassword_ShouldReturnTrue.md deleted file mode 100644 index 599a9f1..0000000 --- a/Documentation/Help/M_Tests_Helpers_SecurityHelperTests_CompareHashedPassword_WithSamePassword_ShouldReturnTrue.md +++ /dev/null @@ -1,30 +0,0 @@ -# CompareHashedPassword_WithSamePassword_ShouldReturnTrue Method - - -\[Missing <summary> documentation for "M:Tests.Helpers.SecurityHelperTests.CompareHashedPassword_WithSamePassword_ShouldReturnTrue"\] - - - -## Definition -**Namespace:** Tests.Helpers -**Assembly:** Tests (in Tests.exe) Version: 1.0.0 - -**C#** -``` C# -[TestAttribute] -public void CompareHashedPassword_WithSamePassword_ShouldReturnTrue() -``` -**F#** -``` F# -[] -member CompareHashedPassword_WithSamePassword_ShouldReturnTrue : unit -> unit -``` - - - -## See Also - - -#### Reference -SecurityHelperTests Class -Tests.Helpers Namespace diff --git a/Documentation/Help/M_Tests_Helpers_SecurityHelperTests_CompareSessionID_WithDifferentSessionIDs_ShouldReturnFalse.md b/Documentation/Help/M_Tests_Helpers_SecurityHelperTests_CompareSessionID_WithDifferentSessionIDs_ShouldReturnFalse.md deleted file mode 100644 index f774c96..0000000 --- a/Documentation/Help/M_Tests_Helpers_SecurityHelperTests_CompareSessionID_WithDifferentSessionIDs_ShouldReturnFalse.md +++ /dev/null @@ -1,30 +0,0 @@ -# CompareSessionID_WithDifferentSessionIDs_ShouldReturnFalse Method - - -\[Missing <summary> documentation for "M:Tests.Helpers.SecurityHelperTests.CompareSessionID_WithDifferentSessionIDs_ShouldReturnFalse"\] - - - -## Definition -**Namespace:** Tests.Helpers -**Assembly:** Tests (in Tests.exe) Version: 1.0.0 - -**C#** -``` C# -[TestAttribute] -public void CompareSessionID_WithDifferentSessionIDs_ShouldReturnFalse() -``` -**F#** -``` F# -[] -member CompareSessionID_WithDifferentSessionIDs_ShouldReturnFalse : unit -> unit -``` - - - -## See Also - - -#### Reference -SecurityHelperTests Class -Tests.Helpers Namespace diff --git a/Documentation/Help/M_Tests_Helpers_SecurityHelperTests_CompareSessionID_WithSameSessionIDs_ShouldReturnTrue.md b/Documentation/Help/M_Tests_Helpers_SecurityHelperTests_CompareSessionID_WithSameSessionIDs_ShouldReturnTrue.md deleted file mode 100644 index 0eb5a9f..0000000 --- a/Documentation/Help/M_Tests_Helpers_SecurityHelperTests_CompareSessionID_WithSameSessionIDs_ShouldReturnTrue.md +++ /dev/null @@ -1,30 +0,0 @@ -# CompareSessionID_WithSameSessionIDs_ShouldReturnTrue Method - - -\[Missing <summary> documentation for "M:Tests.Helpers.SecurityHelperTests.CompareSessionID_WithSameSessionIDs_ShouldReturnTrue"\] - - - -## Definition -**Namespace:** Tests.Helpers -**Assembly:** Tests (in Tests.exe) Version: 1.0.0 - -**C#** -``` C# -[TestAttribute] -public void CompareSessionID_WithSameSessionIDs_ShouldReturnTrue() -``` -**F#** -``` F# -[] -member CompareSessionID_WithSameSessionIDs_ShouldReturnTrue : unit -> unit -``` - - - -## See Also - - -#### Reference -SecurityHelperTests Class -Tests.Helpers Namespace diff --git a/Documentation/Help/M_Tests_Helpers_SecurityHelperTests_GetRandomPassword_ShouldReturnStringOfGivenLength.md b/Documentation/Help/M_Tests_Helpers_SecurityHelperTests_GetRandomPassword_ShouldReturnStringOfGivenLength.md deleted file mode 100644 index 31cccb9..0000000 --- a/Documentation/Help/M_Tests_Helpers_SecurityHelperTests_GetRandomPassword_ShouldReturnStringOfGivenLength.md +++ /dev/null @@ -1,30 +0,0 @@ -# GetRandomPassword_ShouldReturnStringOfGivenLength Method - - -\[Missing <summary> documentation for "M:Tests.Helpers.SecurityHelperTests.GetRandomPassword_ShouldReturnStringOfGivenLength"\] - - - -## Definition -**Namespace:** Tests.Helpers -**Assembly:** Tests (in Tests.exe) Version: 1.0.0 - -**C#** -``` C# -[TestAttribute] -public void GetRandomPassword_ShouldReturnStringOfGivenLength() -``` -**F#** -``` F# -[] -member GetRandomPassword_ShouldReturnStringOfGivenLength : unit -> unit -``` - - - -## See Also - - -#### Reference -SecurityHelperTests Class -Tests.Helpers Namespace diff --git a/Documentation/Help/M_Tests_Helpers_SecurityHelperTests_GetRandomString_ShouldReturnStringOfGivenLength.md b/Documentation/Help/M_Tests_Helpers_SecurityHelperTests_GetRandomString_ShouldReturnStringOfGivenLength.md deleted file mode 100644 index d59df49..0000000 --- a/Documentation/Help/M_Tests_Helpers_SecurityHelperTests_GetRandomString_ShouldReturnStringOfGivenLength.md +++ /dev/null @@ -1,30 +0,0 @@ -# GetRandomString_ShouldReturnStringOfGivenLength Method - - -\[Missing <summary> documentation for "M:Tests.Helpers.SecurityHelperTests.GetRandomString_ShouldReturnStringOfGivenLength"\] - - - -## Definition -**Namespace:** Tests.Helpers -**Assembly:** Tests (in Tests.exe) Version: 1.0.0 - -**C#** -``` C# -[TestAttribute] -public void GetRandomString_ShouldReturnStringOfGivenLength() -``` -**F#** -``` F# -[] -member GetRandomString_ShouldReturnStringOfGivenLength : unit -> unit -``` - - - -## See Also - - -#### Reference -SecurityHelperTests Class -Tests.Helpers Namespace diff --git a/Documentation/Help/M_Tests_Helpers_SecurityHelperTests_Pbkdf2_WithSamePasswordAndSalt_ShouldReturnSameHash.md b/Documentation/Help/M_Tests_Helpers_SecurityHelperTests_Pbkdf2_WithSamePasswordAndSalt_ShouldReturnSameHash.md deleted file mode 100644 index a9c035d..0000000 --- a/Documentation/Help/M_Tests_Helpers_SecurityHelperTests_Pbkdf2_WithSamePasswordAndSalt_ShouldReturnSameHash.md +++ /dev/null @@ -1,30 +0,0 @@ -# Pbkdf2_WithSamePasswordAndSalt_ShouldReturnSameHash Method - - -\[Missing <summary> documentation for "M:Tests.Helpers.SecurityHelperTests.Pbkdf2_WithSamePasswordAndSalt_ShouldReturnSameHash"\] - - - -## Definition -**Namespace:** Tests.Helpers -**Assembly:** Tests (in Tests.exe) Version: 1.0.0 - -**C#** -``` C# -[TestAttribute] -public void Pbkdf2_WithSamePasswordAndSalt_ShouldReturnSameHash() -``` -**F#** -``` F# -[] -member Pbkdf2_WithSamePasswordAndSalt_ShouldReturnSameHash : unit -> unit -``` - - - -## See Also - - -#### Reference -SecurityHelperTests Class -Tests.Helpers Namespace diff --git a/Documentation/Help/M_Tests_Helpers_SecurityHelperTests__cctor.md b/Documentation/Help/M_Tests_Helpers_SecurityHelperTests__cctor.md deleted file mode 100644 index 9815d60..0000000 --- a/Documentation/Help/M_Tests_Helpers_SecurityHelperTests__cctor.md +++ /dev/null @@ -1,28 +0,0 @@ -# SecurityHelperTests Constructor - - -Initializes the static fields of the SecurityHelperTests class - - - -## Definition -**Namespace:** Tests.Helpers -**Assembly:** Tests (in Tests.exe) Version: 1.0.0 - -**C#** -``` C# -static SecurityHelperTests() -``` -**F#** -``` F# -new : unit -> SecurityHelperTests -``` - - - -## See Also - - -#### Reference -SecurityHelperTests Class -Tests.Helpers Namespace diff --git a/Documentation/Help/M_Tests_Helpers_SecurityHelperTests__ctor.md b/Documentation/Help/M_Tests_Helpers_SecurityHelperTests__ctor.md deleted file mode 100644 index 9b7ac23..0000000 --- a/Documentation/Help/M_Tests_Helpers_SecurityHelperTests__ctor.md +++ /dev/null @@ -1,28 +0,0 @@ -# SecurityHelperTests Constructor - - -Initializes a new instance of the SecurityHelperTests class - - - -## Definition -**Namespace:** Tests.Helpers -**Assembly:** Tests (in Tests.exe) Version: 1.0.0 - -**C#** -``` C# -public SecurityHelperTests() -``` -**F#** -``` F# -new : unit -> SecurityHelperTests -``` - - - -## See Also - - -#### Reference -SecurityHelperTests Class -Tests.Helpers Namespace diff --git a/Documentation/Help/M_Tests_PasswordTests_GenerateSalt.md b/Documentation/Help/M_Tests_Passwords_PasswordTests_GenerateSalt.md similarity index 67% rename from Documentation/Help/M_Tests_PasswordTests_GenerateSalt.md rename to Documentation/Help/M_Tests_Passwords_PasswordTests_GenerateSalt.md index b68629f..dd14d06 100644 --- a/Documentation/Help/M_Tests_PasswordTests_GenerateSalt.md +++ b/Documentation/Help/M_Tests_Passwords_PasswordTests_GenerateSalt.md @@ -1,7 +1,7 @@ # GenerateSalt Method -\[Missing <summary> documentation for "M:Tests.PasswordTests.GenerateSalt(System.Int32)"\] +\[Missing <summary> documentation for "M:Tests.Passwords.PasswordTests.GenerateSalt(System.Int32)"\] @@ -28,15 +28,15 @@ private static member GenerateSalt : #### Parameters -
  Int32  (Optional)
\[Missing <param name="size"/> documentation for "M:Tests.PasswordTests.GenerateSalt(System.Int32)"\]
+
  Int32  (Optional)
\[Missing <param name="size"/> documentation for "M:Tests.Passwords.PasswordTests.GenerateSalt(System.Int32)"\]
#### Return Value Byte[] -\[Missing <returns> documentation for "M:Tests.PasswordTests.GenerateSalt(System.Int32)"\] +\[Missing <returns> documentation for "M:Tests.Passwords.PasswordTests.GenerateSalt(System.Int32)"\] ## See Also #### Reference -PasswordTests Class +Passwords.PasswordTests Class Tests Namespace diff --git a/Documentation/Help/M_Tests_PasswordTests_PasswordCreation_WithInvalidSalt_ReturnsEmptyHash.md b/Documentation/Help/M_Tests_Passwords_PasswordTests_PasswordCreation_WithInvalidSalt_ReturnsEmptyHash.md similarity index 68% rename from Documentation/Help/M_Tests_PasswordTests_PasswordCreation_WithInvalidSalt_ReturnsEmptyHash.md rename to Documentation/Help/M_Tests_Passwords_PasswordTests_PasswordCreation_WithInvalidSalt_ReturnsEmptyHash.md index 65fc80d..19b88a5 100644 --- a/Documentation/Help/M_Tests_PasswordTests_PasswordCreation_WithInvalidSalt_ReturnsEmptyHash.md +++ b/Documentation/Help/M_Tests_Passwords_PasswordTests_PasswordCreation_WithInvalidSalt_ReturnsEmptyHash.md @@ -1,7 +1,7 @@ # PasswordCreation_WithInvalidSalt_ReturnsEmptyHash Method -\[Missing <summary> documentation for "M:Tests.PasswordTests.PasswordCreation_WithInvalidSalt_ReturnsEmptyHash"\] +\[Missing <summary> documentation for "M:Tests.Passwords.PasswordTests.PasswordCreation_WithInvalidSalt_ReturnsEmptyHash"\] @@ -26,5 +26,5 @@ member PasswordCreation_WithInvalidSalt_ReturnsEmptyHash : unit -> unit #### Reference -PasswordTests Class +Passwords.PasswordTests Class Tests Namespace diff --git a/Documentation/Help/M_Tests_PasswordTests_PasswordCreation_WithPbkdf2Algorithm_CreatesValidHash.md b/Documentation/Help/M_Tests_Passwords_PasswordTests_PasswordCreation_WithPbkdf2Algorithm_CreatesValidHash.md similarity index 68% rename from Documentation/Help/M_Tests_PasswordTests_PasswordCreation_WithPbkdf2Algorithm_CreatesValidHash.md rename to Documentation/Help/M_Tests_Passwords_PasswordTests_PasswordCreation_WithPbkdf2Algorithm_CreatesValidHash.md index 31cf50a..a812512 100644 --- a/Documentation/Help/M_Tests_PasswordTests_PasswordCreation_WithPbkdf2Algorithm_CreatesValidHash.md +++ b/Documentation/Help/M_Tests_Passwords_PasswordTests_PasswordCreation_WithPbkdf2Algorithm_CreatesValidHash.md @@ -1,7 +1,7 @@ # PasswordCreation_WithPbkdf2Algorithm_CreatesValidHash Method -\[Missing <summary> documentation for "M:Tests.PasswordTests.PasswordCreation_WithPbkdf2Algorithm_CreatesValidHash"\] +\[Missing <summary> documentation for "M:Tests.Passwords.PasswordTests.PasswordCreation_WithPbkdf2Algorithm_CreatesValidHash"\] @@ -26,5 +26,5 @@ member PasswordCreation_WithPbkdf2Algorithm_CreatesValidHash : unit -> unit #### Reference -PasswordTests Class +Passwords.PasswordTests Class Tests Namespace diff --git a/Documentation/Help/M_Tests_PasswordTests_PasswordEquality_DifferentPasswords_AreNotEqual.md b/Documentation/Help/M_Tests_Passwords_PasswordTests_PasswordEquality_DifferentPasswords_AreNotEqual.md similarity index 68% rename from Documentation/Help/M_Tests_PasswordTests_PasswordEquality_DifferentPasswords_AreNotEqual.md rename to Documentation/Help/M_Tests_Passwords_PasswordTests_PasswordEquality_DifferentPasswords_AreNotEqual.md index da890c5..1112f63 100644 --- a/Documentation/Help/M_Tests_PasswordTests_PasswordEquality_DifferentPasswords_AreNotEqual.md +++ b/Documentation/Help/M_Tests_Passwords_PasswordTests_PasswordEquality_DifferentPasswords_AreNotEqual.md @@ -1,7 +1,7 @@ # PasswordEquality_DifferentPasswords_AreNotEqual Method -\[Missing <summary> documentation for "M:Tests.PasswordTests.PasswordEquality_DifferentPasswords_AreNotEqual"\] +\[Missing <summary> documentation for "M:Tests.Passwords.PasswordTests.PasswordEquality_DifferentPasswords_AreNotEqual"\] @@ -26,5 +26,5 @@ member PasswordEquality_DifferentPasswords_AreNotEqual : unit -> unit #### Reference -PasswordTests Class +Passwords.PasswordTests Class Tests Namespace diff --git a/Documentation/Help/M_Tests_PasswordTests_PasswordEquality_DifferentSalts_AreNotEqual.md b/Documentation/Help/M_Tests_Passwords_PasswordTests_PasswordEquality_DifferentSalts_AreNotEqual.md similarity index 68% rename from Documentation/Help/M_Tests_PasswordTests_PasswordEquality_DifferentSalts_AreNotEqual.md rename to Documentation/Help/M_Tests_Passwords_PasswordTests_PasswordEquality_DifferentSalts_AreNotEqual.md index 78ce648..83356b3 100644 --- a/Documentation/Help/M_Tests_PasswordTests_PasswordEquality_DifferentSalts_AreNotEqual.md +++ b/Documentation/Help/M_Tests_Passwords_PasswordTests_PasswordEquality_DifferentSalts_AreNotEqual.md @@ -1,7 +1,7 @@ # PasswordEquality_DifferentSalts_AreNotEqual Method -\[Missing <summary> documentation for "M:Tests.PasswordTests.PasswordEquality_DifferentSalts_AreNotEqual"\] +\[Missing <summary> documentation for "M:Tests.Passwords.PasswordTests.PasswordEquality_DifferentSalts_AreNotEqual"\] @@ -26,5 +26,5 @@ member PasswordEquality_DifferentSalts_AreNotEqual : unit -> unit #### Reference -PasswordTests Class +Passwords.PasswordTests Class Tests Namespace diff --git a/Documentation/Help/M_Tests_PasswordTests_PasswordEquality_SamePasswordAndSalt_AreEqual.md b/Documentation/Help/M_Tests_Passwords_PasswordTests_PasswordEquality_SamePasswordAndSalt_AreEqual.md similarity index 68% rename from Documentation/Help/M_Tests_PasswordTests_PasswordEquality_SamePasswordAndSalt_AreEqual.md rename to Documentation/Help/M_Tests_Passwords_PasswordTests_PasswordEquality_SamePasswordAndSalt_AreEqual.md index 575896e..f1d5c29 100644 --- a/Documentation/Help/M_Tests_PasswordTests_PasswordEquality_SamePasswordAndSalt_AreEqual.md +++ b/Documentation/Help/M_Tests_Passwords_PasswordTests_PasswordEquality_SamePasswordAndSalt_AreEqual.md @@ -1,7 +1,7 @@ # PasswordEquality_SamePasswordAndSalt_AreEqual Method -\[Missing <summary> documentation for "M:Tests.PasswordTests.PasswordEquality_SamePasswordAndSalt_AreEqual"\] +\[Missing <summary> documentation for "M:Tests.Passwords.PasswordTests.PasswordEquality_SamePasswordAndSalt_AreEqual"\] @@ -26,5 +26,5 @@ member PasswordEquality_SamePasswordAndSalt_AreEqual : unit -> unit #### Reference -PasswordTests Class +Passwords.PasswordTests Class Tests Namespace diff --git a/Documentation/Help/M_Tests_PasswordTests_ToString_ReturnsCorrectFormat.md b/Documentation/Help/M_Tests_Passwords_PasswordTests_ToString_ReturnsCorrectFormat.md similarity index 67% rename from Documentation/Help/M_Tests_PasswordTests_ToString_ReturnsCorrectFormat.md rename to Documentation/Help/M_Tests_Passwords_PasswordTests_ToString_ReturnsCorrectFormat.md index 0d797d1..24355f7 100644 --- a/Documentation/Help/M_Tests_PasswordTests_ToString_ReturnsCorrectFormat.md +++ b/Documentation/Help/M_Tests_Passwords_PasswordTests_ToString_ReturnsCorrectFormat.md @@ -1,7 +1,7 @@ # ToString_ReturnsCorrectFormat Method -\[Missing <summary> documentation for "M:Tests.PasswordTests.ToString_ReturnsCorrectFormat"\] +\[Missing <summary> documentation for "M:Tests.Passwords.PasswordTests.ToString_ReturnsCorrectFormat"\] @@ -26,5 +26,5 @@ member ToString_ReturnsCorrectFormat : unit -> unit #### Reference -PasswordTests Class +Passwords.PasswordTests Class Tests Namespace diff --git a/Documentation/Help/M_Tests_PasswordTests__ctor.md b/Documentation/Help/M_Tests_Passwords_PasswordTests__ctor.md similarity index 54% rename from Documentation/Help/M_Tests_PasswordTests__ctor.md rename to Documentation/Help/M_Tests_Passwords_PasswordTests__ctor.md index 1f0ed39..70cc68e 100644 --- a/Documentation/Help/M_Tests_PasswordTests__ctor.md +++ b/Documentation/Help/M_Tests_Passwords_PasswordTests__ctor.md @@ -1,7 +1,7 @@ -# PasswordTests Constructor +# Passwords.PasswordTests Constructor -Initializes a new instance of the PasswordTests class +Initializes a new instance of the Passwords.PasswordTests class @@ -24,5 +24,5 @@ new : unit -> PasswordTests #### Reference -PasswordTests Class +Passwords.PasswordTests Class Tests Namespace diff --git a/Documentation/Help/M_Tests_Passwords__ctor.md b/Documentation/Help/M_Tests_Passwords__ctor.md new file mode 100644 index 0000000..305febf --- /dev/null +++ b/Documentation/Help/M_Tests_Passwords__ctor.md @@ -0,0 +1,28 @@ +# Passwords Constructor + + +Initializes a new instance of the Passwords class + + + +## Definition +**Namespace:** Tests +**Assembly:** Tests (in Tests.exe) Version: 1.0.0 + +**C#** +``` C# +public Passwords() +``` +**F#** +``` F# +new : unit -> Passwords +``` + + + +## See Also + + +#### Reference +Passwords Class +Tests Namespace diff --git a/Documentation/Help/M_Tests_StringExtensionTests_IfNullOrEmpty_ShouldReturnOriginalStringWhenValueIsNotNullNorEmpty.md b/Documentation/Help/M_Tests_StringExtensions_IfNullOrEmpty_ShouldReturnOriginalStringWhenValueIsNotNullNorEmpty.md similarity index 75% rename from Documentation/Help/M_Tests_StringExtensionTests_IfNullOrEmpty_ShouldReturnOriginalStringWhenValueIsNotNullNorEmpty.md rename to Documentation/Help/M_Tests_StringExtensions_IfNullOrEmpty_ShouldReturnOriginalStringWhenValueIsNotNullNorEmpty.md index d4254c0..f279893 100644 --- a/Documentation/Help/M_Tests_StringExtensionTests_IfNullOrEmpty_ShouldReturnOriginalStringWhenValueIsNotNullNorEmpty.md +++ b/Documentation/Help/M_Tests_StringExtensions_IfNullOrEmpty_ShouldReturnOriginalStringWhenValueIsNotNullNorEmpty.md @@ -1,7 +1,7 @@ # IfNullOrEmpty_ShouldReturnOriginalStringWhenValueIsNotNullNorEmpty Method -\[Missing <summary> documentation for "M:Tests.StringExtensionTests.IfNullOrEmpty_ShouldReturnOriginalStringWhenValueIsNotNullNorEmpty(System.String)"\] +\[Missing <summary> documentation for "M:Tests.StringExtensions.IfNullOrEmpty_ShouldReturnOriginalStringWhenValueIsNotNullNorEmpty(System.String)"\] @@ -28,11 +28,11 @@ member IfNullOrEmpty_ShouldReturnOriginalStringWhenValueIsNotNullNorEmpty : #### Parameters -
  String
\[Missing <param name="value"/> documentation for "M:Tests.StringExtensionTests.IfNullOrEmpty_ShouldReturnOriginalStringWhenValueIsNotNullNorEmpty(System.String)"\]
+
  String
\[Missing <param name="value"/> documentation for "M:Tests.StringExtensions.IfNullOrEmpty_ShouldReturnOriginalStringWhenValueIsNotNullNorEmpty(System.String)"\]
## See Also #### Reference -StringExtensionTests Class +StringExtensions Class Tests Namespace diff --git a/Documentation/Help/M_Tests_StringExtensionTests_IfNullOrEmpty_ShouldReturnReplacementWhenValueIsNullOrEmpty.md b/Documentation/Help/M_Tests_StringExtensions_IfNullOrEmpty_ShouldReturnReplacementWhenValueIsNullOrEmpty.md similarity index 74% rename from Documentation/Help/M_Tests_StringExtensionTests_IfNullOrEmpty_ShouldReturnReplacementWhenValueIsNullOrEmpty.md rename to Documentation/Help/M_Tests_StringExtensions_IfNullOrEmpty_ShouldReturnReplacementWhenValueIsNullOrEmpty.md index a13a1b8..8f92590 100644 --- a/Documentation/Help/M_Tests_StringExtensionTests_IfNullOrEmpty_ShouldReturnReplacementWhenValueIsNullOrEmpty.md +++ b/Documentation/Help/M_Tests_StringExtensions_IfNullOrEmpty_ShouldReturnReplacementWhenValueIsNullOrEmpty.md @@ -1,7 +1,7 @@ # IfNullOrEmpty_ShouldReturnReplacementWhenValueIsNullOrEmpty Method -\[Missing <summary> documentation for "M:Tests.StringExtensionTests.IfNullOrEmpty_ShouldReturnReplacementWhenValueIsNullOrEmpty(System.String)"\] +\[Missing <summary> documentation for "M:Tests.StringExtensions.IfNullOrEmpty_ShouldReturnReplacementWhenValueIsNullOrEmpty(System.String)"\] @@ -26,11 +26,11 @@ member IfNullOrEmpty_ShouldReturnReplacementWhenValueIsNullOrEmpty : #### Parameters -
  String
\[Missing <param name="value"/> documentation for "M:Tests.StringExtensionTests.IfNullOrEmpty_ShouldReturnReplacementWhenValueIsNullOrEmpty(System.String)"\]
+
  String
\[Missing <param name="value"/> documentation for "M:Tests.StringExtensions.IfNullOrEmpty_ShouldReturnReplacementWhenValueIsNullOrEmpty(System.String)"\]
## See Also #### Reference -StringExtensionTests Class +StringExtensions Class Tests Namespace diff --git a/Documentation/Help/M_Tests_StringExtensionTests_IfNullOrWhiteSpace_ShouldReturnOriginalStringWhenValueIsNotNullNorWhitespace.md b/Documentation/Help/M_Tests_StringExtensions_IfNullOrWhiteSpace_ShouldReturnOriginalStringWhenValueIsNotNullNorWhitespace.md similarity index 74% rename from Documentation/Help/M_Tests_StringExtensionTests_IfNullOrWhiteSpace_ShouldReturnOriginalStringWhenValueIsNotNullNorWhitespace.md rename to Documentation/Help/M_Tests_StringExtensions_IfNullOrWhiteSpace_ShouldReturnOriginalStringWhenValueIsNotNullNorWhitespace.md index 13b0e6e..4bf8262 100644 --- a/Documentation/Help/M_Tests_StringExtensionTests_IfNullOrWhiteSpace_ShouldReturnOriginalStringWhenValueIsNotNullNorWhitespace.md +++ b/Documentation/Help/M_Tests_StringExtensions_IfNullOrWhiteSpace_ShouldReturnOriginalStringWhenValueIsNotNullNorWhitespace.md @@ -1,7 +1,7 @@ # IfNullOrWhiteSpace_ShouldReturnOriginalStringWhenValueIsNotNullNorWhitespace Method -\[Missing <summary> documentation for "M:Tests.StringExtensionTests.IfNullOrWhiteSpace_ShouldReturnOriginalStringWhenValueIsNotNullNorWhitespace(System.String)"\] +\[Missing <summary> documentation for "M:Tests.StringExtensions.IfNullOrWhiteSpace_ShouldReturnOriginalStringWhenValueIsNotNullNorWhitespace(System.String)"\] @@ -28,11 +28,11 @@ member IfNullOrWhiteSpace_ShouldReturnOriginalStringWhenValueIsNotNullNorWhitesp #### Parameters -
  String
\[Missing <param name="value"/> documentation for "M:Tests.StringExtensionTests.IfNullOrWhiteSpace_ShouldReturnOriginalStringWhenValueIsNotNullNorWhitespace(System.String)"\]
+
  String
\[Missing <param name="value"/> documentation for "M:Tests.StringExtensions.IfNullOrWhiteSpace_ShouldReturnOriginalStringWhenValueIsNotNullNorWhitespace(System.String)"\]
## See Also #### Reference -StringExtensionTests Class +StringExtensions Class Tests Namespace diff --git a/Documentation/Help/M_Tests_StringExtensionTests_IfNullOrWhiteSpace_ShouldReturnReplacementWhenValueIsNullOrWhitespace.md b/Documentation/Help/M_Tests_StringExtensions_IfNullOrWhiteSpace_ShouldReturnReplacementWhenValueIsNullOrWhitespace.md similarity index 74% rename from Documentation/Help/M_Tests_StringExtensionTests_IfNullOrWhiteSpace_ShouldReturnReplacementWhenValueIsNullOrWhitespace.md rename to Documentation/Help/M_Tests_StringExtensions_IfNullOrWhiteSpace_ShouldReturnReplacementWhenValueIsNullOrWhitespace.md index 4ae4ee9..8e9a828 100644 --- a/Documentation/Help/M_Tests_StringExtensionTests_IfNullOrWhiteSpace_ShouldReturnReplacementWhenValueIsNullOrWhitespace.md +++ b/Documentation/Help/M_Tests_StringExtensions_IfNullOrWhiteSpace_ShouldReturnReplacementWhenValueIsNullOrWhitespace.md @@ -1,7 +1,7 @@ # IfNullOrWhiteSpace_ShouldReturnReplacementWhenValueIsNullOrWhitespace Method -\[Missing <summary> documentation for "M:Tests.StringExtensionTests.IfNullOrWhiteSpace_ShouldReturnReplacementWhenValueIsNullOrWhitespace(System.String)"\] +\[Missing <summary> documentation for "M:Tests.StringExtensions.IfNullOrWhiteSpace_ShouldReturnReplacementWhenValueIsNullOrWhitespace(System.String)"\] @@ -28,11 +28,11 @@ member IfNullOrWhiteSpace_ShouldReturnReplacementWhenValueIsNullOrWhitespace : #### Parameters -
  String
\[Missing <param name="value"/> documentation for "M:Tests.StringExtensionTests.IfNullOrWhiteSpace_ShouldReturnReplacementWhenValueIsNullOrWhitespace(System.String)"\]
+
  String
\[Missing <param name="value"/> documentation for "M:Tests.StringExtensions.IfNullOrWhiteSpace_ShouldReturnReplacementWhenValueIsNullOrWhitespace(System.String)"\]
## See Also #### Reference -StringExtensionTests Class +StringExtensions Class Tests Namespace diff --git a/Documentation/Help/M_Tests_StringExtensionTests_Setup.md b/Documentation/Help/M_Tests_StringExtensions_Setup.md similarity index 80% rename from Documentation/Help/M_Tests_StringExtensionTests_Setup.md rename to Documentation/Help/M_Tests_StringExtensions_Setup.md index cce9d50..d0100f1 100644 --- a/Documentation/Help/M_Tests_StringExtensionTests_Setup.md +++ b/Documentation/Help/M_Tests_StringExtensions_Setup.md @@ -1,7 +1,7 @@ # Setup Method -\[Missing <summary> documentation for "M:Tests.StringExtensionTests.Setup"\] +\[Missing <summary> documentation for "M:Tests.StringExtensions.Setup"\] @@ -26,5 +26,5 @@ member Setup : unit -> unit #### Reference -StringExtensionTests Class +StringExtensions Class Tests Namespace diff --git a/Documentation/Help/M_Tests_StringExtensionTests__ctor.md b/Documentation/Help/M_Tests_StringExtensions__ctor.md similarity index 57% rename from Documentation/Help/M_Tests_StringExtensionTests__ctor.md rename to Documentation/Help/M_Tests_StringExtensions__ctor.md index 0af2452..b85fc54 100644 --- a/Documentation/Help/M_Tests_StringExtensionTests__ctor.md +++ b/Documentation/Help/M_Tests_StringExtensions__ctor.md @@ -1,7 +1,7 @@ -# StringExtensionTests Constructor +# StringExtensions Constructor -Initializes a new instance of the StringExtensionTests class +Initializes a new instance of the StringExtensions class @@ -11,11 +11,11 @@ Initializes a new instance of the Stri **C#** ``` C# -public StringExtensionTests() +public StringExtensions() ``` **F#** ``` F# -new : unit -> StringExtensionTests +new : unit -> StringExtensions ``` @@ -24,5 +24,5 @@ new : unit -> StringExtensionTests #### Reference -StringExtensionTests Class +StringExtensions Class Tests Namespace diff --git a/Documentation/Help/Methods_T_CapyKit_Helpers_SecurityHelper.md b/Documentation/Help/Methods_T_CapyKit_Helpers_SecurityHelper.md index 8bedcf9..8290be9 100644 --- a/Documentation/Help/Methods_T_CapyKit_Helpers_SecurityHelper.md +++ b/Documentation/Help/Methods_T_CapyKit_Helpers_SecurityHelper.md @@ -45,9 +45,6 @@ GetRandomString(Int32, ValidCharacterCollection[]) Gets a cryptographically strong random string using the character values found in [!:VALID_CHARACTERS]. -GetSalt -Generates a random byte array that can act as a salt. - GetType Gets the Type of the current instance.
(Inherited from Object) diff --git a/Documentation/Help/Methods_T_Tests_Helpers_SecurityHelperTests.md b/Documentation/Help/Methods_T_Tests_Passwords.md similarity index 61% rename from Documentation/Help/Methods_T_Tests_Helpers_SecurityHelperTests.md rename to Documentation/Help/Methods_T_Tests_Passwords.md index 14d3bdb..874c419 100644 --- a/Documentation/Help/Methods_T_Tests_Helpers_SecurityHelperTests.md +++ b/Documentation/Help/Methods_T_Tests_Passwords.md @@ -1,4 +1,4 @@ -# SecurityHelperTests Methods +# Passwords Methods @@ -6,18 +6,6 @@ ## Methods - - - - - - - - - - - - @@ -27,21 +15,12 @@ - - - - - - - - -
CompareHashedPassword_WithDifferentPassword_ShouldReturnFalse 
CompareHashedPassword_WithSamePassword_ShouldReturnTrue 
CompareSessionID_WithDifferentSessionIDs_ShouldReturnFalse 
CompareSessionID_WithSameSessionIDs_ShouldReturnTrue 
Equals Determines whether the specified object is equal to the current object.
(Inherited from Object)
GetHashCode Serves as the default hash function.
(Inherited from Object)
GetRandomPassword_ShouldReturnStringOfGivenLength 
GetRandomString_ShouldReturnStringOfGivenLength 
GetType Gets the Type of the current instance.
(Inherited from Object)
MemberwiseClone Creates a shallow copy of the current Object.
(Inherited from Object)
Pbkdf2_WithSamePasswordAndSalt_ShouldReturnSameHash 
ToString Returns a string that represents the current object.
(Inherited from Object)
@@ -50,5 +29,5 @@ #### Reference -SecurityHelperTests Class -Tests.Helpers Namespace +Passwords Class +Tests Namespace diff --git a/Documentation/Help/Methods_T_Tests_PasswordTests.md b/Documentation/Help/Methods_T_Tests_Passwords_PasswordTests.md similarity index 71% rename from Documentation/Help/Methods_T_Tests_PasswordTests.md rename to Documentation/Help/Methods_T_Tests_Passwords_PasswordTests.md index e03010e..27841bb 100644 --- a/Documentation/Help/Methods_T_Tests_PasswordTests.md +++ b/Documentation/Help/Methods_T_Tests_Passwords_PasswordTests.md @@ -12,7 +12,7 @@ Finalize Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from Object) -GenerateSalt +GenerateSalt   GetHashCode @@ -24,25 +24,25 @@ MemberwiseClone Creates a shallow copy of the current Object.
(Inherited from Object) -PasswordCreation_WithInvalidSalt_ReturnsEmptyHash +PasswordCreation_WithInvalidSalt_ReturnsEmptyHash   -PasswordCreation_WithPbkdf2Algorithm_CreatesValidHash +PasswordCreation_WithPbkdf2Algorithm_CreatesValidHash   -PasswordEquality_DifferentPasswords_AreNotEqual +PasswordEquality_DifferentPasswords_AreNotEqual   -PasswordEquality_DifferentSalts_AreNotEqual +PasswordEquality_DifferentSalts_AreNotEqual   -PasswordEquality_SamePasswordAndSalt_AreEqual +PasswordEquality_SamePasswordAndSalt_AreEqual   ToString Returns a string that represents the current object.
(Inherited from Object) -ToString_ReturnsCorrectFormat +ToString_ReturnsCorrectFormat   @@ -50,5 +50,5 @@ #### Reference -PasswordTests Class +Passwords.PasswordTests Class Tests Namespace diff --git a/Documentation/Help/Methods_T_Tests_StringExtensionTests.md b/Documentation/Help/Methods_T_Tests_StringExtensions.md similarity index 73% rename from Documentation/Help/Methods_T_Tests_StringExtensionTests.md rename to Documentation/Help/Methods_T_Tests_StringExtensions.md index f134b91..338add9 100644 --- a/Documentation/Help/Methods_T_Tests_StringExtensionTests.md +++ b/Documentation/Help/Methods_T_Tests_StringExtensions.md @@ -1,4 +1,4 @@ -# StringExtensionTests Methods +# StringExtensions Methods @@ -18,22 +18,22 @@ GetType Gets the Type of the current instance.
(Inherited from Object) -IfNullOrEmpty_ShouldReturnOriginalStringWhenValueIsNotNullNorEmpty +IfNullOrEmpty_ShouldReturnOriginalStringWhenValueIsNotNullNorEmpty   -IfNullOrEmpty_ShouldReturnReplacementWhenValueIsNullOrEmpty +IfNullOrEmpty_ShouldReturnReplacementWhenValueIsNullOrEmpty   -IfNullOrWhiteSpace_ShouldReturnOriginalStringWhenValueIsNotNullNorWhitespace +IfNullOrWhiteSpace_ShouldReturnOriginalStringWhenValueIsNotNullNorWhitespace   -IfNullOrWhiteSpace_ShouldReturnReplacementWhenValueIsNullOrWhitespace +IfNullOrWhiteSpace_ShouldReturnReplacementWhenValueIsNullOrWhitespace   MemberwiseClone Creates a shallow copy of the current Object.
(Inherited from Object) -Setup +Setup   ToString @@ -44,5 +44,5 @@ #### Reference -StringExtensionTests Class +StringExtensions Class Tests Namespace diff --git a/Documentation/Help/N_CapyKit.md b/Documentation/Help/N_CapyKit.md index 008918d..92294f1 100644 --- a/Documentation/Help/N_CapyKit.md +++ b/Documentation/Help/N_CapyKit.md @@ -1,7 +1,7 @@ # CapyKit Namespace -Core utilities and foundational methods for the CapyKit library. +\[Missing <summary> documentation for "N:CapyKit"\] diff --git a/Documentation/Help/N_CapyKit_Attributes.md b/Documentation/Help/N_CapyKit_Attributes.md index a5a99b2..b6d67f6 100644 --- a/Documentation/Help/N_CapyKit_Attributes.md +++ b/Documentation/Help/N_CapyKit_Attributes.md @@ -1,7 +1,7 @@ # CapyKit.Attributes Namespace -Custom attributes for simplifying .NET code behavior. +\[Missing <summary> documentation for "N:CapyKit.Attributes"\] diff --git a/Documentation/Help/N_CapyKit_Enumerations.md b/Documentation/Help/N_CapyKit_Enumerations.md index 84a6217..7085ef2 100644 --- a/Documentation/Help/N_CapyKit_Enumerations.md +++ b/Documentation/Help/N_CapyKit_Enumerations.md @@ -1,7 +1,7 @@ # CapyKit.Enumerations Namespace -Commonly used enumerations for value comparison and logic. +\[Missing <summary> documentation for "N:CapyKit.Enumerations"\] diff --git a/Documentation/Help/N_CapyKit_Extensions.md b/Documentation/Help/N_CapyKit_Extensions.md index 7c21b7b..d90033f 100644 --- a/Documentation/Help/N_CapyKit_Extensions.md +++ b/Documentation/Help/N_CapyKit_Extensions.md @@ -1,7 +1,7 @@ # CapyKit.Extensions Namespace -Extension methods for enhancing .NET classes and simplifying operations. +\[Missing <summary> documentation for "N:CapyKit.Extensions"\] diff --git a/Documentation/Help/N_CapyKit_Helpers.md b/Documentation/Help/N_CapyKit_Helpers.md index c1a84a0..76e7d1a 100644 --- a/Documentation/Help/N_CapyKit_Helpers.md +++ b/Documentation/Help/N_CapyKit_Helpers.md @@ -1,7 +1,7 @@ # CapyKit.Helpers Namespace -Utility classes for tasks like data manipulation and reflection. +\[Missing <summary> documentation for "N:CapyKit.Helpers"\] diff --git a/Documentation/Help/N_Tests.md b/Documentation/Help/N_Tests.md index 144965a..8169aaf 100644 --- a/Documentation/Help/N_Tests.md +++ b/Documentation/Help/N_Tests.md @@ -1,16 +1,19 @@ # Tests Namespace -Unit tests ensuring CapyKit functions as expected. +\[Missing <summary> documentation for "N:Tests"\] ## Classes - + - + + + +
PasswordTestsPasswords  
StringExtensionTestsPasswords.PasswordTests 
StringExtensions  
\ No newline at end of file diff --git a/Documentation/Help/N_Tests_Helpers.md b/Documentation/Help/N_Tests_Helpers.md deleted file mode 100644 index 6e2c166..0000000 --- a/Documentation/Help/N_Tests_Helpers.md +++ /dev/null @@ -1,13 +0,0 @@ -# Tests.Helpers Namespace - - -Contains unit tests specifically focused on verifying the correctness of the code in `CapyKit.Helpers`. - - - -## Classes - - - - -
SecurityHelperTests 
\ No newline at end of file diff --git a/Documentation/Help/P_CapyKit_Attributes_EnumerationAttribute_1_Value.md b/Documentation/Help/P_CapyKit_Attributes_EnumerationAttribute_1_Value.md index 07af611..a8fb0ae 100644 --- a/Documentation/Help/P_CapyKit_Attributes_EnumerationAttribute_1_Value.md +++ b/Documentation/Help/P_CapyKit_Attributes_EnumerationAttribute_1_Value.md @@ -7,7 +7,7 @@ Initializes a new instance of the CapyKit.Attributes -**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.2 +**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0 **C#** ``` C# diff --git a/Documentation/Help/P_CapyKit_Attributes_ValueFormatAttribute_Format.md b/Documentation/Help/P_CapyKit_Attributes_ValueFormatAttribute_Format.md index c9c9aed..3bdab82 100644 --- a/Documentation/Help/P_CapyKit_Attributes_ValueFormatAttribute_Format.md +++ b/Documentation/Help/P_CapyKit_Attributes_ValueFormatAttribute_Format.md @@ -7,7 +7,7 @@ Gets or sets the format to use for formatting the value. ## Definition **Namespace:** CapyKit.Attributes -**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.2 +**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0 **C#** ``` C# diff --git a/Documentation/Help/P_CapyKit_CapyEventArgs_Level.md b/Documentation/Help/P_CapyKit_CapyEventArgs_Level.md index fe65d72..339aac4 100644 --- a/Documentation/Help/P_CapyKit_CapyEventArgs_Level.md +++ b/Documentation/Help/P_CapyKit_CapyEventArgs_Level.md @@ -7,7 +7,7 @@ Gets the severity level of the event. ## Definition **Namespace:** CapyKit -**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.2 +**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0 **C#** ``` C# diff --git a/Documentation/Help/P_CapyKit_CapyEventArgs_Message.md b/Documentation/Help/P_CapyKit_CapyEventArgs_Message.md index edb1fc6..76d8334 100644 --- a/Documentation/Help/P_CapyKit_CapyEventArgs_Message.md +++ b/Documentation/Help/P_CapyKit_CapyEventArgs_Message.md @@ -7,7 +7,7 @@ Gets the message describing the reason for the event. ## Definition **Namespace:** CapyKit -**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.2 +**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0 **C#** ``` C# diff --git a/Documentation/Help/P_CapyKit_CapyEventArgs_MethodName.md b/Documentation/Help/P_CapyKit_CapyEventArgs_MethodName.md index 1cb1797..3efa094 100644 --- a/Documentation/Help/P_CapyKit_CapyEventArgs_MethodName.md +++ b/Documentation/Help/P_CapyKit_CapyEventArgs_MethodName.md @@ -7,7 +7,7 @@ Gets the name of the method where the event was raised. ## Definition **Namespace:** CapyKit -**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.2 +**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0 **C#** ``` C# diff --git a/Documentation/Help/P_CapyKit_EncryptedValue_1_Value.md b/Documentation/Help/P_CapyKit_EncryptedValue_1_Value.md index a2f5807..ad311c4 100644 --- a/Documentation/Help/P_CapyKit_EncryptedValue_1_Value.md +++ b/Documentation/Help/P_CapyKit_EncryptedValue_1_Value.md @@ -7,7 +7,7 @@ ## Definition **Namespace:** CapyKit -**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.2 +**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0 **C#** ``` C# diff --git a/Documentation/Help/P_CapyKit_Helpers_IEncryptionAlgorithm_AlgorithmName.md b/Documentation/Help/P_CapyKit_Helpers_IEncryptionAlgorithm_AlgorithmName.md index 9c60690..15b6788 100644 --- a/Documentation/Help/P_CapyKit_Helpers_IEncryptionAlgorithm_AlgorithmName.md +++ b/Documentation/Help/P_CapyKit_Helpers_IEncryptionAlgorithm_AlgorithmName.md @@ -7,7 +7,7 @@ ## Definition **Namespace:** CapyKit.Helpers -**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.2 +**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0 **C#** ``` C# diff --git a/Documentation/Help/P_CapyKit_IPasswordAlgorithm_AlgorithmName.md b/Documentation/Help/P_CapyKit_IPasswordAlgorithm_AlgorithmName.md index 7d56d13..b1a295f 100644 --- a/Documentation/Help/P_CapyKit_IPasswordAlgorithm_AlgorithmName.md +++ b/Documentation/Help/P_CapyKit_IPasswordAlgorithm_AlgorithmName.md @@ -7,7 +7,7 @@ Gets the name of the algorithm. ## Definition **Namespace:** CapyKit -**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.2 +**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0 **C#** ``` C# diff --git a/Documentation/Help/P_CapyKit_Password_Algorithm.md b/Documentation/Help/P_CapyKit_Password_Algorithm.md index 0a6eac3..a6b361a 100644 --- a/Documentation/Help/P_CapyKit_Password_Algorithm.md +++ b/Documentation/Help/P_CapyKit_Password_Algorithm.md @@ -7,7 +7,7 @@ Gets or sets the algorithm used for password encryption. ## Definition **Namespace:** CapyKit -**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.2 +**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0 **C#** ``` C# diff --git a/Documentation/Help/P_CapyKit_Password_Hash.md b/Documentation/Help/P_CapyKit_Password_Hash.md index 7d52c5f..22b2eac 100644 --- a/Documentation/Help/P_CapyKit_Password_Hash.md +++ b/Documentation/Help/P_CapyKit_Password_Hash.md @@ -7,7 +7,7 @@ Gets or sets the hash of the password. ## Definition **Namespace:** CapyKit -**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.2 +**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0 **C#** ``` C# diff --git a/Documentation/Help/P_CapyKit_Password_Pbkdf2Algorithm.md b/Documentation/Help/P_CapyKit_Password_Pbkdf2Algorithm.md index 051fd0d..63e7541 100644 --- a/Documentation/Help/P_CapyKit_Password_Pbkdf2Algorithm.md +++ b/Documentation/Help/P_CapyKit_Password_Pbkdf2Algorithm.md @@ -7,7 +7,7 @@ Gets the preconfigured PBKDF2 algorithm. ## Definition **Namespace:** CapyKit -**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.2 +**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0 **C#** ``` C# diff --git a/Documentation/Help/P_CapyKit_Password_Salt.md b/Documentation/Help/P_CapyKit_Password_Salt.md index 6784045..7bb4d48 100644 --- a/Documentation/Help/P_CapyKit_Password_Salt.md +++ b/Documentation/Help/P_CapyKit_Password_Salt.md @@ -7,7 +7,7 @@ Gets or sets the salt used for encryption. ## Definition **Namespace:** CapyKit -**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.2 +**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0 **C#** ``` C# diff --git a/Documentation/Help/P_CapyKit_Pbkdf2Algorithm_AlgorithmName.md b/Documentation/Help/P_CapyKit_Pbkdf2Algorithm_AlgorithmName.md index e7c3210..8c39c37 100644 --- a/Documentation/Help/P_CapyKit_Pbkdf2Algorithm_AlgorithmName.md +++ b/Documentation/Help/P_CapyKit_Pbkdf2Algorithm_AlgorithmName.md @@ -7,7 +7,7 @@ Gets the name of the algorithm. ## Definition **Namespace:** CapyKit -**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.2 +**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0 **C#** ``` C# diff --git a/Documentation/Help/P_CapyKit_PoolItem_1_Index.md b/Documentation/Help/P_CapyKit_PoolItem_1_Index.md index e2c35cb..6e68944 100644 --- a/Documentation/Help/P_CapyKit_PoolItem_1_Index.md +++ b/Documentation/Help/P_CapyKit_PoolItem_1_Index.md @@ -7,7 +7,7 @@ Gets the zero-based index of the pooled item. ## Definition **Namespace:** CapyKit -**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.2 +**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0 **C#** ``` C# diff --git a/Documentation/Help/P_CapyKit_PoolItem_1_Item.md b/Documentation/Help/P_CapyKit_PoolItem_1_Item.md index eb68f57..4c1d0e7 100644 --- a/Documentation/Help/P_CapyKit_PoolItem_1_Item.md +++ b/Documentation/Help/P_CapyKit_PoolItem_1_Item.md @@ -7,7 +7,7 @@ Gets the pooled resource. ## Definition **Namespace:** CapyKit -**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.2 +**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0 **C#** ``` C# diff --git a/Documentation/Help/P_CapyKit_PoolItem_1_Locked.md b/Documentation/Help/P_CapyKit_PoolItem_1_Locked.md index 37c2138..9721ac7 100644 --- a/Documentation/Help/P_CapyKit_PoolItem_1_Locked.md +++ b/Documentation/Help/P_CapyKit_PoolItem_1_Locked.md @@ -7,7 +7,7 @@ Gets a value indicating whether this object is locked or not. ## Definition **Namespace:** CapyKit -**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.2 +**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0 **C#** ``` C# diff --git a/Documentation/Help/P_CapyKit_PoolItem_1_TypeName.md b/Documentation/Help/P_CapyKit_PoolItem_1_TypeName.md index 6ec2a6c..660cdd9 100644 --- a/Documentation/Help/P_CapyKit_PoolItem_1_TypeName.md +++ b/Documentation/Help/P_CapyKit_PoolItem_1_TypeName.md @@ -7,7 +7,7 @@ Gets the name of the CapyKit -**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.2 +**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0 **C#** ``` C# diff --git a/Documentation/Help/R_Project_Documentation.md b/Documentation/Help/R_Project_Documentation.md index 846b040..db0c8eb 100644 --- a/Documentation/Help/R_Project_Documentation.md +++ b/Documentation/Help/R_Project_Documentation.md @@ -1,31 +1,26 @@ # Namespaces -Welcome to the official documentation for CapyKit, a powerful collection of C# utilities designed to enhance your .NET projects. Below, you'll find a list of namespaces included in the library, each offering a unique set of tools, extensions, and helpers to streamline your development process. - ## Namespaces - + - + - + - + - + - - - - +
CapyKitCore utilities and foundational methods for the CapyKit library.
CapyKit.AttributesCustom attributes for simplifying .NET code behavior.
CapyKit.EnumerationsCommonly used enumerations for value comparison and logic.
CapyKit.ExtensionsExtension methods for enhancing .NET classes and simplifying operations.
CapyKit.HelpersUtility classes for tasks like data manipulation and reflection.
TestsUnit tests ensuring CapyKit functions as expected.
Tests.HelpersContains unit tests specifically focused on verifying the correctness of the code in `CapyKit.Helpers`.
\ No newline at end of file diff --git a/Documentation/Help/T_CapyKit_Attributes_EnumerationAttribute_1.md b/Documentation/Help/T_CapyKit_Attributes_EnumerationAttribute_1.md index 79c1c02..793ef41 100644 --- a/Documentation/Help/T_CapyKit_Attributes_EnumerationAttribute_1.md +++ b/Documentation/Help/T_CapyKit_Attributes_EnumerationAttribute_1.md @@ -7,7 +7,7 @@ Custom attribute class for decorating enumeration fields with additional data. ## Definition **Namespace:** CapyKit.Attributes -**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.2 +**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0 **C#** ``` C# diff --git a/Documentation/Help/T_CapyKit_Attributes_EnumerationDescriptionAttribute.md b/Documentation/Help/T_CapyKit_Attributes_EnumerationDescriptionAttribute.md index d97d867..800d379 100644 --- a/Documentation/Help/T_CapyKit_Attributes_EnumerationDescriptionAttribute.md +++ b/Documentation/Help/T_CapyKit_Attributes_EnumerationDescriptionAttribute.md @@ -7,7 +7,7 @@ An attribute class for decorating enumeration fields with a description. ## Definition **Namespace:** CapyKit.Attributes -**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.2 +**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0 **C#** ``` C# diff --git a/Documentation/Help/T_CapyKit_Attributes_ValueFormatAttribute.md b/Documentation/Help/T_CapyKit_Attributes_ValueFormatAttribute.md index af7c201..82b989e 100644 --- a/Documentation/Help/T_CapyKit_Attributes_ValueFormatAttribute.md +++ b/Documentation/Help/T_CapyKit_Attributes_ValueFormatAttribute.md @@ -7,7 +7,7 @@ Custom attribute for formatting values in a specific way. ## Definition **Namespace:** CapyKit.Attributes -**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.2 +**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0 **C#** ``` C# diff --git a/Documentation/Help/T_CapyKit_CapyEventArgs.md b/Documentation/Help/T_CapyKit_CapyEventArgs.md index 8833e53..6d9d272 100644 --- a/Documentation/Help/T_CapyKit_CapyEventArgs.md +++ b/Documentation/Help/T_CapyKit_CapyEventArgs.md @@ -7,7 +7,7 @@ The CapyEventArgs class represents an event argument instance with event level, ## Definition **Namespace:** CapyKit -**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.2 +**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0 **C#** ``` C# diff --git a/Documentation/Help/T_CapyKit_CapyEventHandler.md b/Documentation/Help/T_CapyKit_CapyEventHandler.md index 7656fc5..4c30bc5 100644 --- a/Documentation/Help/T_CapyKit_CapyEventHandler.md +++ b/Documentation/Help/T_CapyKit_CapyEventHandler.md @@ -7,7 +7,7 @@ A delegate representing an event handler that accepts a CapyKit -**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.2 +**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0 **C#** ``` C# diff --git a/Documentation/Help/T_CapyKit_CapyEventReporter.md b/Documentation/Help/T_CapyKit_CapyEventReporter.md index 419dc3d..7ae5f49 100644 --- a/Documentation/Help/T_CapyKit_CapyEventReporter.md +++ b/Documentation/Help/T_CapyKit_CapyEventReporter.md @@ -7,7 +7,7 @@ The CapyEventReporter class is responsible for managing event subscriptions and ## Definition **Namespace:** CapyKit -**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.2 +**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0 **C#** ``` C# diff --git a/Documentation/Help/T_CapyKit_Color.md b/Documentation/Help/T_CapyKit_Color.md index 3eddc1c..cf2695a 100644 --- a/Documentation/Help/T_CapyKit_Color.md +++ b/Documentation/Help/T_CapyKit_Color.md @@ -7,7 +7,7 @@ Enum representing a set of named colors with their corresponding HEX values. The ## Definition **Namespace:** CapyKit -**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.2 +**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0 **C#** ``` C# diff --git a/Documentation/Help/T_CapyKit_EncryptedValue_1.md b/Documentation/Help/T_CapyKit_EncryptedValue_1.md index 5f04673..359009c 100644 --- a/Documentation/Help/T_CapyKit_EncryptedValue_1.md +++ b/Documentation/Help/T_CapyKit_EncryptedValue_1.md @@ -7,7 +7,7 @@ ## Definition **Namespace:** CapyKit -**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.2 +**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0 **C#** ``` C# diff --git a/Documentation/Help/T_CapyKit_Enumerations_MeasurementSystem.md b/Documentation/Help/T_CapyKit_Enumerations_MeasurementSystem.md index 8f90d77..4db7bb4 100644 --- a/Documentation/Help/T_CapyKit_Enumerations_MeasurementSystem.md +++ b/Documentation/Help/T_CapyKit_Enumerations_MeasurementSystem.md @@ -7,7 +7,7 @@ An enumeration representing different measurement systems. ## Definition **Namespace:** CapyKit.Enumerations -**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.2 +**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0 **C#** ``` C# diff --git a/Documentation/Help/T_CapyKit_EventLevel.md b/Documentation/Help/T_CapyKit_EventLevel.md index f2f1047..23eddda 100644 --- a/Documentation/Help/T_CapyKit_EventLevel.md +++ b/Documentation/Help/T_CapyKit_EventLevel.md @@ -7,7 +7,7 @@ Enumeration representing different event level severity values. ## Definition **Namespace:** CapyKit -**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.2 +**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0 **C#** ``` C# diff --git a/Documentation/Help/T_CapyKit_Extensions_EnumerationExtensions.md b/Documentation/Help/T_CapyKit_Extensions_EnumerationExtensions.md index 3811f65..0a2240d 100644 --- a/Documentation/Help/T_CapyKit_Extensions_EnumerationExtensions.md +++ b/Documentation/Help/T_CapyKit_Extensions_EnumerationExtensions.md @@ -7,7 +7,7 @@ Provides static extentions methods for providing additional functionality for CapyKit.Extensions -**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.2 +**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0 **C#** ``` C# diff --git a/Documentation/Help/T_CapyKit_Extensions_LINQExtensions.md b/Documentation/Help/T_CapyKit_Extensions_LINQExtensions.md index b4bf75b..cdee283 100644 --- a/Documentation/Help/T_CapyKit_Extensions_LINQExtensions.md +++ b/Documentation/Help/T_CapyKit_Extensions_LINQExtensions.md @@ -7,7 +7,7 @@ Provides static extension methods for performing common LINQ operations on CapyKit.Extensions -**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.2 +**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0 **C#** ``` C# diff --git a/Documentation/Help/T_CapyKit_Extensions_StringExtensions.md b/Documentation/Help/T_CapyKit_Extensions_StringExtensions.md index 401aa4b..523c236 100644 --- a/Documentation/Help/T_CapyKit_Extensions_StringExtensions.md +++ b/Documentation/Help/T_CapyKit_Extensions_StringExtensions.md @@ -7,7 +7,7 @@ Provides static extentions methods for providing additional functionality for CapyKit.Extensions -**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.2 +**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0 **C#** ``` C# diff --git a/Documentation/Help/T_CapyKit_Helpers_CalculationHelper.md b/Documentation/Help/T_CapyKit_Helpers_CalculationHelper.md index 3992064..9412395 100644 --- a/Documentation/Help/T_CapyKit_Helpers_CalculationHelper.md +++ b/Documentation/Help/T_CapyKit_Helpers_CalculationHelper.md @@ -7,7 +7,7 @@ Static class providing helper methods for various calculations. ## Definition **Namespace:** CapyKit.Helpers -**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.2 +**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0 **C#** ``` C# diff --git a/Documentation/Help/T_CapyKit_Helpers_CompressionHelper.md b/Documentation/Help/T_CapyKit_Helpers_CompressionHelper.md index 68ecebd..be310cf 100644 --- a/Documentation/Help/T_CapyKit_Helpers_CompressionHelper.md +++ b/Documentation/Help/T_CapyKit_Helpers_CompressionHelper.md @@ -7,7 +7,7 @@ A class that contains methods for managing data compression. ## Definition **Namespace:** CapyKit.Helpers -**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.2 +**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0 **C#** ``` C# diff --git a/Documentation/Help/T_CapyKit_Helpers_EncryptionHelper.md b/Documentation/Help/T_CapyKit_Helpers_EncryptionHelper.md index f870956..7ddeed0 100644 --- a/Documentation/Help/T_CapyKit_Helpers_EncryptionHelper.md +++ b/Documentation/Help/T_CapyKit_Helpers_EncryptionHelper.md @@ -7,7 +7,7 @@ ## Definition **Namespace:** CapyKit.Helpers -**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.2 +**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0 **C#** ``` C# diff --git a/Documentation/Help/T_CapyKit_Helpers_IEncryptionAlgorithm.md b/Documentation/Help/T_CapyKit_Helpers_IEncryptionAlgorithm.md index 1c3ada3..243b0eb 100644 --- a/Documentation/Help/T_CapyKit_Helpers_IEncryptionAlgorithm.md +++ b/Documentation/Help/T_CapyKit_Helpers_IEncryptionAlgorithm.md @@ -7,7 +7,7 @@ ## Definition **Namespace:** CapyKit.Helpers -**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.2 +**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0 **C#** ``` C# diff --git a/Documentation/Help/T_CapyKit_Helpers_LanguageHelper.md b/Documentation/Help/T_CapyKit_Helpers_LanguageHelper.md index ab474d7..bb86139 100644 --- a/Documentation/Help/T_CapyKit_Helpers_LanguageHelper.md +++ b/Documentation/Help/T_CapyKit_Helpers_LanguageHelper.md @@ -7,7 +7,7 @@ Helper class for handling text transformations. ## Definition **Namespace:** CapyKit.Helpers -**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.2 +**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0 **C#** ``` C# diff --git a/Documentation/Help/T_CapyKit_Helpers_SecurityHelper.md b/Documentation/Help/T_CapyKit_Helpers_SecurityHelper.md index 6d048d3..7c5fbda 100644 --- a/Documentation/Help/T_CapyKit_Helpers_SecurityHelper.md +++ b/Documentation/Help/T_CapyKit_Helpers_SecurityHelper.md @@ -7,7 +7,7 @@ A class that contains methods for managing secure data processing and cryptograp ## Definition **Namespace:** CapyKit.Helpers -**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.2 +**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0 **C#** ``` C# @@ -72,9 +72,6 @@ type SecurityHelper = class end GetRandomString(Int32, ValidCharacterCollection[]) Gets a cryptographically strong random string using the character values found in [!:VALID_CHARACTERS]. -GetSalt -Generates a random byte array that can act as a salt. - GetType Gets the Type of the current instance.
(Inherited from Object) diff --git a/Documentation/Help/T_CapyKit_Helpers_SerializationHelper.md b/Documentation/Help/T_CapyKit_Helpers_SerializationHelper.md index ebdf757..2dc5330 100644 --- a/Documentation/Help/T_CapyKit_Helpers_SerializationHelper.md +++ b/Documentation/Help/T_CapyKit_Helpers_SerializationHelper.md @@ -7,7 +7,7 @@ ## Definition **Namespace:** CapyKit.Helpers -**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.2 +**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0 **C#** ``` C# diff --git a/Documentation/Help/T_CapyKit_Helpers_SettingsHelper.md b/Documentation/Help/T_CapyKit_Helpers_SettingsHelper.md index 789b970..518a84a 100644 --- a/Documentation/Help/T_CapyKit_Helpers_SettingsHelper.md +++ b/Documentation/Help/T_CapyKit_Helpers_SettingsHelper.md @@ -7,7 +7,7 @@ Static class containing helper methods for retrieving and setting application se ## Definition **Namespace:** CapyKit.Helpers -**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.2 +**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0 **C#** ``` C# diff --git a/Documentation/Help/T_CapyKit_Helpers_ValidCharacterCollection.md b/Documentation/Help/T_CapyKit_Helpers_ValidCharacterCollection.md index ea8083a..91aa1bd 100644 --- a/Documentation/Help/T_CapyKit_Helpers_ValidCharacterCollection.md +++ b/Documentation/Help/T_CapyKit_Helpers_ValidCharacterCollection.md @@ -7,7 +7,7 @@ An enumeration that defines the types of characters that can be included in a ra ## Definition **Namespace:** CapyKit.Helpers -**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.2 +**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0 **C#** ``` C# diff --git a/Documentation/Help/T_CapyKit_IPasswordAlgorithm.md b/Documentation/Help/T_CapyKit_IPasswordAlgorithm.md index 645f086..ae817ef 100644 --- a/Documentation/Help/T_CapyKit_IPasswordAlgorithm.md +++ b/Documentation/Help/T_CapyKit_IPasswordAlgorithm.md @@ -7,7 +7,7 @@ Defines the contract for password encryption algorithms. ## Definition **Namespace:** CapyKit -**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.2 +**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0 **C#** ``` C# diff --git a/Documentation/Help/T_CapyKit_Password.md b/Documentation/Help/T_CapyKit_Password.md index 829e7c9..4d21097 100644 --- a/Documentation/Help/T_CapyKit_Password.md +++ b/Documentation/Help/T_CapyKit_Password.md @@ -7,7 +7,7 @@ Represents a password with its hash, salt and algorithm used for encryption. ## Definition **Namespace:** CapyKit -**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.2 +**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0 **C#** ``` C# diff --git a/Documentation/Help/T_CapyKit_Pbkdf2Algorithm.md b/Documentation/Help/T_CapyKit_Pbkdf2Algorithm.md index 4d2804b..b85e841 100644 --- a/Documentation/Help/T_CapyKit_Pbkdf2Algorithm.md +++ b/Documentation/Help/T_CapyKit_Pbkdf2Algorithm.md @@ -7,7 +7,7 @@ Implements the PBKDF2 algorithm for password encryption. ## Definition **Namespace:** CapyKit -**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.2 +**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0 **C#** ``` C# diff --git a/Documentation/Help/T_CapyKit_PoolItem_1.md b/Documentation/Help/T_CapyKit_PoolItem_1.md index 5062189..02d6c9a 100644 --- a/Documentation/Help/T_CapyKit_PoolItem_1.md +++ b/Documentation/Help/T_CapyKit_PoolItem_1.md @@ -7,7 +7,7 @@ A pool item. This class cannot be inherited. ## Definition **Namespace:** CapyKit -**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.2 +**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0 **C#** ``` C# diff --git a/Documentation/Help/T_CapyKit_Pool_1.md b/Documentation/Help/T_CapyKit_Pool_1.md index eddad11..f3e7df8 100644 --- a/Documentation/Help/T_CapyKit_Pool_1.md +++ b/Documentation/Help/T_CapyKit_Pool_1.md @@ -7,7 +7,7 @@ A managed pool of resources. This class provides a thread-safe way to manage a c ## Definition **Namespace:** CapyKit -**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.2 +**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0 **C#** ``` C# diff --git a/Documentation/Help/T_CapyKit_PropertyComparer_2.md b/Documentation/Help/T_CapyKit_PropertyComparer_2.md index f75e14a..0edce08 100644 --- a/Documentation/Help/T_CapyKit_PropertyComparer_2.md +++ b/Documentation/Help/T_CapyKit_PropertyComparer_2.md @@ -7,7 +7,7 @@ A object comparer that can accept a lambda expression to compare properties. ## Definition **Namespace:** CapyKit -**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.2 +**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0 **C#** ``` C# diff --git a/Documentation/Help/T_Tests_Helpers_SecurityHelperTests.md b/Documentation/Help/T_Tests_Helpers_SecurityHelperTests.md deleted file mode 100644 index a3d313d..0000000 --- a/Documentation/Help/T_Tests_Helpers_SecurityHelperTests.md +++ /dev/null @@ -1,95 +0,0 @@ -# SecurityHelperTests Class - - -\[Missing <summary> documentation for "T:Tests.Helpers.SecurityHelperTests"\] - - - -## Definition -**Namespace:** Tests.Helpers -**Assembly:** Tests (in Tests.exe) Version: 1.0.0 - -**C#** -``` C# -[TestFixtureAttribute] -internal class SecurityHelperTests -``` -**F#** -``` F# -[] -type SecurityHelperTests = class end -``` - - -
InheritanceObject → SecurityHelperTests
- - - -## Constructors - - - - - - - -
SecurityHelperTests 
SecurityHelperTestsInitializes a new instance of the SecurityHelperTests class
- -## Methods - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
CompareHashedPassword_WithDifferentPassword_ShouldReturnFalse 
CompareHashedPassword_WithSamePassword_ShouldReturnTrue 
CompareSessionID_WithDifferentSessionIDs_ShouldReturnFalse 
CompareSessionID_WithSameSessionIDs_ShouldReturnTrue 
EqualsDetermines whether the specified object is equal to the current object.
(Inherited from Object)
FinalizeAllows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from Object)
GetHashCodeServes as the default hash function.
(Inherited from Object)
GetRandomPassword_ShouldReturnStringOfGivenLength 
GetRandomString_ShouldReturnStringOfGivenLength 
GetTypeGets the Type of the current instance.
(Inherited from Object)
MemberwiseCloneCreates a shallow copy of the current Object.
(Inherited from Object)
Pbkdf2_WithSamePasswordAndSalt_ShouldReturnSameHash 
ToStringReturns a string that represents the current object.
(Inherited from Object)
- -## Fields - - - - - - - -
Password 
Salt 
- -## See Also - - -#### Reference -Tests.Helpers Namespace diff --git a/Documentation/Help/T_Tests_Passwords.md b/Documentation/Help/T_Tests_Passwords.md new file mode 100644 index 0000000..da0d5da --- /dev/null +++ b/Documentation/Help/T_Tests_Passwords.md @@ -0,0 +1,59 @@ +# Passwords Class + + +\[Missing <summary> documentation for "T:Tests.Passwords"\] + + + +## Definition +**Namespace:** Tests +**Assembly:** Tests (in Tests.exe) Version: 1.0.0 + +**C#** +``` C# +internal class Passwords +``` +**F#** +``` F# +type Passwords = class end +``` + + +
InheritanceObject → Passwords
+ + + +## Constructors + + + + +
PasswordsInitializes a new instance of the Passwords class
+ +## Methods + + + + + + + + + + + + + + + + + + + +
EqualsDetermines whether the specified object is equal to the current object.
(Inherited from Object)
FinalizeAllows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from Object)
GetHashCodeServes as the default hash function.
(Inherited from Object)
GetTypeGets the Type of the current instance.
(Inherited from Object)
MemberwiseCloneCreates a shallow copy of the current Object.
(Inherited from Object)
ToStringReturns a string that represents the current object.
(Inherited from Object)
+ +## See Also + + +#### Reference +Tests Namespace diff --git a/Documentation/Help/T_Tests_PasswordTests.md b/Documentation/Help/T_Tests_Passwords_PasswordTests.md similarity index 69% rename from Documentation/Help/T_Tests_PasswordTests.md rename to Documentation/Help/T_Tests_Passwords_PasswordTests.md index adac7da..3fbdbb6 100644 --- a/Documentation/Help/T_Tests_PasswordTests.md +++ b/Documentation/Help/T_Tests_Passwords_PasswordTests.md @@ -1,7 +1,7 @@ -# PasswordTests Class +# Passwords.PasswordTests Class -\[Missing <summary> documentation for "T:Tests.PasswordTests"\] +\[Missing <summary> documentation for "T:Tests.Passwords.PasswordTests"\] @@ -12,7 +12,7 @@ **C#** ``` C# [TestFixtureAttribute] -internal class PasswordTests +public class PasswordTests ``` **F#** ``` F# @@ -20,7 +20,7 @@ internal class PasswordTests type PasswordTests = class end ``` - +
InheritanceObject → PasswordTests
InheritanceObject → Passwords.PasswordTests
@@ -28,8 +28,8 @@ type PasswordTests = class end ## Constructors - - + +
PasswordTestsInitializes a new instance of the PasswordTests class
Passwords.PasswordTestsInitializes a new instance of the Passwords.PasswordTests class
## Methods @@ -41,7 +41,7 @@ type PasswordTests = class end Finalize Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from Object) -GenerateSalt +GenerateSalt   GetHashCode @@ -53,25 +53,25 @@ type PasswordTests = class end MemberwiseClone Creates a shallow copy of the current Object.
(Inherited from Object) -PasswordCreation_WithInvalidSalt_ReturnsEmptyHash +PasswordCreation_WithInvalidSalt_ReturnsEmptyHash   -PasswordCreation_WithPbkdf2Algorithm_CreatesValidHash +PasswordCreation_WithPbkdf2Algorithm_CreatesValidHash   -PasswordEquality_DifferentPasswords_AreNotEqual +PasswordEquality_DifferentPasswords_AreNotEqual   -PasswordEquality_DifferentSalts_AreNotEqual +PasswordEquality_DifferentSalts_AreNotEqual   -PasswordEquality_SamePasswordAndSalt_AreEqual +PasswordEquality_SamePasswordAndSalt_AreEqual   ToString Returns a string that represents the current object.
(Inherited from Object) -ToString_ReturnsCorrectFormat +ToString_ReturnsCorrectFormat   diff --git a/Documentation/Help/T_Tests_StringExtensionTests.md b/Documentation/Help/T_Tests_StringExtensions.md similarity index 71% rename from Documentation/Help/T_Tests_StringExtensionTests.md rename to Documentation/Help/T_Tests_StringExtensions.md index 122ba56..78b0a94 100644 --- a/Documentation/Help/T_Tests_StringExtensionTests.md +++ b/Documentation/Help/T_Tests_StringExtensions.md @@ -1,7 +1,7 @@ -# StringExtensionTests Class +# StringExtensions Class -\[Missing <summary> documentation for "T:Tests.StringExtensionTests"\] +\[Missing <summary> documentation for "T:Tests.StringExtensions"\] @@ -12,15 +12,15 @@ **C#** ``` C# [TestFixtureAttribute] -internal class StringExtensionTests +internal class StringExtensions ``` **F#** ``` F# [] -type StringExtensionTests = class end +type StringExtensions = class end ``` - +
InheritanceObject → StringExtensionTests
InheritanceObject → StringExtensions
@@ -28,8 +28,8 @@ type StringExtensionTests = class end ## Constructors - - + +
StringExtensionTestsInitializes a new instance of the StringExtensionTests class
StringExtensionsInitializes a new instance of the StringExtensions class
## Methods @@ -47,22 +47,22 @@ type StringExtensionTests = class end GetType Gets the Type of the current instance.
(Inherited from Object) -IfNullOrEmpty_ShouldReturnOriginalStringWhenValueIsNotNullNorEmpty +IfNullOrEmpty_ShouldReturnOriginalStringWhenValueIsNotNullNorEmpty   -IfNullOrEmpty_ShouldReturnReplacementWhenValueIsNullOrEmpty +IfNullOrEmpty_ShouldReturnReplacementWhenValueIsNullOrEmpty   -IfNullOrWhiteSpace_ShouldReturnOriginalStringWhenValueIsNotNullNorWhitespace +IfNullOrWhiteSpace_ShouldReturnOriginalStringWhenValueIsNotNullNorWhitespace   -IfNullOrWhiteSpace_ShouldReturnReplacementWhenValueIsNullOrWhitespace +IfNullOrWhiteSpace_ShouldReturnReplacementWhenValueIsNullOrWhitespace   MemberwiseClone Creates a shallow copy of the current Object.
(Inherited from Object) -Setup +Setup   ToString @@ -72,7 +72,7 @@ type StringExtensionTests = class end ## Fields - +
ReplacementReplacement  
diff --git a/Documentation/Help/Working/_InheritedDocs_.xml b/Documentation/Help/Working/_InheritedDocs_.xml new file mode 100644 index 0000000..82ddca8 --- /dev/null +++ b/Documentation/Help/Working/_InheritedDocs_.xml @@ -0,0 +1,19 @@ + + + _InheritedDocs_ + + + + +Determines whether the specified object is equal to the current object.The object to compare with the current object. if the specified object is equal to the current object; otherwise, . + +Returns a string that represents the current object.A string that represents the current object. + + + + + + + Gets the name of the algorithm. + + \ No newline at end of file diff --git a/Documentation/Help/_Sidebar.md b/Documentation/Help/_Sidebar.md index 3fdff72..c03984b 100644 --- a/Documentation/Help/_Sidebar.md +++ b/Documentation/Help/_Sidebar.md @@ -201,7 +201,6 @@ - [GetRandomString Method](Overload_CapyKit_Helpers_SecurityHelper_GetRandomString.md) - [GetRandomString(Int32) Method](M_CapyKit_Helpers_SecurityHelper_GetRandomString.md) - [GetRandomString(Int32, ValidCharacterCollection[]) Method](M_CapyKit_Helpers_SecurityHelper_GetRandomString_1.md) - - [GetSalt Method](M_CapyKit_Helpers_SecurityHelper_GetSalt.md) - [GetValidCharacterComposition Method](M_CapyKit_Helpers_SecurityHelper_GetValidCharacterComposition.md) - [Pbkdf2 Method](Overload_CapyKit_Helpers_SecurityHelper_Pbkdf2.md) - [Pbkdf2(String) Method](M_CapyKit_Helpers_SecurityHelper_Pbkdf2.md) @@ -231,38 +230,26 @@ - [detector Field](F_CapyKit_Helpers_SettingsHelper_detector.md) - [ValidCharacterCollection Enumeration](T_CapyKit_Helpers_ValidCharacterCollection.md) - [Tests Namespace](N_Tests.md) - - [PasswordTests Class](T_Tests_PasswordTests.md) - - [PasswordTests Constructor](M_Tests_PasswordTests__ctor.md) - - [PasswordTests Methods](Methods_T_Tests_PasswordTests.md) - - [GenerateSalt Method](M_Tests_PasswordTests_GenerateSalt.md) - - [PasswordCreation_WithInvalidSalt_ReturnsEmptyHash Method](M_Tests_PasswordTests_PasswordCreation_WithInvalidSalt_ReturnsEmptyHash.md) - - [PasswordCreation_WithPbkdf2Algorithm_CreatesValidHash Method](M_Tests_PasswordTests_PasswordCreation_WithPbkdf2Algorithm_CreatesValidHash.md) - - [PasswordEquality_DifferentPasswords_AreNotEqual Method](M_Tests_PasswordTests_PasswordEquality_DifferentPasswords_AreNotEqual.md) - - [PasswordEquality_DifferentSalts_AreNotEqual Method](M_Tests_PasswordTests_PasswordEquality_DifferentSalts_AreNotEqual.md) - - [PasswordEquality_SamePasswordAndSalt_AreEqual Method](M_Tests_PasswordTests_PasswordEquality_SamePasswordAndSalt_AreEqual.md) - - [ToString_ReturnsCorrectFormat Method](M_Tests_PasswordTests_ToString_ReturnsCorrectFormat.md) - - [StringExtensionTests Class](T_Tests_StringExtensionTests.md) - - [StringExtensionTests Constructor](M_Tests_StringExtensionTests__ctor.md) - - [StringExtensionTests Methods](Methods_T_Tests_StringExtensionTests.md) - - [IfNullOrEmpty_ShouldReturnOriginalStringWhenValueIsNotNullNorEmpty Method](M_Tests_StringExtensionTests_IfNullOrEmpty_ShouldReturnOriginalStringWhenValueIsNotNullNorEmpty.md) - - [IfNullOrEmpty_ShouldReturnReplacementWhenValueIsNullOrEmpty Method](M_Tests_StringExtensionTests_IfNullOrEmpty_ShouldReturnReplacementWhenValueIsNullOrEmpty.md) - - [IfNullOrWhiteSpace_ShouldReturnOriginalStringWhenValueIsNotNullNorWhitespace Method](M_Tests_StringExtensionTests_IfNullOrWhiteSpace_ShouldReturnOriginalStringWhenValueIsNotNullNorWhitespace.md) - - [IfNullOrWhiteSpace_ShouldReturnReplacementWhenValueIsNullOrWhitespace Method](M_Tests_StringExtensionTests_IfNullOrWhiteSpace_ShouldReturnReplacementWhenValueIsNullOrWhitespace.md) - - [Setup Method](M_Tests_StringExtensionTests_Setup.md) - - [StringExtensionTests Fields](Fields_T_Tests_StringExtensionTests.md) - - [Replacement Field](F_Tests_StringExtensionTests_Replacement.md) - - [Tests.Helpers Namespace](N_Tests_Helpers.md) - - [SecurityHelperTests Class](T_Tests_Helpers_SecurityHelperTests.md) - - [SecurityHelperTests Constructor](M_Tests_Helpers_SecurityHelperTests__cctor.md) - - [SecurityHelperTests Constructor](M_Tests_Helpers_SecurityHelperTests__ctor.md) - - [SecurityHelperTests Methods](Methods_T_Tests_Helpers_SecurityHelperTests.md) - - [CompareHashedPassword_WithDifferentPassword_ShouldReturnFalse Method](M_Tests_Helpers_SecurityHelperTests_CompareHashedPassword_WithDifferentPassword_ShouldReturnFalse.md) - - [CompareHashedPassword_WithSamePassword_ShouldReturnTrue Method](M_Tests_Helpers_SecurityHelperTests_CompareHashedPassword_WithSamePassword_ShouldReturnTrue.md) - - [CompareSessionID_WithDifferentSessionIDs_ShouldReturnFalse Method](M_Tests_Helpers_SecurityHelperTests_CompareSessionID_WithDifferentSessionIDs_ShouldReturnFalse.md) - - [CompareSessionID_WithSameSessionIDs_ShouldReturnTrue Method](M_Tests_Helpers_SecurityHelperTests_CompareSessionID_WithSameSessionIDs_ShouldReturnTrue.md) - - [GetRandomPassword_ShouldReturnStringOfGivenLength Method](M_Tests_Helpers_SecurityHelperTests_GetRandomPassword_ShouldReturnStringOfGivenLength.md) - - [GetRandomString_ShouldReturnStringOfGivenLength Method](M_Tests_Helpers_SecurityHelperTests_GetRandomString_ShouldReturnStringOfGivenLength.md) - - [Pbkdf2_WithSamePasswordAndSalt_ShouldReturnSameHash Method](M_Tests_Helpers_SecurityHelperTests_Pbkdf2_WithSamePasswordAndSalt_ShouldReturnSameHash.md) - - [SecurityHelperTests Fields](Fields_T_Tests_Helpers_SecurityHelperTests.md) - - [Password Field](F_Tests_Helpers_SecurityHelperTests_Password.md) - - [Salt Field](F_Tests_Helpers_SecurityHelperTests_Salt.md) + - [Passwords Class](T_Tests_Passwords.md) + - [Passwords Constructor](M_Tests_Passwords__ctor.md) + - [Passwords Methods](Methods_T_Tests_Passwords.md) + - [Passwords.PasswordTests Class](T_Tests_Passwords_PasswordTests.md) + - [Passwords.PasswordTests Constructor](M_Tests_Passwords_PasswordTests__ctor.md) + - [PasswordTests Methods](Methods_T_Tests_Passwords_PasswordTests.md) + - [GenerateSalt Method](M_Tests_Passwords_PasswordTests_GenerateSalt.md) + - [PasswordCreation_WithInvalidSalt_ReturnsEmptyHash Method](M_Tests_Passwords_PasswordTests_PasswordCreation_WithInvalidSalt_ReturnsEmptyHash.md) + - [PasswordCreation_WithPbkdf2Algorithm_CreatesValidHash Method](M_Tests_Passwords_PasswordTests_PasswordCreation_WithPbkdf2Algorithm_CreatesValidHash.md) + - [PasswordEquality_DifferentPasswords_AreNotEqual Method](M_Tests_Passwords_PasswordTests_PasswordEquality_DifferentPasswords_AreNotEqual.md) + - [PasswordEquality_DifferentSalts_AreNotEqual Method](M_Tests_Passwords_PasswordTests_PasswordEquality_DifferentSalts_AreNotEqual.md) + - [PasswordEquality_SamePasswordAndSalt_AreEqual Method](M_Tests_Passwords_PasswordTests_PasswordEquality_SamePasswordAndSalt_AreEqual.md) + - [ToString_ReturnsCorrectFormat Method](M_Tests_Passwords_PasswordTests_ToString_ReturnsCorrectFormat.md) + - [StringExtensions Class](T_Tests_StringExtensions.md) + - [StringExtensions Constructor](M_Tests_StringExtensions__ctor.md) + - [StringExtensions Methods](Methods_T_Tests_StringExtensions.md) + - [IfNullOrEmpty_ShouldReturnOriginalStringWhenValueIsNotNullNorEmpty Method](M_Tests_StringExtensions_IfNullOrEmpty_ShouldReturnOriginalStringWhenValueIsNotNullNorEmpty.md) + - [IfNullOrEmpty_ShouldReturnReplacementWhenValueIsNullOrEmpty Method](M_Tests_StringExtensions_IfNullOrEmpty_ShouldReturnReplacementWhenValueIsNullOrEmpty.md) + - [IfNullOrWhiteSpace_ShouldReturnOriginalStringWhenValueIsNotNullNorWhitespace Method](M_Tests_StringExtensions_IfNullOrWhiteSpace_ShouldReturnOriginalStringWhenValueIsNotNullNorWhitespace.md) + - [IfNullOrWhiteSpace_ShouldReturnReplacementWhenValueIsNullOrWhitespace Method](M_Tests_StringExtensions_IfNullOrWhiteSpace_ShouldReturnReplacementWhenValueIsNullOrWhitespace.md) + - [Setup Method](M_Tests_StringExtensions_Setup.md) + - [StringExtensions Fields](Fields_T_Tests_StringExtensions.md) + - [Replacement Field](F_Tests_StringExtensions_Replacement.md) diff --git a/Tests/Helpers/SecurityHelper.cs b/Tests/Helpers/SecurityHelper.cs deleted file mode 100644 index 92e6838..0000000 --- a/Tests/Helpers/SecurityHelper.cs +++ /dev/null @@ -1,112 +0,0 @@ -using CapyKit; -using CapyKit.Helpers; -using System; -using System.Collections.Generic; -using System.Linq; -using System.Text; -using System.Threading.Tasks; -using System.Security.Cryptography; - -namespace Tests.Helpers -{ - [TestFixture] - internal class SecurityHelperTests - { - private const string Password = "TestPassword"; - private static readonly byte[] Salt = SecurityHelper.GetSalt(); - - [Test] - public void CompareHashedPassword_WithSamePassword_ShouldReturnTrue() - { - var existingPassword = SecurityHelper.Pbkdf2(Password, Salt); - var result = SecurityHelper.CompareHashedPassword(existingPassword, Password, Salt); - - Assert.IsTrue(result); - } - - [Test] - public void CompareHashedPassword_WithDifferentPassword_ShouldReturnFalse() - { - var existingPassword = SecurityHelper.Pbkdf2(Password, Salt); - var result = SecurityHelper.CompareHashedPassword(existingPassword, "WrongPassword", Salt); - - Assert.IsFalse(result); - } - - [Test] - public void CompareSessionID_WithSameSessionIDs_ShouldReturnTrue() - { - var sessionID1 = "SessionID"; - var sessionID2 = "SessionID"; - - var result = SecurityHelper.CompareSessionID(sessionID1, sessionID2); - - Assert.IsTrue(result); - } - - [Test] - public void CompareSessionID_WithDifferentSessionIDs_ShouldReturnFalse() - { - var sessionID1 = "SessionID1"; - var sessionID2 = "SessionID2"; - - var result = SecurityHelper.CompareSessionID(sessionID1, sessionID2); - - Assert.IsFalse(result); - } - - [Test] - public void GetRandomString_ShouldReturnStringOfGivenLength() - { - int length = 10; - var randomString = SecurityHelper.GetRandomString(length); - - Assert.AreEqual(length, randomString.Length); - } - - [Test] - public void GetRandomPassword_ShouldReturnStringOfGivenLength() - { - int length = 12; - var randomPassword = SecurityHelper.GetRandomPassword(length); - - Assert.AreEqual(length, randomPassword.Length); - } - - [Test] - public void Pbkdf2_WithSamePasswordAndSalt_ShouldReturnSameHash() - { - var password1 = SecurityHelper.Pbkdf2(Password, Salt); - var password2 = SecurityHelper.Pbkdf2(Password, Salt); - - Assert.AreEqual(password1.Hash, password2.Hash); - } - - //[Test] - //public void GetPassword_WithPBKDF2Algorithm_ShouldReturnValidPasswordObject() - //{ - // var password = SecurityHelper.GetPassword(Password, Salt); - - // Assert.IsNotNull(password); - // Assert.AreEqual(Password, password.); - //} - - //[Test] - //public void GetPassword_WithDifferentAlgorithm_ShouldReturnDifferentHashes() - //{ - // var password1 = SecurityHelper.GetPassword(Password, Salt); - // var password2 = SecurityHelper.GetPassword(Password, Salt); // Replace with another algorithm implementation - - // Assert.AreNotEqual(password1.Hash, password2.Hash); - //} - - //[Test] - //public void GetRandomBytes_ShouldReturnArrayOfGivenLength() - //{ - // int length = 16; - // var bytes = SecurityHelper.GetRandomBytes(length); - - // Assert.AreEqual(length, bytes.Length); - //} - } -} diff --git a/Tests/PasswordTests.cs b/Tests/PasswordTests.cs deleted file mode 100644 index e486cf1..0000000 --- a/Tests/PasswordTests.cs +++ /dev/null @@ -1,124 +0,0 @@ -using CapyKit; -using System; -using System.Collections.Generic; -using System.Linq; -using System.Text; -using System.Threading.Tasks; - -namespace Tests -{ - [TestFixture] - internal class PasswordTests - { - private static byte[] GenerateSalt(int size = 16) - { - var salt = new byte[size]; - using (var rng = new System.Security.Cryptography.RNGCryptoServiceProvider()) - { - rng.GetBytes(salt); - } - return salt; - } - - [Test] - public void PasswordCreation_WithPbkdf2Algorithm_CreatesValidHash() - { - // Arrange - var passwordText = "mySecurePassword"; - var salt = GenerateSalt(); - var algorithm = Password.Pbkdf2Algorithm; - - // Act - var password = new Password(passwordText, salt, algorithm); - - // Assert - Assert.IsNotNull(password.Hash); - Assert.IsNotEmpty(password.Hash); - Assert.AreEqual(salt, password.Salt); - Assert.AreEqual(algorithm, password.Algorithm); - } - - [Test] - public void PasswordEquality_SamePasswordAndSalt_AreEqual() - { - // Arrange - var passwordText = "mySecurePassword"; - var salt = GenerateSalt(); - var algorithm = Password.Pbkdf2Algorithm; - - var password1 = new Password(passwordText, salt, algorithm); - var password2 = new Password(passwordText, salt, algorithm); - - // Act & Assert - Assert.AreEqual(password1, password2); - Assert.IsTrue(password1 == password2); - } - - [Test] - public void PasswordEquality_DifferentPasswords_AreNotEqual() - { - // Arrange - var salt = GenerateSalt(); - var algorithm = new Pbkdf2Algorithm(); - - var password1 = new Password("passwordOne", salt, algorithm); - var password2 = new Password("passwordTwo", salt, algorithm); - - // Act & Assert - Assert.AreNotEqual(password1, password2); - Assert.IsTrue(password1 != password2); - } - - [Test] - public void PasswordEquality_DifferentSalts_AreNotEqual() - { - // Arrange - var passwordText = "mySecurePassword"; - var salt1 = GenerateSalt(); - var salt2 = GenerateSalt(); - var algorithm = Password.Pbkdf2Algorithm; - - var password1 = new Password(passwordText, salt1, algorithm); - var password2 = new Password(passwordText, salt2, algorithm); - - // Act & Assert - Assert.AreNotEqual(password1, password2); - Assert.IsTrue(password1 != password2); - } - - [Test] - public void ToString_ReturnsCorrectFormat() - { - // Arrange - var passwordText = "mySecurePassword"; - var salt = GenerateSalt(); - var algorithm = Password.Pbkdf2Algorithm; - - var password = new Password(passwordText, salt, algorithm); - - // Act - var result = password.ToString(); - - // Assert - Assert.IsTrue(result.Contains("Hash:")); - Assert.IsTrue(result.Contains("Salt:")); - Assert.IsTrue(result.Contains("Algorithm: Pbkdf2")); - } - - [Test] - public void PasswordCreation_WithInvalidSalt_ReturnsEmptyHash() - { - // Arrange - var passwordText = "mySecurePassword"; - byte[] invalidSalt = null; // Invalid salt - var algorithm = new Pbkdf2Algorithm(); - - // Act - var password = new Password(passwordText, invalidSalt, algorithm); - - // Assert - Assert.IsNotNull(password.Hash); - Assert.IsEmpty(password.Hash); - } - } -} diff --git a/Tests/Passwords.cs b/Tests/Passwords.cs new file mode 100644 index 0000000..aaa5f1b --- /dev/null +++ b/Tests/Passwords.cs @@ -0,0 +1,127 @@ +using CapyKit; +using System; +using System.Collections.Generic; +using System.Linq; +using System.Text; +using System.Threading.Tasks; + +namespace Tests +{ + internal class Passwords + { + [TestFixture] + public class PasswordTests + { + private static byte[] GenerateSalt(int size = 16) + { + var salt = new byte[size]; + using (var rng = new System.Security.Cryptography.RNGCryptoServiceProvider()) + { + rng.GetBytes(salt); + } + return salt; + } + + [Test] + public void PasswordCreation_WithPbkdf2Algorithm_CreatesValidHash() + { + // Arrange + var passwordText = "mySecurePassword"; + var salt = GenerateSalt(); + var algorithm = Password.Pbkdf2Algorithm; + + // Act + var password = new Password(passwordText, salt, algorithm); + + // Assert + Assert.IsNotNull(password.Hash); + Assert.IsNotEmpty(password.Hash); + Assert.AreEqual(salt, password.Salt); + Assert.AreEqual(algorithm, password.Algorithm); + } + + [Test] + public void PasswordEquality_SamePasswordAndSalt_AreEqual() + { + // Arrange + var passwordText = "mySecurePassword"; + var salt = GenerateSalt(); + var algorithm = Password.Pbkdf2Algorithm; + + var password1 = new Password(passwordText, salt, algorithm); + var password2 = new Password(passwordText, salt, algorithm); + + // Act & Assert + Assert.AreEqual(password1, password2); + Assert.IsTrue(password1 == password2); + } + + [Test] + public void PasswordEquality_DifferentPasswords_AreNotEqual() + { + // Arrange + var salt = GenerateSalt(); + var algorithm = new Pbkdf2Algorithm(); + + var password1 = new Password("passwordOne", salt, algorithm); + var password2 = new Password("passwordTwo", salt, algorithm); + + // Act & Assert + Assert.AreNotEqual(password1, password2); + Assert.IsTrue(password1 != password2); + } + + [Test] + public void PasswordEquality_DifferentSalts_AreNotEqual() + { + // Arrange + var passwordText = "mySecurePassword"; + var salt1 = GenerateSalt(); + var salt2 = GenerateSalt(); + var algorithm = Password.Pbkdf2Algorithm; + + var password1 = new Password(passwordText, salt1, algorithm); + var password2 = new Password(passwordText, salt2, algorithm); + + // Act & Assert + Assert.AreNotEqual(password1, password2); + Assert.IsTrue(password1 != password2); + } + + [Test] + public void ToString_ReturnsCorrectFormat() + { + // Arrange + var passwordText = "mySecurePassword"; + var salt = GenerateSalt(); + var algorithm = Password.Pbkdf2Algorithm; + + var password = new Password(passwordText, salt, algorithm); + + // Act + var result = password.ToString(); + + // Assert + Assert.IsTrue(result.Contains("Hash:")); + Assert.IsTrue(result.Contains("Salt:")); + Assert.IsTrue(result.Contains("Algorithm: Pbkdf2")); + } + + [Test] + public void PasswordCreation_WithInvalidSalt_ReturnsEmptyHash() + { + // Arrange + var passwordText = "mySecurePassword"; + byte[] invalidSalt = null; // Invalid salt + var algorithm = new Pbkdf2Algorithm(); + + // Act + var password = new Password(passwordText, invalidSalt, algorithm); + + // Assert + Assert.IsNotNull(password.Hash); + Assert.IsEmpty(password.Hash); + } + } + } +} diff --git a/Tests/StringExtensionTests.cs b/Tests/StringExtensions.cs similarity index 97% rename from Tests/StringExtensionTests.cs rename to Tests/StringExtensions.cs index acd3429..266f1fa 100644 --- a/Tests/StringExtensionTests.cs +++ b/Tests/StringExtensions.cs @@ -10,7 +10,7 @@ using NUnit.Framework; namespace Tests { [TestFixture] - internal class StringExtensionTests + internal class StringExtensions { private const string Replacement = "Replaced"; diff --git a/Tests/Tests.csproj b/Tests/Tests.csproj index 881a38d..d6604e7 100644 --- a/Tests/Tests.csproj +++ b/Tests/Tests.csproj @@ -1,4 +1,4 @@ - + net8.0