Coding style: consistency, jsdocs

These modification are not necessarily directly related to the
containing PR, I merely saw them while reviewing the containing PR.
This commit is contained in:
Lyubo Marinov
2017-11-27 16:08:12 -06:00
parent 38629b437d
commit d1e5e6b93b
12 changed files with 103 additions and 126 deletions

View File

@@ -51,8 +51,8 @@ function getOverlays() {
}
/**
* Implements a React Component that will display the correct overlay when
* needed.
* Implements a React {@link Component} that will display the correct overlay
* when needed.
*/
class OverlayContainer extends Component {
/**
@@ -71,8 +71,8 @@ class OverlayContainer extends Component {
* Implements React's {@link Component#render()}.
*
* @inheritdoc
* @returns {ReactElement|null}
* @public
* @returns {ReactElement|null}
*/
render() {
const { overlay } = this.props;
@@ -82,13 +82,14 @@ class OverlayContainer extends Component {
}
/**
* Maps (parts of) the redux state to the associated OverlayContainer's props.
* Maps (parts of) the redux state to the associated {@code OverlayContainer}'s
* props.
*
* @param {Object} state - The redux state.
* @returns {{
* overlay: ?Object
* }}
* @private
* @returns {{
* overlay: ?Object
* }}
*/
function _mapStateToProps(state) {
let overlay;