Add KDoc documentation to Overflow.kt#55334
Closed
mdvacca wants to merge 19 commits intofacebook:mainfrom
Closed
Conversation
mdvacca
force-pushed
the
export-D91555087
branch
from
aae05d7 to
7fc44aa
Compare
meta-cla
bot
added
the
CLA Signed
facebook-github-bot
added
the
Shared with Meta
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
Summary: Added KDoc documentation to BorderColors.kt: - ColorEdges data class: Documented purpose and properties (left, top, right, bottom) - BorderColors value class: Documented logical edge color storage and resolution - resolve() method: Documented layout direction handling and RTL support changelog: [internal] internal Reviewed By: lenaic Differential Revision: D91554628
Summary: Enhanced KDoc documentation for CornerRadii.kt: - Expanded class documentation with detailed explanation - Added property documentation for horizontal and vertical radii - Documented secondary constructor for LengthPercentage resolution - Added toPixelFromDIP() method documentation changelog: [internal] internal Reviewed By: lenaic Differential Revision: D91554663
Summary: Converted inline comments to proper KDoc documentation: - ColorStop class: Documented gradient color stop with examples - ProcessedColorStop class: Documented processed color stop after fix-up - ColorStopUtils object: Added comprehensive documentation explaining CSS spec compliance - getFixedColorStops method: Documented the fix-up algorithm steps changelog: [internal] internal Reviewed By: javache Differential Revision: D91554709
Summary: Enhanced KDoc documentation for BorderRadiusStyle.kt: - BorderRadiusProp enum: Expanded documentation explaining physical vs logical properties - BorderRadiusStyle data class: Comprehensive class documentation - set()/get() methods: Added parameter and return documentation - hasRoundedBorders(): Added method documentation - resolve(): Documented layout direction handling and CSS spec compliance changelog: [internal] internal Reviewed By: javache Differential Revision: D91554764
Summary: Added comprehensive KDoc documentation to RadialGradient.kt: - RadialGradient class: Documented CSS radial gradient implementation with spec link - Shape enum: Documented CIRCLE and ELLIPSE values - GradientSize sealed class: Documented sizing options (Keyword and Dimensions) - KeywordType enum: Added property documentation changelog: [internal] internal Reviewed By: javache Differential Revision: D91554808
Summary: Added comprehensive KDoc documentation to LinearGradient.kt: - LinearGradient class: Documented CSS linear gradient implementation with spec link - Direction sealed class: Documented direction options - Angle class: Documented angle-based direction - Keyword class: Documented keyword-based direction - KeywordType enum: Added documentation for each corner keyword changelog: [internal] internal Reviewed By: javache Differential Revision: D91554850
Summary: Added KDoc documentation to the Gradient interface: - Interface documentation explaining CSS gradient to Android Shader conversion - getShader() method documentation with parameter and return descriptions - Added see references to implementations changelog: [internal] internal Reviewed By: javache Differential Revision: D91554867
Summary:
Enhanced KDoc documentation for BorderInsets.kt:
- Fixed typo in class documentation ("pox" -> "box")
- Expanded class documentation with see reference
- Added setBorderWidth() method documentation
- Added resolve() method documentation with layout direction handling
changelog: [internal] internal
Reviewed By: javache
Differential Revision: D91554902
Summary: Added KDoc documentation to BorderStyle.kt: - Enum documentation explaining CSS border-style correspondence - Documented each style value: SOLID, DASHED, DOTTED - Added fromString() method documentation changelog: [internal] internal Reviewed By: javache Differential Revision: D91554949
Summary: Added comprehensive KDoc documentation to LogicalEdge.kt: - Expanded enum documentation explaining physical vs logical edge naming - Documented each enum value: ALL, LEFT, RIGHT, TOP, BOTTOM, START, END, HORIZONTAL, VERTICAL, BLOCK_START, BLOCK_END, BLOCK - Added toSpacingType() method documentation - Added fromSpacingType() method documentation changelog: [internal] internal Reviewed By: javache Differential Revision: D91555014
Summary: Enhanced KDoc documentation for ComputedBorderRadius.kt: - ComputedBorderRadiusProp enum: Expanded documentation and documented each value - ComputedBorderRadius data class: Enhanced class documentation with property descriptions - hasRoundedBorders(): Added method documentation - isUniform(): Added method documentation - get(): Added method documentation - Secondary constructor: Added documentation changelog: [internal] internal Reviewed By: javache Differential Revision: D91555054
Summary: Added KDoc documentation to Overflow.kt: - Enum documentation explaining CSS overflow correspondence - Documented each value: VISIBLE, HIDDEN, SCROLL - Added fromString() method documentation changelog: [internal] internal Reviewed By: javache Differential Revision: D91555087
mdvacca
force-pushed
the
export-D91555087
branch
from
7fc44aa to
2858ac6
Compare
Contributor
|
Closed as already merged |
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 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:
Added KDoc documentation to Overflow.kt:
changelog: [internal] internal
Reviewed By: javache
Differential Revision: D91555087