Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Improve documentation #8834

Open
wants to merge 11 commits into
base: main
Choose a base branch
from
Open

Improve documentation #8834

wants to merge 11 commits into from

Commits on Sep 17, 2024

  1. Add XML documentation comments to ColorUtils methods 

    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>
    @ivandrofly
    ivandrofly committed Sep 17, 2024
    Configuration menu
    Copy the full SHA
    c53b9df View commit details
    Browse the repository at this point in the history

  2. Add XML documentation to CsvUtil class and CsvSplit method 

    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>
    @ivandrofly
    ivandrofly committed Sep 17, 2024
    Configuration menu
    Copy the full SHA
    5db1f43 View commit details
    Browse the repository at this point in the history

  3. Correct typos in CultureExtensions documentation. 

    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>
    @ivandrofly
    ivandrofly committed Sep 17, 2024
    Configuration menu
    Copy the full SHA
    e839135 View commit details
    Browse the repository at this point in the history

  4. Add detailed XML documentation to DialogSplitMerge methods 

    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>
    @ivandrofly
    ivandrofly committed Sep 17, 2024
    Configuration menu
    Copy the full SHA
    460c20f View commit details
    Browse the repository at this point in the history

  5. Add detailed XML documentation to Dimension struct 

    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>
    @ivandrofly
    ivandrofly committed Sep 17, 2024
    Configuration menu
    Copy the full SHA
    232966c View commit details
    Browse the repository at this point in the history

  6. Add XML comments to Subtitle class methods and properties 

    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>
    @ivandrofly
    ivandrofly committed Sep 17, 2024
    Configuration menu
    Copy the full SHA
    cf6dcfb View commit details
    Browse the repository at this point in the history

  7. Add XML documentation to RegexUtils methods 

    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>
    @ivandrofly
    ivandrofly committed Sep 17, 2024
    Configuration menu
    Copy the full SHA
    6b70bbd View commit details
    Browse the repository at this point in the history

  8. Add XML documentation for RegistryUtil class 

    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>
    @ivandrofly
    ivandrofly committed Sep 17, 2024
    Configuration menu
    Copy the full SHA
    6c0006a View commit details
    Browse the repository at this point in the history

  9. Add XML documentation to Retry class methods 

    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>
    @ivandrofly
    ivandrofly committed Sep 17, 2024
    Configuration menu
    Copy the full SHA
    1123559 View commit details
    Browse the repository at this point in the history

  10. Add XML documentation for Utility methods 

    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>
    @ivandrofly
    ivandrofly committed Sep 17, 2024
    Configuration menu
    Copy the full SHA
    b668296 View commit details
    Browse the repository at this point in the history

  11. Clarify utility class documentation 

    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>
    @ivandrofly
    ivandrofly committed Sep 17, 2024
    Configuration menu
    Copy the full SHA
    9f30bbe View commit details
    Browse the repository at this point in the history