docs: improve jsdoc base on new v25 jsdoc eslint

see #330

src/Auth/components/ChangePassword/index.js

@@ -27,6 +27,9 @@ const formItemLayout = {
 
 /**
  * @function
+ * @param props.user
+ * @param props.posting
+ * @param props.onCancel
  * @name ChangePasswordForm
  * @description Change password form to allow current logged in  user to update password
  * @param {object} props Change Password form props

src/Auth/components/SignIn/index.js

@@ -9,9 +9,10 @@ import './styles.css';
 
 /**
  * @function
+ * @param props.loading
+ * @param props.history
  * @name SignInForm
  * @description Sign In form  component
- *
  * @param {object} props React props
  * @returns {object} Sign In Form
  * @version 0.1.0

src/Dashboards/EventsOverview.js

@@ -54,6 +54,8 @@ const generateColumnsFor = (name, titles) => {
 
 /**
  * @function
+ * @param props.report
+ * @param props.loading
  * @name EventsOverviewDashboard
  * @description Events Overview Dashboard
  * @param {object} props Event Overview dashboard props

src/Dashboards/Overview.js

@@ -26,6 +26,8 @@ const { getOverviewsReport } = reduxActions;
 
 /**
  * @function
+ * @param props.report
+ * @param props.loading
  * @name OverviewDashboard
  * @description Dashboard which renders overviews reports from different dashboards
  * i.e stakeholders, events

src/Events/Events/ChangelogForm/index.js

@@ -51,6 +51,10 @@ const formItemLayout = {
 
 /**
  * @function
+ * @param props.event
+ * @param props.posting
+ * @param props.onCancel
+ * @param props.action
  * @name EventChangelogForm
  * @description Render Event form for creating and updating stakeholder
  * event details

src/Events/Events/DetailsView/Body.js

@@ -60,9 +60,14 @@ const { Paragraph, Text } = Typography;
 
 /**
  * @function
+ * @param props.event
+ * @param props.openForm
+ * @param props.onEdit
+ * @param props.onShare
+ * @param props.openIndicatorDashboard
+ * @param props.onContent
  * @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
@@ -218,10 +223,10 @@ const EventToolbar = ({
 
 /**
  * @function
+ * @param props.cause
  * @name EventCause
  * @description Display Event Cause
  * @param {object} props React props
- *
  * @returns {object} React component
  * @version 0.1.0
  * @since 0.1.0
@@ -237,12 +242,12 @@ const EventCause = ({ cause }) => {
 
 /**
  * @function
+ * @param props.title
+ * @param props.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
  */
@@ -256,10 +261,12 @@ export const EventDetailsSectionHeader = ({ title, actions }) => {
 };
 
 /**
+ * @param root0
+ * @param root0.areas
+ * @param root0.openForm
  * @function
  * @name EventLocations
  * @description Section which show event location(s) in hierarchy
- *
  * @returns {object} React component
  * @version 0.1.0
  * @since 0.1.0
@@ -288,10 +295,11 @@ export const EventLocations = ({ areas = [], openForm }) => {
 };
 
 /**
+ * @param root0
+ * @param root0.places
  * @function
  * @name EventPlaces
  * @description Section which show event affected place(s) in hierarchy
- *
  * @returns {object} React component
  * @version 0.1.0
  * @since 0.1.0
@@ -308,6 +316,8 @@ export const EventPlaces = ({ places = '' }) => {
 
 /**
  * @function
+ * @param props.actions
+ * @param props.openForm
  * @name EventActionsTaken
  * @description Section which show actions taken per event
  * @param {object} props Event action taken props
@@ -345,10 +355,12 @@ export const EventActionsTaken = ({ actions = [], openForm }) => {
 };
 
 /**
+ * @param root0
+ * @param root0.agencies
+ * @param root0.openForm
  * @function
  * @name EventRespondingAgencies
  * @description Section which show event responding agencies
- *
  * @returns {object} React component
  * @version 0.1.0
  * @since 0.1.0
@@ -381,10 +393,12 @@ export const EventRespondingAgencies = ({ agencies = [], openForm }) => {
 };
 
 /**
+ * @param root0
+ * @param root0.focalPeople
+ * @param root0.openForm
  * @function
  * @name EventRespondingFocalPeople
  * @description Section which show event responding agencies
- *
  * @returns {object} React component
  * @version 0.1.0
  * @since 0.1.0
@@ -422,6 +436,8 @@ export const EventRespondingFocalPeople = ({ focalPeople = [], openForm }) => {
 
 /**
  * @function
+ * @param props.initiator
+ * @param props.date
  * @name EventFeedItemHeader
  * @description Render Event feed item header
  * @param {object} props Component props
@@ -439,10 +455,11 @@ const EventFeedItemHeader = ({ initiator, date }) => {
 };
 
 /**
+ * @param root0
+ * @param root0.openForm
  * @function
  * @name EventImpact
  * @description Display Event impact based on indicators
- *
  * @returns {object} Event Impact Component
  * @version 0.1.0
  * @since 0.1.0
@@ -482,6 +499,8 @@ const EventImpact = ({ openForm }) => {
 
 /**
  * @function
+ * @param props.gaps
+ * @param props.openForm
  * @name EventGaps
  * @description Event Gaps and Constraints
  * @param {object} props React components props
@@ -518,6 +537,8 @@ const EventGaps = ({ gaps = [], openForm }) => {
 
 /**
  * @function
+ * @param props.recommendations
+ * @param props.openForm
  * @name EventRecommendations
  * @description Event Recommendations and Remarks
  * @param {object} props React components props
@@ -720,9 +741,11 @@ const renderFeed = (feed) => {
 
 /**
  * @function
+ * @param props.feeds
+ * @param props.loading
+ * @param props.hasMore
  * @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
@@ -764,6 +787,10 @@ export const EventFeed = ({ feeds = [], loading, hasMore }) => {
 
 /**
  * @function
+ * @param props.type
+ * @param props.description
+ * @param props.number
+ * @param props.reportedDate
  * @name PrintedEventDetails
  * @description This is event details section which will be visible on printed
  * report only
@@ -793,9 +820,17 @@ const PrintedEventDetails = ({ type, description, number, reportedDate }) => {
 
 /**
  * @function
- * @name  EventDetailsViewBody
+ * @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
+ * @name EventDetailsViewBody
  * @description Event Details body view
- *
  * @param {object} props React props
  * @returns {object} React component
  * @version 0.1.0

src/Events/Events/DetailsView/Header.js

@@ -6,13 +6,14 @@ const { Text } = Typography;
 
 /**
  * @function
+ * @param props.number
+ * @param props.type
+ * @param props.description
+ * @param props.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,6 +39,12 @@ const formItemLayout = {
 
 /**
  * @function
+ * @param props.isEditForm
+ * @param props.defaultStage
+ * @param props.stages
+ * @param props.event
+ * @param props.posting
+ * @param props.onCancel
  * @name EventForm
  * @description Event Form component for creating and editing event
  * @param {object} props React props

src/GeographicalFeatures/AdministrativeLevels/Form/index.js

@@ -28,6 +28,10 @@ const formItemLayout = {
 
 /**
  * @function
+ * @param props.administrativeLevel
+ * @param props.isEditForm
+ * @param props.posting
+ * @param props.onCancel
  * @name AdministrativeLevelForm
  * @description Administrative Level Form
  * @param {object} props React props

src/GeographicalFeatures/EvacuationCenters/List/index.js

@@ -8,14 +8,12 @@ import EvacuationCenterListItem from '../ListItem';
  * @function
  * @name EvacuationCenterList
  * @description Render Evacuation Center list
- *
  * @param {object} props props object
+ * @param props.evacuationCenters
  * @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
  * @since 0.1.0
  */

src/GeographicalFeatures/Facilities/List/index.js

@@ -8,14 +8,12 @@ import FacilityListItem from '../ListItem';
  * @function
  * @name FacilityList
  * @description Render facilities list
- *
  * @param {object} props props object
+ * @param props.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
  * @since 0.1.0
  */

src/GeographicalFeatures/FeatureTypes/Form/index.js

@@ -29,6 +29,10 @@ const formItemLayout = {
 
 /**
  * @function
+ * @param props.featureType
+ * @param props.isEditForm
+ * @param props.posting
+ * @param props.onCancel
  * @name FeatureTypeForm
  * @description Feature Type Form
  * @param {object} props React props

src/GeographicalFeatures/Infrastructure/List/index.js

@@ -8,14 +8,12 @@ import CriticalInfrastructureListItem from '../ListItem';
  * @function
  * @name CriticalInfrastructureList
  * @description Render Critical Infrastructure list
- *
  * @param {object} props props object
+ * @param props.criticalInfrastructures
  * @param {boolean} props.loading preload list of Critical Infrastructure
  * @param {Array} props.districts array list of Critical Infrastructure
  * @param {Function} props.onEdit function for editing Critical Infrastructure
- *
  * @returns {object} React component
- *
  * @version 0.1.0
  * @since 0.1.0
  */

src/GeographicalFeatures/Warehouses/List/index.js

@@ -6,13 +6,13 @@ import WarehouseListItem from '../ListItem';
 
 /**
  * @function
+ * @param props.warehouses
+ * @param props.loading
+ * @param props.onEdit
  * @name WarehouseList
  * @description Render warehouse list which have search box and actions
- *
  * @param {object} props props object
- *
  * @returns {object} React Compnent
- *
  * @version 0.1.0
  * @since 0.1.0
  */

src/Stakeholders/AgenciesOwnerships/Form/index.js

@@ -28,6 +28,10 @@ const formItemLayout = {
 
 /**
  * @function
+ * @param props.partyOwnership
+ * @param props.isEditForm
+ * @param props.posting
+ * @param props.onCancel
  * @name PartyOwnershipForm
  * @description Render form for creating and editing party ownerships
  * @param {object} props PartyOwnershipForm props

src/VehicleDispatches/VehicleMakes/Form/index.js

@@ -28,6 +28,10 @@ const formItemLayout = {
 
 /**
  * @function
+ * @param props.vehicleMake
+ * @param props.isEditForm
+ * @param props.posting
+ * @param props.onCancel
  * @name VehicleMakeForm
  * @description Render form for creating and editing vehicle makes
  * @param {object} props VehicleMakeForm props

src/VehicleDispatches/VehicleModels/Form/index.js

@@ -28,6 +28,10 @@ const formItemLayout = {
 
 /**
  * @function
+ * @param props.vehicleModel
+ * @param props.isEditForm
+ * @param props.posting
+ * @param props.onCancel
  * @name VehicleModelForm
  * @description Render form for creating and editing party ownerships
  * @param {object} props VehicleModelForm props