update code comments

https://github.com/Expensify/react-native/pull/57/files#r1204428114
Expensify · May 25, 2023 · 12b51dd · 12b51dd
1 parent 7dbfde4
commit 12b51dd
Show file tree

Hide file tree

Showing 5 changed files with 21 additions and 14 deletions.
diff --git a/packages/react-native/Libraries/Text/RCTTextAttributes.m b/packages/react-native/Libraries/Text/RCTTextAttributes.m
@@ -130,7 +130,8 @@ - (NSParagraphStyle *)effectiveParagraphStyle
 
   if (!isnan(_lineHeight)) {
     CGFloat lineHeight = _lineHeight * self.effectiveFontSizeMultiplier;
-    // text with lineHeight lower then font.lineHeight does not correctly vertically align
+
+    // Text with lineHeight lower than font.lineHeight does not correctly vertically align.
     if (lineHeight > self.effectiveFont.lineHeight) {
       paragraphStyle.minimumLineHeight = lineHeight;
       paragraphStyle.maximumLineHeight = lineHeight;
@@ -175,7 +176,8 @@ - (NSParagraphStyle *)effectiveParagraphStyle
   NSParagraphStyle *paragraphStyle = [self effectiveParagraphStyle];
   if (paragraphStyle) {
     attributes[NSParagraphStyleAttributeName] = paragraphStyle;
-    // The baseline aligns the text vertically in the line height
+
+    // The baseline aligns the text vertically in the line height (_UITextLayoutFragmentView).
     if (!isnan(paragraphStyle.maximumLineHeight) && paragraphStyle.maximumLineHeight >= font.lineHeight) {
       CGFloat baseLineOffset = (paragraphStyle.maximumLineHeight - font.lineHeight) / 2.0;
       attributes[NSBaselineOffsetAttributeName] = @(baseLineOffset);

diff --git a/packages/react-native/Libraries/Text/TextInput/Multiline/RCTUITextView.m b/packages/react-native/Libraries/Text/TextInput/Multiline/RCTUITextView.m
@@ -172,7 +172,8 @@ - (void)paste:(id)sender
 - (void)setTextBorderInsetsAndFrame:(CGRect)bounds textBorderInsets:(UIEdgeInsets)textBorderInsets
 {
   _textBorderInsets = textBorderInsets;
-  // We apply `borderInsets` as `RCTUITextView` layout offset.
+
+  // We apply `borderInsets` as the `RCTUITextView` layout offset.
   self.frame = UIEdgeInsetsInsetRect(bounds, textBorderInsets);
   [self setNeedsLayout];
 }

diff --git a/packages/react-native/Libraries/Text/TextInput/RCTBaseTextInputShadowView.m b/packages/react-native/Libraries/Text/TextInput/RCTBaseTextInputShadowView.m
@@ -178,17 +178,20 @@ - (void)uiManagerWillPerformMounting
     baseTextInputView.textAttributes = textAttributes;
     baseTextInputView.reactBorderInsets = borderInsets;
 
-    // Fixes iOS issue caused by adding paragraphStyle.maximumLineHeight to an iOS UITextField.
-    // The CALayer _UITextLayoutFragmentView does not align correctly (see issue #28012).
+    // The CALayer _UITextLayoutFragmentView does not align correctly 
+    // when adding paragraphStyle.maximumLineHeight to an iOS UITextField (issue #28012).
     if (!isnan(textAttributes.lineHeight) && !isnan(textAttributes.effectiveFont.lineHeight)) {
       CGFloat effectiveLineHeight = textAttributes.lineHeight * textAttributes.effectiveFontSizeMultiplier;
       CGFloat fontLineHeight = textAttributes.effectiveFont.lineHeight;
       if (effectiveLineHeight >= fontLineHeight * 2.0) {
         CGFloat height = self.layoutMetrics.frame.size.height;
         CGFloat width =  self.layoutMetrics.frame.size.width;
-        // sets the same origin.y coordinates for _UITextLayoutFragmentView and UITextField frame
+
+        // Setting contentVerticalAlignment to UIControlContentVerticalAlignmentTop aligns 
+        // _UITextLayoutFragmentView and UITextField on the same ordinate (y coordinate).
         baseTextInputView.contentVerticalAlignment = UIControlContentVerticalAlignmentTop;
-        // vertically center aligns the _UITextLayoutFragmentView in the parent UITextField 
+
+        // Align vertically _UITextLayoutFragmentView in the center of the UITextField (TextInput).
         CGFloat padding = (height - effectiveLineHeight) / 2.0;
         baseTextInputView.fragmentViewContainerBounds = CGRectMake(0, padding, width, effectiveLineHeight);
       }

diff --git a/packages/react-native/Libraries/Text/TextInput/RCTBaseTextInputView.m b/packages/react-native/Libraries/Text/TextInput/RCTBaseTextInputView.m
@@ -77,15 +77,15 @@ - (void)enforceTextAttributesIfNeeded
 }
 
 // Fixes iOS alignment issue caused by adding paragraphStyle.maximumLineHeight to an iOS UITextField
-// vertically aligns _UITextLayoutFragmentView with the parent view UITextField
+// and vertically aligns _UITextLayoutFragmentView with the parent view UITextField.
 - (void)setContentVerticalAlignment:(UIControlContentVerticalAlignment)contentVerticalAlignment
 {
   _contentVerticalAlignment = contentVerticalAlignment;
   self.backedTextInputView.contentVerticalAlignment = contentVerticalAlignment;
 }
 
-// Custom bounds used to control vertical position of CALayer _UITextLayoutFragmentView
-// _UITextLayoutFragmentView is the CALayer of UITextField
+// Custom bounds used to control vertical position of CALayer _UITextLayoutFragmentView.
+// _UITextLayoutFragmentView is the CALayer of UITextField.
 - (void)setFragmentViewContainerBounds:(CGRect)fragmentViewContainerBounds
 {
   _fragmentViewContainerBounds = fragmentViewContainerBounds;
@@ -103,7 +103,8 @@ - (void)setReactPaddingInsets:(UIEdgeInsets)reactPaddingInsets
 - (void)setReactBorderInsets:(UIEdgeInsets)reactBorderInsets
 {
   _reactBorderInsets = reactBorderInsets;
-  // Borders are added using insets (UITextField textRectForBound, UITextView setFrame)
+
+  // Borders are added using insets (UITextField textRectForBound, UITextView setFrame).
   [self.backedTextInputView setTextBorderInsetsAndFrame:self.bounds textBorderInsets:reactBorderInsets];
 }
 

diff --git a/packages/react-native/Libraries/Text/TextInput/Singleline/RCTUITextField.m b/packages/react-native/Libraries/Text/TextInput/Singleline/RCTUITextField.m
@@ -163,13 +163,13 @@ - (CGRect)caretRectForPosition:(UITextPosition *)position
 
 - (CGRect)textRectForBounds:(CGRect)bounds
 {
-  // Text is vertically aligned to the center
+  // Text is vertically aligned to the center.
   CGFloat leftPadding = _textContainerInset.left + _textBorderInsets.left;
   CGFloat rightPadding = _textContainerInset.right + _textBorderInsets.right;
   UIEdgeInsets borderAndPaddingInsets = UIEdgeInsetsMake(_textContainerInset.top, leftPadding, _textContainerInset.bottom, rightPadding);
   if (self.fragmentViewContainerBounds.size.height > 0) {
-    // apply custom bounds to fix iOS UITextField issue with lineHeight
-    // sets the correct y coordinates for _UITextLayoutFragmentView
+    // Apply custom bounds to fix iOS UITextField issue with lineHeight.
+    // Sets the correct y coordinates for _UITextLayoutFragmentView.
     return UIEdgeInsetsInsetRect([super textRectForBounds:self.fragmentViewContainerBounds], borderAndPaddingInsets);
   } else {
     return UIEdgeInsetsInsetRect([super textRectForBounds:bounds], borderAndPaddingInsets);