chore: use nouns for leading word in function description tags (#735)

scripts/license-checker.js

@@ -9,7 +9,7 @@ const path = require("upath");
 
 /**
  * @author Frazer Smith
- * @description Check licenses of all direct production dependencies to
+ * @description Checks licenses of all direct production dependencies to
  * ensure they are not copyleft.
  */
 async function checkLicenses() {

src/app.js

@@ -5,7 +5,7 @@ const migrate = require("./migrate");
 
 /**
  * @author Frazer Smith
- * @description Start server.
+ * @description Starts server.
  */
 const main = async () => {
  process.on("unhandledRejection", (err) => {

src/config/index.js

@@ -12,7 +12,7 @@ const { license, version } = require("../../package.json");
 
 /**
  * @author Frazer Smith
- * @description Convert string boolean to boolean
+ * @description Converts string boolean to boolean
  * or comma-delimited string to array.
  * @param {string} param - CORS parameter.
  * @returns {boolean|Array<string>|string} CORS parameter.
@@ -35,7 +35,7 @@ function parseCorsParameter(param) {
 
 /**
  * @author Frazer Smith
- * @description Validate environment variables and build server config.
+ * @description Validates environment variables and build server config.
  * @returns {Promise<object|Error>} Promise of server config object on resolve, or Error object on rejection.
  */
 async function getConfig() {

src/migrate.js

@@ -8,7 +8,7 @@ const getConfig = require("./config");
 
 /**
  * @author Frazer Smith
- * @description Run Postgrator to execute SQL queries in ../migrations/** directories.
+ * @description Runs Postgrator to execute SQL queries in ../migrations/** directories.
  */
 async function migrate() {
  let client;

src/plugins/convert-date-param-operator/index.js

@@ -3,8 +3,8 @@ const fp = require("fastify-plugin");
 /**
  * @author Frazer Smith
  * @author NextGen Healthcare
+ * @description Converts date param operator to corresponding value.
  * @param {string} operator - Date param operator, in any letter case.
- * @description Convert date param operator to corresponding value.
  * @returns {string} converted date param operator.
  */
 function convDateParamOperator(operator) {

src/routes/admin/access/bearer-token/index.js

@@ -23,7 +23,7 @@ const {
 
 /**
  * @author Frazer Smith
- * @description Build bearer token object from database result.
+ * @description Builds bearer token object from database result.
  * @param {object} result - Database query result.
  * @param {string} result.id - Unique identifier of bearer token record.
  * @param {string} result.name - Name of client or service accessing API.

src/routes/admin/access/bearer-token/query.js

@@ -2,7 +2,7 @@ const escSq = require("../../../../utils/escape-single-quotes");
 
 /**
  * @author Frazer Smith
- * @description Build SQL query string.
+ * @description Builds SQL query string.
  * @param {object} options - Query string and database config values.
  * @param {string} options.id - Logical id of the artifact.
  * @returns {string} Query string.
@@ -13,7 +13,7 @@ const accessDelete = ({ id }) => escSq`DELETE
 
 /**
  * @author Frazer Smith
- * @description Build SQL query string.
+ * @description Builds SQL query string.
  * @param {object} options - Query string and database config values.
  * @param {string} options.id - Logical id of the artifact.
  * @returns {string} Query string.
@@ -32,7 +32,7 @@ WHERE id = '${id}';`;
 
 /**
  * @author Frazer Smith
- * @description Build SQL query string.
+ * @description Builds SQL query string.
  * @param {object} options - Query string and database config values.
  * @param {('mssql'|'postgresql')} options.client - Database client.
  * @param {string} options.whereClausePredicates - WHERE clause predicates.
@@ -66,7 +66,7 @@ FETCH NEXT ${perPage} ROWS ONLY;`;
 
 /**
  * @author Frazer Smith
- * @description Build SQL query string.
+ * @description Builds SQL query string.
  * @param {object} options - Query string and database config values.
  * @param {('mssql'|'postgresql')} options.client - Database client.
  * @param {string} options.name - Type of matching value.

src/routes/contact/index.js

@@ -23,7 +23,7 @@ const {
 
 /**
  * @author Frazer Smith
- * @description Build contact object from database results.
+ * @description Builds contact object from database results.
  * @param {object} results - Database query result.
  * @param {string} results.id - Unique identifier of community contact record.
  * @param {string} results.match_type - Type of matching value.

src/routes/contact/query.js

@@ -2,7 +2,7 @@ const escSq = require("../../utils/escape-single-quotes");
 
 /**
  * @author Frazer Smith
- * @description Build SQL query string.
+ * @description Builds SQL query string.
  * @param {object} options - Query string and database config values.
  * @param {string} options.id - Logical id of the artifact.
  * @returns {string} Query string.
@@ -13,7 +13,7 @@ const contactDelete = ({ id }) => escSq`DELETE
 
 /**
  * @author Frazer Smith
- * @description Build SQL query string.
+ * @description Builds SQL query string.
  * @param {object} options - Query string and database config values.
  * @param {string} options.id - Logical id of the artifact.
  * @returns {string} Query string.
@@ -31,7 +31,7 @@ WHERE id = '${id}';`;
 
 /**
  * @author Frazer Smith
- * @description Build SQL query string.
+ * @description Builds SQL query string.
  * @param {object} options - Query string and database config values.
  * @param {('mssql'|'postgresql')} options.client - Database client.
  * @param {string} options.whereClausePredicates - WHERE clause predicates.
@@ -75,7 +75,7 @@ FETCH NEXT ${perPage} ROWS ONLY;`;
 
 /**
  * @author Frazer Smith
- * @description Build SQL query string.
+ * @description Builds SQL query string.
  * @param {object} options - Query string and database config values.
  * @param {('mssql'|'postgresql')} options.client - Database client.
  * @param {string} options.matchType - Type of matching value.
@@ -98,7 +98,7 @@ const contactPost = ({
 
 /**
  * @author Frazer Smith
- * @description Build SQL query string.
+ * @description Builds SQL query string.
  * @param {object} options - Query string and database config values.
  * @param {string} options.id - Logical id of the artifact.
  * @param {string} options.matchType - Type of matching value.

src/server.js

@@ -23,7 +23,7 @@ const sharedSchemas = require("./plugins/shared-schemas");
 
 /**
  * @author Frazer Smith
- * @description Build Fastify instance.
+ * @description Builds Fastify instance.
  * @param {object} server - Fastify instance.
  * @param {object} config - Fastify configuration values.
  */