style(jsdoc): ensure components documentation

Author: lykmapipo

src/Auth/SecureRoute.js

@@ -9,7 +9,7 @@ import PropTypes from 'prop-types';
  * @description Route which check authentication status and route to appropriate
  *  component
  *
- * @param {object} properties  React props
+ * @param {object} properties props object
  *
  * @returns {object} React Element
  *

src/Auth/components/ChangePassword/index.js

@@ -27,12 +27,12 @@ const formItemLayout = {
 
 /**
  * @function
- * @param props.user
- * @param props.posting
- * @param props.onCancel
+ * @param {object} props props object
+ * @param {object} props.user user object
+ * @param {boolean} props.posting posting flag
+ * @param {Function} props.onCancel cancel callback
  * @name ChangePasswordForm
  * @description Change password form to allow current logged in  user to update password
- * @param {object} props Change Password form props
  * @returns {object} React component
  * @version 0.1.0
  * @since 0.1.0

src/Auth/components/SignIn/index.js

@@ -11,7 +11,7 @@ import './styles.css';
  * @function
  * @name SignInForm
  * @description Sign In form  component
- * @param {object} props React props
+ * @param {object} props props object
  * @param {boolean} props.loading Flag for showing login http request state
  * @param {object} props.history Browser history object
  * @returns {object} Sign In Form

src/Events/Events/ChangelogForm/index.js

@@ -51,14 +51,14 @@ const formItemLayout = {
 
 /**
  * @function
- * @param props.event
- * @param props.posting
- * @param props.onCancel
- * @param props.action
+ * @param {object} props Event Changelog Form properties
+ * @param {object} props.event event object
+ * @param {boolean} props.posting posting flag
+ * @param {Function} props.onCancel cancel callback
+ * @param {string} props.action valid action
  * @name EventChangelogForm
  * @description Render Event form for creating and updating stakeholder
  * event details
- * @param {object} props Event Changelog Form properties
  * @returns {object} Event Changelog Form
  * @version 0.2.1
  * @since 0.1.0

src/Events/Events/DetailsView/Body.js

@@ -60,15 +60,15 @@ const { Paragraph, Text } = Typography;
 
 /**
  * @function
- * @param props.event
- * @param props.openForm
- * @param props.onEdit
- * @param props.onShare
- * @param props.openIndicatorDashboard
- * @param props.onContent
+ * @param {object} props props object
+ * @param {object} props.event valid event objetc
+ * @param {Function} props.openForm open callback
+ * @param {Function} props.onEdit edit callback
+ * @param {Function} props.onShare share callback
+ * @param {Function} props.openIndicatorDashboard indicator callback
+ * @param {Function} props.onContent content callback
  * @name EventToolbar
  * @description List of actions user can perform on a particular event
- * @param {object} props React props
  * @returns {object} React component
  * @version 0.1.0
  * @since 0.1.0
@@ -223,10 +223,10 @@ const EventToolbar = ({
 
 /**
  * @function
- * @param props.cause
+ * @param {object} props props object
+ * @param {string} props.cause event cause
  * @name EventCause
  * @description Display Event Cause
- * @param {object} props React props
  * @returns {object} React component
  * @version 0.1.0
  * @since 0.1.0
@@ -242,11 +242,11 @@ const EventCause = ({ cause }) => {
 
 /**
  * @function
- * @param props.title
- * @param props.actions
+ * @param {object} props props object
+ * @param {string} props.title valid title
+ * @param {*} props.actions valid actions
  * @name EventDetailsSectionHeader
  * @description Header section for event details drawer
- * @param {object} props React props
  * @returns {object} React component
  * @version 0.1.0
  * @since 0.1.0
@@ -261,9 +261,9 @@ export const EventDetailsSectionHeader = ({ title, actions }) => {
 };
 
 /**
- * @param root0
- * @param root0.areas
- * @param root0.openForm
+ * @param {object} props props object
+ * @param {object[]} props.areas list of areas
+ * @param {Function} props.openForm open callback
  * @function
  * @name EventLocations
  * @description Section which show event location(s) in hierarchy
@@ -295,8 +295,8 @@ export const EventLocations = ({ areas = [], openForm }) => {
 };
 
 /**
- * @param root0
- * @param root0.places
+ * @param {object} props props object
+ * @param {*} props.places valid places
  * @function
  * @name EventPlaces
  * @description Section which show event affected place(s) in hierarchy
@@ -316,11 +316,11 @@ export const EventPlaces = ({ places = '' }) => {
 
 /**
  * @function
- * @param props.actions
- * @param props.openForm
+ * @param {object} props Event action taken props
+ * @param {object[]} props.actions valid actions
+ * @param {Function} props.openForm open callback
  * @name EventActionsTaken
  * @description Section which show actions taken per event
- * @param {object} props Event action taken props
  * @returns {object} React component
  * @version 0.1.0
  * @since 0.1.0
@@ -355,9 +355,9 @@ export const EventActionsTaken = ({ actions = [], openForm }) => {
 };
 
 /**
- * @param root0
- * @param root0.agencies
- * @param root0.openForm
+ * @param {object} props props object
+ * @param {object[]} props.agencies list of agencies
+ * @param {Function} props.openForm open callback
  * @function
  * @name EventRespondingAgencies
  * @description Section which show event responding agencies
@@ -393,9 +393,9 @@ export const EventRespondingAgencies = ({ agencies = [], openForm }) => {
 };
 
 /**
- * @param root0
- * @param root0.focalPeople
- * @param root0.openForm
+ * @param {object} props props object
+ * @param {object[]} props.focalPeople list of focal people
+ * @param {Function} props.openForm open callback
  * @function
  * @name EventRespondingFocalPeople
  * @description Section which show event responding agencies
@@ -436,11 +436,11 @@ export const EventRespondingFocalPeople = ({ focalPeople = [], openForm }) => {
 
 /**
  * @function
- * @param props.initiator
- * @param props.date
+ * @param {object} props Component props
+ * @param {object} props.initiator valid initiator
+ * @param {Date} props.date valid date
  * @name EventFeedItemHeader
  * @description Render Event feed item header
- * @param {object} props Component props
  * @returns {object} EventFeedItemHeader component
  * @version 0.1.0
  * @since 0.1.0
@@ -455,8 +455,8 @@ const EventFeedItemHeader = ({ initiator, date }) => {
 };
 
 /**
- * @param root0
- * @param root0.openForm
+ * @param {object} props props object
+ * @param {Function} props.openForm open callback
  * @function
  * @name EventImpact
  * @description Display Event impact based on indicators
@@ -499,11 +499,11 @@ const EventImpact = ({ openForm }) => {
 
 /**
  * @function
- * @param props.gaps
- * @param props.openForm
+ * @param {object} props React components props
+ * @param {object[]} props.gaps list of gaps
+ * @param {Function} props.openForm open callback
  * @name EventGaps
  * @description Event Gaps and Constraints
- * @param {object} props React components props
  * @returns {object} EventGaps
  * @version 0.1.0
  * @since 0.1.0
@@ -537,11 +537,11 @@ const EventGaps = ({ gaps = [], openForm }) => {
 
 /**
  * @function
- * @param props.recommendations
- * @param props.openForm
+ * @param {object} props React components props
+ * @param {object[]} props.recommendations list of recommendations
+ * @param {Function} props.openForm open callback
  * @name EventRecommendations
  * @description Event Recommendations and Remarks
- * @param {object} props React components props
  * @returns {object} EventRecommendations
  * @version 0.1.0
  * @since 0.1.0
@@ -741,12 +741,12 @@ const renderFeed = (feed) => {
 
 /**
  * @function
- * @param props.feeds
- * @param props.loading
- * @param props.hasMore
+ * @param {object} props React props
+ * @param {object[]} props.feeds list of feeds
+ * @param {boolean} props.loading loading flag
+ * @param {boolean} props.hasMore more flag
  * @name EventFeed
  * @description A list of activities(feeds) happening on a particular event
- * @param {object} props React props
  * @returns {object} React component
  * @version 0.1.0
  * @since 0.1.0
@@ -787,14 +787,14 @@ export const EventFeed = ({ feeds = [], loading, hasMore }) => {
 
 /**
  * @function
- * @param props.type
- * @param props.description
- * @param props.number
- * @param props.reportedDate
+ * @param {object} props PrintEventDetails Props
+ * @param {string} props.type event type
+ * @param {string} props.description event description
+ * @param {string} props.number event number
+ * @param {Date} props.reportedDate event report date
  * @name PrintedEventDetails
  * @description This is event details section which will be visible on printed
  * report only
- * @param {object} props PrintEventDetails Props
  * @returns {object} PrintedEventDetails Component
  * @version 0.1.0
  * @since 0.1.0
@@ -820,18 +820,18 @@ const PrintedEventDetails = ({ type, description, number, reportedDate }) => {
 
 /**
  * @function
- * @param props.event
- * @param props.showForm
- * @param props.posting
- * @param props.changelogs
- * @param props.loading
- * @param props.hasMore
- * @param props.onEdit
- * @param props.onShare
- * @param props.eventPosting
+ * @param {object} props React props
+ * @param {object} props.event valid event
+ * @param {boolean} props.showForm show flag
+ * @param {boolean} props.posting posting flag
+ * @param {object[]} props.changelogs list of changelogs
+ * @param {boolean} props.loading loading flag
+ * @param {boolean} props.hasMore more flag
+ * @param {Function} props.onEdit edit callback
+ * @param {Function} props.onShare share callback
+ * @param {boolean} props.eventPosting event posting flag
  * @name EventDetailsViewBody
  * @description Event Details body view
- * @param {object} props React props
  * @returns {object} React component
  * @version 0.1.0
  * @since 0.1.0

src/Events/Events/DetailsView/Header.js

@@ -6,13 +6,13 @@ const { Text } = Typography;
 
 /**
  * @function
- * @param props.number
- * @param props.type
- * @param props.description
- * @param props.stage
+ * @param {object} props props object
+ * @param {string} props.number event number
+ * @param {string} props.type event type
+ * @param {string} props.description event description
+ * @param {string} props.stage event stage
  * @name EventDetailsViewHeader
  * @description Event Details header for drawer
- * @param {object} props React props
  * @returns {object} React component
  * @version 0.1.0
  * @since 0.1.0

src/Events/Events/Form/index.js

@@ -39,15 +39,15 @@ const formItemLayout = {
 
 /**
  * @function
- * @param props.isEditForm
- * @param props.defaultStage
- * @param props.stages
- * @param props.event
- * @param props.posting
- * @param props.onCancel
+ * @param {object} props props object
+ * @param {boolean} props.isEditForm edit flag
+ * @param {string} props.defaultStage default stage
+ * @param {string[]} props.stages allowed stages
+ * @param {object} props.event event object
+ * @param {boolean} props.posting posting flag
+ * @param {Function} props.onCancel cancel callback
  * @name EventForm
  * @description Event Form component for creating and editing event
- * @param {object} props React props
  * @returns {object} React component
  * @version 0.1.0
  * @since 0.1.0

src/GeographicalFeatures/AdministrativeLevels/Form/index.js

@@ -28,13 +28,13 @@ const formItemLayout = {
 
 /**
  * @function
- * @param props.administrativeLevel
- * @param props.isEditForm
- * @param props.posting
- * @param props.onCancel
+ * @param {object} props props object
+ * @param {*} props.administrativeLevel valid administrative level
+ * @param {boolean} props.isEditForm edit flag
+ * @param {boolean} props.posting posting flag
+ * @param {Function} props.onCancel cancel callback
  * @name AdministrativeLevelForm
  * @description Administrative Level Form
- * @param {object} props React props
  * @returns {object} React Component
  * @version 0.1.0
  * @since 0.1.0

src/GeographicalFeatures/EvacuationCenters/List/index.js

@@ -9,9 +9,8 @@ import EvacuationCenterListItem from '../ListItem';
  * @name EvacuationCenterList
  * @description Render Evacuation Center list
  * @param {object} props props object
- * @param props.evacuationCenters
+ * @param {object[]} props.evacuationCenters list of evacuation centers
  * @param {boolean} props.loading preload list of Evacuation Center
- * @param {Array} props.districts array list of Evacuation Center
  * @param {Function} props.onEdit function for editing Evacuation Center
  * @returns {object} React component
  * @version 0.1.0

src/GeographicalFeatures/Facilities/List/index.js

@@ -9,9 +9,8 @@ import FacilityListItem from '../ListItem';
  * @name FacilityList
  * @description Render facilities list
  * @param {object} props props object
- * @param props.facilities
+ * @param {object[]} props.facilities list of facilities
  * @param {boolean} props.loading preload list of facilities
- * @param {Array} props.districts array list of facilities
  * @param {Function} props.onEdit function for editing facilities
  * @returns {object} React Component
  * @version 0.1.0

src/GeographicalFeatures/FeatureTypes/Form/index.js

@@ -29,13 +29,13 @@ const formItemLayout = {
 
 /**
  * @function
- * @param props.featureType
- * @param props.isEditForm
- * @param props.posting
- * @param props.onCancel
+ * @param {object} props props object
+ * @param {object} props.featureType valid feature type
+ * @param {boolean} props.isEditForm edit flag
+ * @param {boolean} props.posting posting flag
+ * @param {Function} props.onCancel cancel callback
  * @name FeatureTypeForm
  * @description Feature Type Form
- * @param {object} props React props
  * @returns {object} React Component
  * @version 0.1.0
  * @since 0.1.0