Improve documentation #8834
Open
Improve documentation #8834
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Added XML documentation comments for methods in ColorUtils to improve code readability and ensure better understanding of method purposes and parameters. This includes comments for methods like Blend, Lerp, Luminance, and OpposingLuminanceColor. Signed-off-by: Ivandro Jao <Ivandrofly@gmail.com>
Included XML comments to describe the CsvUtil class and its CsvSplit method, detailing their purpose and parameters. This improves code readability and helps developers understand the functionality at a glance. Signed-off-by: Ivandro Jao <Ivandrofly@gmail.com>
Fixed typos in XML comments for the GetThreeLetterIsoLanguageName method. This enhances readability and maintains consistency in code documentation. Signed-off-by: Ivandro Jao <Ivandrofly@gmail.com>
Enhance code documentation by adding XML comments to the DialogSplitMerge class and its methods. This includes summaries, parameters, and return values for improved code clarity and IntelliSense support. Signed-off-by: Ivandro Jao <Ivandrofly@gmail.com>
Enhanced the Dimension struct with comprehensive XML documentation for better clarity and maintainability. Updated property descriptions and provided explanations for overridden methods and operators. Signed-off-by: Ivandro Jao <Ivandrofly@gmail.com>
Enhanced documentation for the Subtitle class by adding XML comments to its properties and methods. This includes detailed descriptions of parameters and return values, improving code readability and maintainability. Signed-off-by: Ivandro Jao <Ivandrofly@gmail.com>
This commit enhances the RegexUtils class by adding XML documentation for several utility methods. These comments provide clear descriptions, parameter explanations, and return values, facilitating better code understanding and maintainability. Signed-off-by: Ivandro Jao <Ivandrofly@gmail.com>
This commit adds a summary XML comment to the RegistryUtil class, providing a brief description of its purpose. This improves code readability and helps developers understand the function of the class more quickly. Signed-off-by: Ivandro Jao <Ivandrofly@gmail.com>
This commit introduces detailed XML documentation for the Retry class and its methods, enhancing code readability and maintainability. The documentation describes the functionality, parameters, and return values for the retry mechanisms. Signed-off-by: Ivandro Jao <Ivandrofly@gmail.com>
Added comprehensive XML documentation to various methods and properties in the Utilities class. These comments describe the purpose, parameters, and return values to improve code readability and maintainability. Signed-off-by: Ivandro Jao <Ivandrofly@gmail.com>
Updated the summary for the Utilities class to specify its methods for checking if strings are numbers or hexadecimal, formatting file sizes, and breaking lines of text. This makes the documentation more useful and informative for developers interacting with this class. Signed-off-by: Ivandro Jao <Ivandrofly@gmail.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
No description provided.