diff --git a/src/api.js b/src/api.js index 9d3eae0..4ede0ea 100644 --- a/src/api.js +++ b/src/api.js @@ -18,7 +18,7 @@ import { getApiUrl } from "@/util"; * * @param {String} path API resource path * @param {QueryParams} [params] Query parameters - * @return {Promise} Promise returned by the fetch function + * @returns {Promise} Promise returned by the fetch function */ const fetchApi = (path, params = {}) => { const url = getApiUrl(path); @@ -30,7 +30,7 @@ const fetchApi = (path, params = {}) => { /** * Get the recorder's version. * - * @return {String} Version + * @returns {String} Version */ export const getVersion = async () => { const response = await fetchApi("/api/0/version"); @@ -42,7 +42,7 @@ export const getVersion = async () => { /** * Get all users. * - * @return {Array.} Array of usernames + * @returns {Array.} Array of usernames */ export const getUsers = async () => { const response = await fetchApi("/api/0/list"); @@ -55,7 +55,7 @@ export const getUsers = async () => { * Get all devices for the provided users. * * @param {Array.} users Array of usernames - * @return {Object.>} Object mapping each username to an array of device names + * @returns {Object.>} Object mapping each username to an array of device names */ export const getDevices = async users => { const devices = {}; @@ -75,7 +75,7 @@ export const getDevices = async users => { * * @param {User} [user] Get last locations of all devices from this user * @param {Device} [device] Get last location of specific device - * @return {Array.} Array of last location objects + * @returns {Array.} Array of last location objects */ export const getLastLocations = async (user, device) => { const params = {}; @@ -97,7 +97,7 @@ export const getLastLocations = async (user, device) => { * @param {Device} device Device name * @param {String} start Start date and time in UTC * @param {String} end End date and time in UTC - * @return {LocationHistory} Array of location history objects + * @returns {LocationHistory} Array of location history objects */ export const getUserDeviceLocationHistory = async ( user, @@ -122,7 +122,7 @@ export const getUserDeviceLocationHistory = async ( * @param {Object.>} devices Devices of which the history should be fetched * @param {String} start Start date and time in UTC * @param {String} end End date and time in UTC - * @return {Object.>} Array of location history objects + * @returns {Object.>} Array of location history objects */ export const getLocationHistory = async (devices, start, end) => { const locationHistory = {}; diff --git a/src/components/LDeviceLocationPopup.vue b/src/components/LDeviceLocationPopup.vue index cf3b233..f36334b 100644 --- a/src/components/LDeviceLocationPopup.vue +++ b/src/components/LDeviceLocationPopup.vue @@ -128,7 +128,7 @@ export default { /** * Return the face image as a data URI string which can be used for an image's src attribute. * - * @return {String} base64-encoded face image data URI + * @returns {String} base64-encoded face image data URI */ faceImageDataURI() { return `data:image/png;base64,${this.face}`; @@ -136,7 +136,7 @@ export default { /** * Return the device name for displaying with / as fallback. * - * @return {String} device name for displaying + * @returns {String} device name for displaying */ deviceName() { return this.name ? this.name : `${this.user}/${this.device}`; diff --git a/src/store/getters.js b/src/store/getters.js index 87db88c..0bfaefb 100644 --- a/src/store/getters.js +++ b/src/store/getters.js @@ -13,7 +13,7 @@ import { distanceBetweenCoordinates } from "@/util"; * * @param {State} state * @param {MultiLocationHistory} state.locationHistory Location history of selected users and devices - * @return {Array.} All coordinates + * @returns {Array.} All coordinates */ const locationHistoryLatLngs = state => { const latLngs = []; @@ -34,7 +34,7 @@ const locationHistoryLatLngs = state => { * * @param {State} state * @param {MultiLocationHistory} state.locationHistory Location history of selected users and devices - * @return {Array.>} Groups of coherent coordinates + * @returns {Array.>} Groups of coherent coordinates */ const locationHistoryLatLngGroups = state => { const groups = []; diff --git a/src/util.js b/src/util.js index 05627e2..3511772 100644 --- a/src/util.js +++ b/src/util.js @@ -10,7 +10,7 @@ import { DATE_TIME_FORMAT, EARTH_RADIUS_IN_KM } from "@/constants"; * base URL configuration into account. * * @param {String} path Path to the API resource - * @return {URL} Final API URL + * @returns {URL} Final API URL */ export const getApiUrl = path => { const normalizedBaseUrl = config.api.baseUrl.endsWith("/") @@ -24,7 +24,7 @@ export const getApiUrl = path => { * Check if the given string is an ISO 8601 YYYY-MM-DDTHH:MM:SS datetime. * * @param {String} s Input value to be tested - * @return {Boolean} Whether the input matches the expected format + * @returns {Boolean} Whether the input matches the expected format */ export const isIsoDateTime = s => moment(s, DATE_TIME_FORMAT, true).isValid(); @@ -32,7 +32,7 @@ export const isIsoDateTime = s => moment(s, DATE_TIME_FORMAT, true).isValid(); * Convert degrees to radians. * * @param {Number} degrees Angle in degrees - * @return {Number} Angle in radians + * @returns {Number} Angle in radians */ export const degreesToRadians = degrees => (degrees * Math.PI) / 180; @@ -44,7 +44,7 @@ export const degreesToRadians = degrees => (degrees * Math.PI) / 180; * * @param {Coordinate} c1 First coordinate * @param {Coordinate} c2 Second coordinate - * @return {Number} Distance in meters + * @returns {Number} Distance in meters */ export const distanceBetweenCoordinates = (c1, c2) => { const r = EARTH_RADIUS_IN_KM * 1000;