fix: add jsdocs definitions for the new functions

Expensify · Mar 21, 2023 · 0befe08 · 0befe08
1 parent 8e84ce8
commit 0befe08
Show file tree

Hide file tree

Showing 2 changed files with 13 additions and 0 deletions.
diff --git a/src/libs/getSafeAreaPaddingTop/index.android.js b/src/libs/getSafeAreaPaddingTop/index.android.js
@@ -1,5 +1,12 @@
 import {StatusBar} from 'react-native';
 
+/**
+ * Returns safe area padding top to use for a View
+ *
+ * @param {Object} insets
+ * @param {Boolean} statusBarTranslucent
+ * @returns {Number}
+ */
 export default function getSafeAreaPaddingTop(insets, statusBarTranslucent) {
     return (statusBarTranslucent && StatusBar.currentHeight) || 0;
 }
diff --git a/src/libs/getSafeAreaPaddingTop/index.js b/src/libs/getSafeAreaPaddingTop/index.js
@@ -1,3 +1,9 @@
+/**
+ * Takes safe area insets and returns padding top to use for a View
+ *
+ * @param {Object} insets
+ * @returns {Number}
+ */
 export default function getSafeAreaPaddingTop(insets) {
     return insets.top;
 }