Add basic documentation structure (#2386)

docs/docs/BottomTabs.md

@@ -0,0 +1,12 @@
+<a name="BottomTabs"></a>
+
+## BottomTabs
+**Properties**
+
+| Name | Type |
+| --- | --- |
+| tabs | <code>Array.&lt;Container&gt;</code> | 
+
+
+* * *
+

docs/docs/Button.md

@@ -0,0 +1,19 @@
+<a name="Button"></a>
+
+## Button
+**Properties**
+
+| Name | Type |
+| --- | --- |
+| id | <code>String</code> | 
+| testID | <code>string</code> | 
+| title | <code>string</code> | 
+| buttonColor | <code>string</code> | 
+| showAsAction | <code>string</code> | 
+| buttonFontWeight | <code>int</code> | 
+| disableIconTint | <code>boolean</code> | 
+| disabled | <code>boolean</code> | 
+
+
+* * *
+

docs/docs/Container.md

@@ -0,0 +1,13 @@
+<a name="Container"></a>
+
+## Container
+**Properties**
+
+| Name | Type | Description |
+| --- | --- | --- |
+| name | <code>string</code> | The container's registered name |
+| passProps | <code>Object</code> | props |
+
+
+* * *
+

docs/docs/Navigation.md

@@ -5,7 +5,16 @@
 * [Navigation](#Navigation)
     * [.registerContainer(containerName, getContainerFunc)](#Navigation+registerContainer)
     * [.setRoot(root)](#Navigation+setRoot)
+    * [.setDefaultOptions(options)](#Navigation+setDefaultOptions)
     * [.setOptions(containerId, options)](#Navigation+setOptions)
+    * [.showModal(params)](#Navigation+showModal)
+    * [.dismissModal(containerId)](#Navigation+dismissModal)
+    * [.dismissAllModals()](#Navigation+dismissAllModals)
+    * [.push(containerId, params)](#Navigation+push)
+    * [.pop(containerId, params)](#Navigation+pop)
+    * [.popTo(containerId)](#Navigation+popTo)
+    * [.popToRoot(containerId)](#Navigation+popToRoot)
+    * [.events()](#Navigation+events)
 
 
 * * *
@@ -35,6 +44,19 @@ Reset the navigation stack to a new screen (the stack root is changed).
 | root | <code>Root</code> | 
 
 
+* * *
+
+<a name="Navigation+setDefaultOptions"></a>
+
+### navigation.setDefaultOptions(options)
+Set default options to all screens. Useful for declaring a consistent style across the app.
+
+
+| Param | Type |
+| --- | --- |
+| options | <code>NavigationOptions</code> | 
+
+
 * * *
 
 <a name="Navigation+setOptions"></a>
@@ -45,9 +67,105 @@ Change a containers navigation options
 
 | Param | Type | Description |
 | --- | --- | --- |
-| containerId | <code>string</code> | Unique container name |
+| containerId | <code>string</code> | The container's id. |
 | options | <code>NavigationOptions</code> |  |
 
 
 * * *
 
+<a name="Navigation+showModal"></a>
+
+### navigation.showModal(params)
+Show a screen as a modal.
+
+
+| Param | Type |
+| --- | --- |
+| params | <code>Object</code> | 
+
+
+* * *
+
+<a name="Navigation+dismissModal"></a>
+
+### navigation.dismissModal(containerId)
+Dismiss a modal by containerId. The dismissed modal can be anywhere in the stack.
+
+
+| Param | Type | Description |
+| --- | --- | --- |
+| containerId | <code>String</code> | The container's id. |
+
+
+* * *
+
+<a name="Navigation+dismissAllModals"></a>
+
+### navigation.dismissAllModals()
+Dismiss all Modals
+
+
+* * *
+
+<a name="Navigation+push"></a>
+
+### navigation.push(containerId, params)
+Push a new screen into this screen's navigation stack.
+
+
+| Param | Type | Description |
+| --- | --- | --- |
+| containerId | <code>String</code> | The container's id. |
+| params | <code>\*</code> |  |
+
+
+* * *
+
+<a name="Navigation+pop"></a>
+
+### navigation.pop(containerId, params)
+Pop a container from the stack, regardless of it's position.
+
+
+| Param | Type | Description |
+| --- | --- | --- |
+| containerId | <code>String</code> | The container's id. |
+| params | <code>\*</code> |  |
+
+
+* * *
+
+<a name="Navigation+popTo"></a>
+
+### navigation.popTo(containerId)
+Pop the stack to a given container
+
+
+| Param | Type | Description |
+| --- | --- | --- |
+| containerId | <code>String</code> | The container's id. |
+
+
+* * *
+
+<a name="Navigation+popToRoot"></a>
+
+### navigation.popToRoot(containerId)
+Pop the container's stack to root.
+
+
+| Param | Type |
+| --- | --- |
+| containerId | <code>\*</code> | 
+
+
+* * *
+
+<a name="Navigation+events"></a>
+
+### navigation.events()
+Obtain the events registery instance
+
+
+* * *
+

docs/docs/NavigationOptions.md

@@ -0,0 +1,24 @@
+<a name="exp_module_NavigationOptions--NavigationOptions"></a>
+
+## NavigationOptions ⏏
+NavigationOptions are used by containers to customize their behavior and style.
+
+
+* * *
+
+<a name="module_NavigationOptions--NavigationOptions..NavigationOptions"></a>
+
+### NavigationOptions~NavigationOptions : <code>Object</code>
+**Properties**
+
+| Name | Type |
+| --- | --- |
+| topBar | <code>TopBar</code> | 
+| bottomTabs | <code>TabBar</code> | 
+| orientation | <code>String</code> | 
+| rightButtons | <code>Button</code> | 
+| leftButtons | <code>Button</code> | 
+
+
+* * *
+

docs/docs/Root.md

@@ -0,0 +1,14 @@
+<a name="Root"></a>
+
+## Root
+**Properties**
+
+| Name | Type |
+| --- | --- |
+| container | <code>Container</code> | 
+| sideMenu | <code>SideMenu</code> | 
+| bottomTabs | <code>BottomTabs</code> | 
+
+
+* * *
+

docs/docs/SideMenu.md

@@ -0,0 +1,13 @@
+<a name="SideMenu"></a>
+
+## SideMenu
+**Properties**
+
+| Name | Type |
+| --- | --- |
+| left | <code>Container</code> | 
+| right | <code>Container</code> | 
+
+
+* * *
+

docs/docs/TabBar.md

@@ -0,0 +1,16 @@
+<a name="TabBar"></a>
+
+## TabBar
+**Properties**
+
+| Name | Type |
+| --- | --- |
+| currentTabId | <code>string</code> | 
+| currentTabIndex | <code>number</code> | 
+| tabBadge | <code>number</code> | 
+| hidden | <code>boolean</code> | 
+| animateHide | <code>boolean</code> | 
+
+
+* * *
+

docs/docs/TopBar.md

@@ -0,0 +1,20 @@
+<a name="TopBar"></a>
+
+## TopBar
+**Properties**
+
+| Name | Type |
+| --- | --- |
+| title | <code>string</code> | 
+| backgroundColor | <code>color</code> | 
+| textColor | <code>color</code> | 
+| textFontSize | <code>number</code> | 
+| textFontFamily | <code>string</code> | 
+| hidden | <code>boolean</code> | 
+| animateHide | <code>boolean</code> | 
+| hideOnScroll | <code>boolean</code> | 
+| transparent | <code>boolean</code> | 
+
+
+* * *
+

lib/src/Navigation.js

@@ -46,47 +46,83 @@ class Navigation {
     return this.commands.setRoot(new Root(params));
   }
 
+  /**
+   * Set default options to all screens. Useful for declaring a consistent style across the app.
+   * @param {NavigationOptions} options
+   */
   setDefaultOptions(options) {
     this.commands.setDefaultOptions(options);
   }
 
   /**
    * Change a containers navigation options
-   * @param {string} containerId Unique container name
+   * @param {string} containerId The container's id.
    * @param {NavigationOptions} options
    */
   setOptions(containerId, options) {
     this.commands.setOptions(containerId, new NavigationOptions(options));
   }
 
+  /**
+   * Show a screen as a modal.
+   * @param {Object} params 
+   */
   showModal(params) {
     return this.commands.showModal(params);
   }
 
+  /**
+   * Dismiss a modal by containerId. The dismissed modal can be anywhere in the stack.
+   * @param {String} containerId The container's id.
+   */
   dismissModal(containerId) {
     return this.commands.dismissModal(containerId);
   }
 
+  /**
+   * Dismiss all Modals
+   */
   dismissAllModals() {
     return this.commands.dismissAllModals();
   }
 
-  push(onContainerId, params) {
-    return this.commands.push(onContainerId, params);
+  /**
+   * Push a new screen into this screen's navigation stack.
+   * @param {String} containerId The container's id.
+   * @param {*} params 
+   */
+  push(containerId, params) {
+    return this.commands.push(containerId, params);
   }
 
+  /**
+   * Pop a container from the stack, regardless of it's position.
+   * @param {String} containerId The container's id.
+   * @param {*} params 
+   */
   pop(containerId, params) {
     return this.commands.pop(containerId, params);
   }
 
+  /**
+   * Pop the stack to a given container
+   * @param {String} containerId The container's id.
+   */
   popTo(containerId) {
     return this.commands.popTo(containerId);
   }
 
+  /**
+   * Pop the container's stack to root.
+   * @param {*} containerId 
+   */
   popToRoot(containerId) {
     return this.commands.popToRoot(containerId);
   }
 
+  /**
+   * Obtain the events registery instance
+   */
   events() {
     return this.publicEventsRegistry;
   }

lib/src/params/BottomTabs.js

@@ -3,8 +3,6 @@ const Container = require('./Container');
 
 class BottomTabs {
   /**
-   * @constructor
-   * @typedef {Object} BottomTabs
    * @property {Container[]} tabs
    */
   constructor(tabs) {

lib/src/params/Container.js

@@ -1,6 +1,5 @@
 class Container {
   /**
-   * @typedef {Object} Container
    * @property {string} name The container's registered name
    * @property {Object} [passProps] props
    */

lib/src/params/Root.js

@@ -4,7 +4,6 @@ const BottomTabs = require('./BottomTabs');
 
 class Root {
   /**
-   * @typedef {Object} Root
    * @property {Container} container
    * @property {SideMenu} [sideMenu]
    * @property {BottomTabs} [bottomTabs]

lib/src/params/SideMenu.js

@@ -2,7 +2,6 @@ const Container = require('./Container');
 
 class SideMenu {
   /**
-  * @typedef {Object} SideMenu
   * @property {Container} [left]
   * @property {Container} [right]
   */

lib/src/params/TabBar.js

@@ -2,7 +2,6 @@ const { isEmpty } = require('lodash');
 
 class TabBar {
   /**
-   * @typedef {Object} TabBar
    * @property {string} [currentTabId]
    * @property {number} [currentTabIndex]
    * @property {number} [tabBadge]

lib/src/params/TopBar.js

@@ -1,6 +1,5 @@
 class TopBar {
   /**
-   * @typedef {Object} TopBar
    * @property {string} [title]
    * @property {color} [backgroundColor]
    * @property {color} [textColor]

scripts/generate-js-doc.js

@@ -2,7 +2,7 @@ const jsdoc2md = require('jsdoc-to-markdown');
 const fs = require('fs');
 const path = require('path');
 
-const inputFiles = ['./lib/src/params/NavigationOptions.js', './lib/src/Navigation.js'];
+const paramsDir = './lib/src/params/';
 const outputDir = './docs/docs/';
 const partial = ['./docs/templates/scope.hbs', './docs/templates/docs.hbs'];
 
@@ -35,4 +35,11 @@ function createDocFileForClass(className, templateData) {
   fs.writeFileSync(path.resolve(outputDir, `${className}.md`), output);
 }
 
-inputFiles.forEach((inputFile) => generateMarkdownForFile(inputFile));
+function inputFiles() {
+  return [
+    './lib/src/Navigation.js',
+    ...fs.readdirSync(paramsDir).map((file) => paramsDir + file)
+  ];
+}
+
+inputFiles().forEach((inputFile) => generateMarkdownForFile(inputFile));