Skip to content

Commit f520ad3

Browse files
committed
Add documentation comments for the new classes
1 parent a1d13b0 commit f520ad3

File tree

9 files changed

+33
-1
lines changed

9 files changed

+33
-1
lines changed

packages/react-native/ReactAndroid/src/main/java/com/facebook/react/internal/views/text/EffectiveTextAttributeProvider.java

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,9 @@
55
import com.facebook.react.uimanager.ReactAccessibilityDelegate.Role;
66
import com.facebook.react.views.text.TextTransform;
77

8+
/**
9+
* Interface for an entity providing effective text attributes of a text node/fragment
10+
*/
811
public interface EffectiveTextAttributeProvider {
912
int UNSET = ReactFontManager.TypefaceStyle.UNSET;
1013

packages/react-native/ReactAndroid/src/main/java/com/facebook/react/internal/views/text/TextLayoutUtils.java

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -34,6 +34,9 @@
3434

3535
import java.util.List;
3636

37+
/**
38+
* Class containing static methods for building {@link Spannable}s
39+
*/
3740
public class TextLayoutUtils {
3841
private static final String INLINE_VIEW_PLACEHOLDER = "0";
3942
private static final int UNSET = ReactFontManager.TypefaceStyle.UNSET;

packages/react-native/ReactAndroid/src/main/java/com/facebook/react/internal/views/text/fragments/BridgeTextFragment.java

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,9 @@
55
import com.facebook.react.uimanager.ViewProps;
66
import com.facebook.react.views.text.TextAttributeProps;
77

8+
/**
9+
* A text fragment backed by a a {@link ReadableMap|
10+
*/
811
public class BridgeTextFragment implements TextFragment {
912
private final ReadableMap mFragment;
1013

packages/react-native/ReactAndroid/src/main/java/com/facebook/react/internal/views/text/fragments/BridgeTextFragmentList.java

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,9 @@
22

33
import com.facebook.react.bridge.ReadableArray;
44

5+
/**
6+
* A list of text fragments backed by a {@link ReadableArray}
7+
*/
58
public class BridgeTextFragmentList implements TextFragmentList {
69
private final ReadableArray mFragments;
710

packages/react-native/ReactAndroid/src/main/java/com/facebook/react/internal/views/text/fragments/MapBufferTextFragment.java

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,9 @@
1010
import static com.facebook.react.views.text.TextLayoutManagerMapBuffer.FR_KEY_TEXT_ATTRIBUTES;
1111
import static com.facebook.react.views.text.TextLayoutManagerMapBuffer.FR_KEY_WIDTH;
1212

13+
/**
14+
* A text fragment backed by a {@link MapBuffer}
15+
*/
1316
public class MapBufferTextFragment implements TextFragment {
1417
private final MapBuffer fragment;
1518

packages/react-native/ReactAndroid/src/main/java/com/facebook/react/internal/views/text/fragments/MapBufferTextFragmentList.java

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,9 @@
22

33
import com.facebook.react.common.mapbuffer.MapBuffer;
44

5+
/**
6+
* A list of text fragments backed by a {@link MapBuffer}
7+
*/
58
public class MapBufferTextFragmentList implements TextFragmentList {
69
private final MapBuffer mFragments;
710

packages/react-native/ReactAndroid/src/main/java/com/facebook/react/internal/views/text/fragments/TextFragment.java

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,9 @@
22

33
import com.facebook.react.views.text.TextAttributeProps;
44

5+
/**
6+
* Interface for a text fragment
7+
*/
58
public interface TextFragment {
69
TextAttributeProps getTextAttributeProps();
710

packages/react-native/ReactAndroid/src/main/java/com/facebook/react/internal/views/text/fragments/TextFragmentList.java

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,8 @@
11
package com.facebook.react.internal.views.text.fragments;
22

3+
/**
4+
* Interface for a list of text fragments
5+
*/
36
public interface TextFragmentList {
47
TextFragment getFragment(int index);
58

packages/react-native/ReactAndroid/src/main/java/com/facebook/react/views/text/ReactBaseTextShadowNode.java

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -51,12 +51,20 @@
5151
* can be used in concrete classes to feed native views and compute layout.
5252
*/
5353
public abstract class ReactBaseTextShadowNode extends LayoutShadowNode {
54+
/**
55+
* Implementation of {@link EffectiveTextAttributeProvider} that provides effective text
56+
* attributes based on a {@link ReactBaseTextShadowNode} instance and its parent.
57+
*/
5458
private static class HierarchicTextAttributeProvider implements EffectiveTextAttributeProvider {
5559
final private ReactBaseTextShadowNode textShadowNode;
5660
final private TextAttributes parentTextAttributes;
5761
final private TextAttributes textAttributes;
5862

59-
private HierarchicTextAttributeProvider(ReactBaseTextShadowNode textShadowNode, TextAttributes parentTextAttributes, TextAttributes textAttributes) {
63+
private HierarchicTextAttributeProvider(
64+
ReactBaseTextShadowNode textShadowNode,
65+
TextAttributes parentTextAttributes,
66+
TextAttributes textAttributes
67+
) {
6068
this.textShadowNode = textShadowNode;
6169
this.parentTextAttributes = parentTextAttributes;
6270
this.textAttributes = textAttributes;

0 commit comments

Comments
 (0)