Fix Javadocs broken by google-java-format

Summary: After we ran google-java-format D16071725, some Javadocs which weren't properly written broke. This includes putting unordered and ordered lists not using <ul> and <ol>, putting code blocks and pseudo-graphics not using <pre>. I ran through all the changed classes and tried to fix the broken Javadocs.

Reviewed By: cpojer

Differential Revision: D16090087

fbshipit-source-id: f31971cbc0e367a04814ff90bbfb2192751d5e16
This commit is contained in:
Oleksandr Melnykov
2019-07-02 09:28:53 -07:00
committed by Facebook Github Bot
parent 6c0f73b322
commit cd05a85fe5
22 changed files with 271 additions and 112 deletions
@@ -38,10 +38,14 @@ import javax.annotation.Nullable;
* <p>Keep in mind that all JS remote method calls and script load calls are asynchronous and you
* should not expect them to return results immediately.
*
* <p>In order to write catalyst integration: 1) Make {@link ReactIntegrationTestCase} a base class
* of your test case 2) Use {@link ReactTestHelper#catalystInstanceBuilder()} instead of {@link
* com.facebook.react.bridge.CatalystInstanceImpl.Builder} to build catalyst instance for testing
* purposes
* <p>In order to write catalyst integration:
*
* <ol>
* <li>Make {@link ReactIntegrationTestCase} a base class of your test case
* <li>Use {@link ReactTestHelper#catalystInstanceBuilder()} instead of {@link
* com.facebook.react.bridge.CatalystInstanceImpl.Builder} to build catalyst instance for
* testing purposes
* </ol>
*/
public abstract class ReactIntegrationTestCase extends AndroidTestCase {
@@ -17,9 +17,22 @@ import com.facebook.react.uimanager.UIManagerModule;
* UIManagerModule#measureLayoutRelativeToParent}. Tests measurement for views in the following
* hierarchy:
*
* <p>+---------------------------------------------+ | A | | | | +-----------+ +---------+ | | | B
* | | D | | | | +---+ | | | | | | | C | | | | | | | | | | +---------+ | | | +---+ | | |
* +-----------+ | | | | | | | +---------------------------------------------+
* <pre>
* +---------------------------------------------+
* | A |
* | |
* | +-----------+ +---------+ |
* | | B | | D | |
* | | +---+ | | | |
* | | | C | | | | |
* | | | | | +---------+ |
* | | +---+ | |
* | +-----------+ |
* | |
* | |
* | |
* +---------------------------------------------+
* </pre>
*
* <p>View locations and dimensions: A - (0,0) to (500, 500) (500x500) B - (50,80) to (250, 380)
* (200x300) C - (150,150) to (200, 300) (50x150) D - (400,100) to (450, 300) (50x200)
@@ -130,9 +130,13 @@ public class CatalystMultitouchHandlingTestCase extends ReactAppInstrumentationT
* This method "replay" multi-touch gesture recorded with modified TouchesHelper class that
* generated this piece of code (see https://phabricator.fb.com/P19756940). This is not intended
* to be copied/reused and once we need to have more multitouch gestures in instrumentation tests
* we should either: - implement nice generator similar to {@link SingleTouchGestureGenerator} -
* implement gesture recorded that will record touch data using arbitrary format and then read
* this recorded touch sequence during tests instead of generating code like this
* we should either:
*
* <ul>
* <li>implement nice generator similar to {@link SingleTouchGestureGenerator}
* <li>implement gesture recorded that will record touch data using arbitrary format and then
* read this recorded touch sequence during tests instead of generating code like this
* </ul>
*/
private void generateRecordedPinchTouchEvents() {
// START OF GENERATED CODE
@@ -52,12 +52,27 @@ public class CatalystSubviewsClippingTestCase extends ReactAppInstrumentationTes
}
/**
* In this test view are layout in a following way: +-----------------------------+ | | |
* +---------------------+ | | | inner1 | | | +---------------------+ | |
* +-------------------------+ | | | outer (clip=true) | | | | +---------------------+ | | | | |
* inner2 | | | | | +---------------------+ | | | | | | | +-------------------------+ | |
* +---------------------+ | | | inner3 | | | +---------------------+ | | |
* In this test view are layout in a following way:
*
* <pre>
* +-----------------------------+
* | |
* | +---------------------+ |
* | | inner1 | |
* | +---------------------+ |
* | +-------------------------+ |
* | | outer (clip=true) | |
* | | +---------------------+ | |
* | | | inner2 | | |
* | | +---------------------+ | |
* | | | |
* | +-------------------------+ |
* | +---------------------+ |
* | | inner3 | |
* | +---------------------+ |
* | |
* +-----------------------------+
* </pre>
*
* <p>We expect only outer and inner2 to be attached
*/
@@ -69,11 +84,29 @@ public class CatalystSubviewsClippingTestCase extends ReactAppInstrumentationTes
}
/**
* In this test view are layout in a following way: +-----------------------------+ | outer
* (clip=true) | | | | | | | | +-----------------------------+ | | complexInner (clip=true) | | |
* +----------+ | +---------+ | | | | inner1 | | | inner2 | | | | | | | | | | | | +----------+ |
* +---------+ | +--------------+--------------+ | | +----------+ +---------+ | | | inner3 | |
* inner4 | | | | | | | | | +----------+ +---------+ | | | +-----------------------------+
* In this test view are layout in a following way:
*
* <pre>
* In this test view are layout in a following way:
* +-----------------------------+
* | outer (clip=true) |
* | |
* | |
* | |
* | +-----------------------------+
* | | complexInner (clip=true) |
* | | +----------+ | +---------+ |
* | | | inner1 | | | inner2 | |
* | | | | | | | |
* | | +----------+ | +---------+ |
* +--------------+--------------+ |
* | +----------+ +---------+ |
* | | inner3 | | inner4 | |
* | | | | | |
* | +----------+ +---------+ |
* | |
* +-----------------------------+
* </pre>
*
* <p>We expect outer, complexInner & inner1 to be attached
*/
@@ -16,16 +16,31 @@ import com.facebook.react.testing.StringRecordingModule;
* This test is to verify that touch events bubbles up to the right handler. We emulate couple of
* different gestures on top of the application reflecting following layout:
*
* <p>+---------------------------------------------------------------------------------------+ | |
* | +----------------------------------------------------------------------------------+ | | |
* +-------------+ +----------------+ | | | | | +---+ | | | | | | | | | A | | | | | | | | | +---+ |
* | C | | | | | | {B} | | | | | | | | | {D} | | | | | | +-------------+ +----------------+ | | | |
* | | | | | | |
* +----------------------------------------------------------------------------------+ | | |
* +----------------------------------------------------------------------------------+ | | | | | |
* | | | | | | | | | {E} | | | | | | | | | | |
* +----------------------------------------------------------------------------------+ |
* <pre>
* +---------------------------------------------------------------------------------------+
* | |
* | +----------------------------------------------------------------------------------+ |
* | | +-------------+ +----------------+ | |
* | | | +---+ | | | | |
* | | | | A | | | | | |
* | | | +---+ | | C | | |
* | | | {B} | | | | |
* | | | | {D} | | | |
* | | +-------------+ +----------------+ | |
* | | | |
* | | | |
* | +----------------------------------------------------------------------------------+ |
* |
* | +----------------------------------------------------------------------------------+ |
* | | | |
* | | | |
* | | | |
* | | {E} | |
* | | | |
* | | | |
* | +----------------------------------------------------------------------------------+ |
* +---------------------------------------------------------------------------------------+
* </pre>
*
* <p>Then in each test case we either tap the center of a particular view (from A to E) or we start
* a gesture in one view and end it with another. View with names in brackets (e.g. {D}) have touch