chore: use @see jsdoc tag for inline comment links

scripts/license-checker.js

@@ -21,7 +21,7 @@ async function checkLicenses() {
 
  /**
  * List of deprecated copyleft license identifiers
- * @see https://spdx.org/licenses/
+ * @see {@link https://spdx.org/licenses/ | SPDX License List}
  */
  const deprecatedLicenseList = [
  "AGPL-1.0",

src/config/index.js

@@ -149,8 +149,8 @@ async function getConfig() {
  },
  fastifyInit: {
  /**
- * See https://fastify.io/docs/latest/Reference/Logging/
- * and https://getpino.io/#/docs/api for logger options
+ * @see {@link https://fastify.io/docs/latest/Reference/Logging | Fastify logging}
+ * @see {@link https://getpino.io/#/docs/api | Pino API}
  */
  logger: {
  formatters: {
@@ -341,7 +341,9 @@ async function getConfig() {
  if (env.LOG_ROTATION_FILENAME) {
  const logFile = path.normalizeTrim(env.LOG_ROTATION_FILENAME);
 
- // Rotation options: https://github.com/rogerc/file-stream-rotator/#options
+ /**
+ * @see {@link https://github.com/rogerc/file-stream-rotator/#options | File stream rotator options}
+ */
  config.fastifyInit.logger.stream = getStream({
  audit_file: path.joinSafe(path.dirname(logFile), ".audit.json"),
  date_format: env.LOG_ROTATION_DATE_FORMAT || "YYYY-MM-DD",

src/plugins/clean-object/index.js

@@ -15,7 +15,7 @@ async function plugin(server) {
  * @author Frazer Smith
  * @author Felix Meyer-Wolters
  * @description Recursively removes key value pairs from an object where the value is null
- * or undefined. Adapted from Felix's answer at https://stackoverflow.com/a/38340730
+ * or undefined.
  * @param {object} [object] - Object to be parsed and cleaned.
  * @returns {object} cleaned object.
  */

src/plugins/shared-schemas/index.js

@@ -12,7 +12,7 @@ async function plugin(server) {
  /**
  * NOTE: `.definition()` definitions have been replaced with `.prop()` properties, and
  * `.id()` ids removed due to definitions breaking in v4.12.1 of fastify-swagger.
- * See https://github.com/fastify/fastify-swagger/issues/524
+ * @see {@link https://github.com/fastify/fastify-swagger/issues/524 | fastify-swagger Issue #524}
  */
 
  // Response schemas

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

@@ -46,7 +46,10 @@ WHERE id = '${id}';`;
 // DISTINCT SQL keyword not needed as PK constraints enforce unique values
 const accessGetSearch = ({ client, whereClausePredicates, page, perPage }) => `
 SELECT COUNT(id)${
- // Cast from string to int - https://node-postgres.com/features/types
+ /**
+ * Cast from string to int.
+ * @see {@link https://node-postgres.com/features/types | Node-Postgres Type Parsing}
+ */
  client === "postgresql" ? "::int" : ""
 } AS total
 FROM access.tokens

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

@@ -90,11 +90,10 @@ const accessRecordBaseSchema = S.object()
  .required(["access"]);
 
 /**
- * Fastify uses AJV for JSON Schema Validation,
- * see https://fastify.io/docs/latest/Reference/Validation-and-Serialization/
- *
+ * Fastify uses AJV for JSON Schema Validation.
  * Input validation protects against XSS, HPP, prototype pollution,
- * and most other injection attacks
+ * and most other injection attacks.
+ * @see {@link https://fastify.io/docs/latest/Reference/Validation-and-Serialization | Fastify Validation and Serialization}
  */
 const accessDeleteSchema = {
  tags,

src/routes/admin/healthcheck/schema.js

@@ -5,11 +5,10 @@ const S = require("fluent-json-schema").default;
 const tags = ["System administration"];
 
 /**
- * Fastify uses AJV for JSON Schema Validation,
- * see https://fastify.io/docs/latest/Reference/Validation-and-Serialization/
- *
+ * Fastify uses AJV for JSON Schema Validation.
  * Input validation protects against XSS, HPP, prototype pollution,
- * and most other injection attacks
+ * and most other injection attacks.
+ * @see {@link https://fastify.io/docs/latest/Reference/Validation-and-Serialization | Fastify Validation and Serialization}
  */
 const healthcheckGetSchema = {
  tags,

src/routes/contact/query.js

@@ -45,7 +45,10 @@ WHERE id = '${id}';`;
 // DISTINCT SQL keyword needed as CROSS APPLY causes duplicates
 const contactGetSearch = ({ client, whereClausePredicates, page, perPage }) => `
 SELECT COUNT(DISTINCT id)${
- // Cast from string to int - https://node-postgres.com/features/types
+ /**
+ * Cast from string to int.
+ * @see {@link https://node-postgres.com/features/types | Node-Postgres Type Parsing}
+ */
  client === "postgresql" ? "::int" : ""
 } AS total
 FROM lookup.contacts

src/routes/contact/schema.js

@@ -109,11 +109,10 @@ const contactBaseSchema = S.object()
  .required(["match", "telecom"]);
 
 /**
- * Fastify uses AJV for JSON Schema Validation,
- * see https://fastify.io/docs/latest/Reference/Validation-and-Serialization/
- *
+ * Fastify uses AJV for JSON Schema Validation.
  * Input validation protects against XSS, HPP, prototype pollution,
- * and most other injection attacks
+ * and most other injection attacks.
+ * @see {@link https://fastify.io/docs/latest/Reference/Validation-and-Serialization | Fastify Validation and Serialization}
  */
 const contactDeleteSchema = {
  tags,

src/routes/docs/index.html

@@ -23,7 +23,10 @@
  </head>
  <body>
  <script>
- // Redoc no longer supports IE, see https://github.com/Redocly/redoc/issues/1936
+ /**
+ * @description Detect IE and display message if detected.
+ * @see {@link https://github.com/Redocly/redoc/issues/1936 | Redoc Issue #1936}
+ */
  if (window.document.documentMode) {
  var p = document.createElement("p");
  p.innerHTML =

src/routes/docs/openapi/schema.js

@@ -3,11 +3,10 @@
 const S = require("fluent-json-schema").default;
 
 /**
- * Fastify uses AJV for JSON Schema Validation,
- * see https://fastify.io/docs/latest/Reference/Validation-and-Serialization/
- *
+ * Fastify uses AJV for JSON Schema Validation.
  * Input validation protects against XSS, HPP, prototype pollution,
- * and most other injection attacks
+ * and most other injection attacks.
+ * @see {@link https://fastify.io/docs/latest/Reference/Validation-and-Serialization | Fastify Validation and Serialization}
  */
 const docsOpenapiGetSchema = {
  hide: true,

src/routes/docs/route.test.js.snap

@@ -26,7 +26,10 @@ exports[`Docs route GET requests Returns HTML 1`] = `
  </head>
  <body>
  <script>
- // Redoc no longer supports IE, see https://github.com/Redocly/redoc/issues/1936
+ /**
+ * @description Detect IE and display message if detected.
+ * @see {@link https://github.com/Redocly/redoc/issues/1936 | Redoc Issue #1936}
+ */
  if (window.document.documentMode) {
  var p = document.createElement("p");
  p.innerHTML =

src/routes/docs/schema.js

@@ -3,11 +3,10 @@
 const S = require("fluent-json-schema").default;
 
 /**
- * Fastify uses AJV for JSON Schema Validation,
- * see https://fastify.io/docs/latest/Reference/Validation-and-Serialization/
- *
+ * Fastify uses AJV for JSON Schema Validation.
  * Input validation protects against XSS, HPP, prototype pollution,
- * and most other injection attacks
+ * and most other injection attacks.
+ * @see {@link https://fastify.io/docs/latest/Reference/Validation-and-Serialization | Fastify Validation and Serialization}
  */
 const docsGetSchema = {
  hide: true,

src/server.js

@@ -53,7 +53,10 @@ async function plugin(server, config) {
  // Opt-out of Google's Topics advertising-surveillance API
  .register(flocOff)
 
- // Use Helmet to set response security headers: https://helmetjs.github.io/
+ /**
+ * Use Helmet to set response security headers.
+ * @see {@link https://helmetjs.github.io | Helmet}
+ */
  .register(helmet, config.helmet)
 
  // Utility functions and error handlers
@@ -109,7 +112,7 @@ async function plugin(server, config) {
  /**
  * Encapsulate plugins and routes into child context, so that other
  * routes do not inherit `accepts` preHandler.
- * See https://fastify.io/docs/latest/Reference/Encapsulation/ for more info
+ * @see {@link https://fastify.io/docs/latest/Reference/Encapsulation | Fastify Encapsulation}
  */
  .register(async (serializedContext) => {
  serializedContext

src/server.test.js

@@ -1021,8 +1021,8 @@ describe("Server deployment", () => {
  "Community Contacts API | Documentation"
  );
  /**
- * Checks redoc has not rendered an error component:
- * https://github.com/Redocly/redoc/blob/main/src/components/ErrorBoundary.tsx
+ * Checks redoc has not rendered an error component.
+ * @see {@link https://github.com/Redocly/redoc/blob/main/src/components/ErrorBoundary.tsx | Redoc ErrorBoundary component}
  */
  const heading = page.locator("h1 >> nth=0");
  await heading.waitFor();

src/server.test.js.snap

@@ -26,7 +26,10 @@ exports[`Server deployment API documentation Content /docs route Returns HTML 1`
  </head>
  <body>
  <script>
- // Redoc no longer supports IE, see https://github.com/Redocly/redoc/issues/1936
+ /**
+ * @description Detect IE and display message if detected.
+ * @see {@link https://github.com/Redocly/redoc/issues/1936 | Redoc Issue #1936}
+ */
  if (window.document.documentMode) {
  var p = document.createElement("p");
  p.innerHTML =