Docs: Improve BackHandler documentation (addEventListener and removeE…

…ventListener)
facebook · Oct 31, 2017 · 622d6a8 · 622d6a8
1 parent 1dca01b
commit 622d6a8
Showing 1 changed file with 9 additions and 0 deletions.
diff --git a/Libraries/Utilities/BackHandler.android.js b/Libraries/Utilities/BackHandler.android.js
@@ -74,6 +74,12 @@ var BackHandler = {
     DeviceEventManager.invokeDefaultBackPressHandler();
   },
 
+  /**
+   * Adds an event handler. Supported events:
+   *
+   * - `hardwareBackPress`: Fires when the Android hardware back button is pressed or when the
+   * tvOS menu button is pressed.
+   */
   addEventListener: function (
     eventName: BackPressEventName,
     handler: Function
@@ -84,6 +90,9 @@ var BackHandler = {
     };
   },
 
+  /**
+   * Removes the event handler.
+   */
   removeEventListener: function(
     eventName: BackPressEventName,
     handler: Function