Add KDoc documentation to BoxShadow.kt #55322
Open
+184
−1
Conversation
This file contains hidden or 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
meta-cla
bot
added
the
CLA Signed
mdvacca
force-pushed
the
export-D91554604
branch
from
348b626 to
f23abf5
Compare
facebook-github-bot
added
the
Shared with Meta
mdvacca
force-pushed
the
export-D91554604
branch
from
f23abf5 to
5ff80be
Compare
Summary: Added comprehensive KDoc documentation to the UIManagerType annotation class and its companion object constants. This improves code readability and provides better IDE support for developers working with UIManager types. The documentation explains: - The purpose of the annotation (distinguishing between legacy and Fabric UIManager) - Each constant (DEFAULT, LEGACY, FABRIC) and their use cases - Deprecation notes for the DEFAULT constant changelog: [internal] internal Reviewed By: cortinico Differential Revision: D91553347
Summary: Added KDoc documentation to the ViewUtil object and its NO_SURFACE_ID constant. The existing function documentation was already present. The documentation explains: - The purpose of the ViewUtil object (utilities for determining UIManager type) - The NO_SURFACE_ID constant and its usage as a placeholder for legacy UIManager changelog: [internal] internal Reviewed By: cortinico Differential Revision: D91553498
Summary: Added comprehensive KDoc documentation to BackgroundSize.kt classes and methods: - BackgroundSizeLengthPercentage: Documented class purpose, properties (x, y), and methods (isXAuto, isYAuto, parse) - BackgroundSize sealed class: Documented the sealed class hierarchy and LengthPercentageAuto subclass - Companion object parse methods: Added parameter and return documentation This improves code readability and provides better IDE support for developers. changelog: [internal] internal Reviewed By: lenaic Differential Revision: D91554301
Summary: Added KDoc documentation to BackgroundPosition.kt: - Class documentation explaining its purpose for CSS-like background positioning - Property documentation for top, left, right, bottom offset values - Parse method documentation with parameter and return descriptions changelog: [internal] internal Reviewed By: lenaic Differential Revision: D91554341
Summary: Added KDoc documentation to BackgroundRepeat.kt: - BackgroundRepeatKeyword enum: Documented each repeat behavior (Repeat, Space, Round, NoRepeat) - BackgroundRepeat class: Documented class purpose and x/y properties - Parse method: Added parameter and return documentation changelog: [internal] internal Reviewed By: cortinico Differential Revision: D91554444
Summary: Added KDoc documentation to the public BackgroundImageLayer class: - Class documentation explaining its purpose for gradient-based background layers - parse() method documentation with parameter descriptions - getShader() method documentation for shader generation changelog: [internal] internal Reviewed By: lenaic Differential Revision: D91554568
Summary: Updated and added KDoc documentation to BoxShadow.kt: - Fixed incorrect class documentation (was incorrectly describing border radius) - Added proper documentation explaining box shadow purpose and CSS correspondence - Documented all properties: offsetX, offsetY, color, blurRadius, spreadDistance, inset - Added parse method documentation with parameter descriptions changelog: [internal] internal Reviewed By: lenaic Differential Revision: D91554604
mdvacca
force-pushed
the
export-D91554604
branch
from
5ff80be to
0a584a7
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Summary:
Updated and added KDoc documentation to BoxShadow.kt:
changelog: [internal] internal
Reviewed By: lenaic
Differential Revision: D91554604