Thanks to visit codestin.com
Credit goes to github.com

Skip to content

docs: update and refine TSDoc for Colorus module#9

Merged
supitsdu merged 1 commit intomainfrom
docs
Jun 9, 2024
Merged

docs: update and refine TSDoc for Colorus module#9
supitsdu merged 1 commit intomainfrom
docs

Conversation

@supitsdu
Copy link
Owner

@supitsdu supitsdu commented Jun 9, 2024

  • Documented RgbObject, HslObject, HsvObject, and CmykObject interfaces
  • Added AnyColorType, AnyColorObject, and AnyColor type definitions
  • Introduced FormatOptions and HexFormatOptions interfaces with detailed descriptions
  • Updated Colorus class documentation with new methods and refined descriptions
  • Provided comprehensive examples for each method and property
  • Adjusted method descriptions to specify string return types for toRgb, toHsl, toHsv, and toCmyk
  • Enhanced clarity on default values and behavior of methods

This update enhances the clarity and usability of the Colorus module by providing thorough and structured documentation.

- Documented RgbObject, HslObject, HsvObject, and CmykObject interfaces
- Added AnyColorType, AnyColorObject, and AnyColor type definitions
- Introduced FormatOptions and HexFormatOptions interfaces with detailed descriptions
- Updated Colorus class documentation with new methods and refined descriptions
- Provided comprehensive examples for each method and property
- Adjusted method descriptions to specify string return types for toRgb, toHsl, toHsv, and toCmyk
- Enhanced clarity on default values and behavior of methods

This update enhances the clarity and usability of the Colorus module by providing thorough and structured documentation.
@supitsdu supitsdu added the 📚 Documentation Improvements or additions to documentation label Jun 9, 2024
@supitsdu supitsdu merged commit 5b01531 into main Jun 9, 2024
@supitsdu supitsdu deleted the docs branch June 10, 2024 04:14
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

📚 Documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant