@serenity-js/console-reporter 3.25.0 → 3.25.2

package/CHANGELOG.md

@@ -3,6 +3,25 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+## [3.25.2](https://github.com/serenity-js/serenity-js/compare/v3.25.1...v3.25.2) (2024-07-17)
+
+**Note:** Version bump only for package @serenity-js/console-reporter
+
+
+
+
+
+## [3.25.1](https://github.com/serenity-js/serenity-js/compare/v3.25.0...v3.25.1) (2024-07-10)
+
+
+### Bug Fixes
+
+* **core:** all the API docs now link to the online Serenity/JS API documentation ([f8f451d](https://github.com/serenity-js/serenity-js/commit/f8f451dffdb4caaa2e31a860f59d59470f4856ad))
+
+
+
+
+
 # [3.25.0](https://github.com/serenity-js/serenity-js/compare/v3.24.1...v3.25.0) (2024-07-03)
 
 **Note:** Version bump only for package @serenity-js/console-reporter

package/README.md

@@ -17,7 +17,7 @@ of complex software systems faster, more collaborative and easier to scale.
 👋 Join the Serenity/JS Community!
 - Meet other Serenity/JS developers and maintainers on the [Serenity/JS Community chat channel](https://matrix.to/#/#serenity-js:gitter.im),
 - Find answers to your Serenity/JS questions on the [Serenity/JS Forum](https://github.com/orgs/serenity-js/discussions/categories/how-do-i),
-- Learn how to [contribute to Serenity/JS](https://serenity-js.org/contributing),
+- Learn how to [contribute to Serenity/JS](https://serenity-js.org/community/contributing/),
 - Support the project and gain access to [Serenity/JS Playbooks](https://github.com/serenity-js/playbooks) by becoming a [Serenity/JS GitHub Sponsor](https://github.com/sponsors/serenity-js)!
 
 ## Serenity/JS Console Reporter
@@ -148,7 +148,7 @@ configure({
 
 #### Colour Themes
 
-Consult the API docs of the [`ConsoleReporter`](/api/console-reporter/class/ConsoleReporter) class
+Consult the API docs of the [`ConsoleReporter`](https://serenity-js.org/api/console-reporter/class/ConsoleReporter) class
 to learn more about the supported colour themes.
 
 ## 📣 Stay up to date

package/lib/stage/crew/console-reporter/ConsoleReporter.d.ts

@@ -4,7 +4,7 @@ import type { ConsoleReporterConfig } from './ConsoleReporterConfig';
 import { Printer } from './Printer';
 import type { TerminalTheme } from './themes';
 /**
- * A {@apilink StageCrewMember} that uses [standard output](https://en.wikipedia.org/wiki/Standard_streams)
+ * A [`StageCrewMember`](https://serenity-js.org/api/core/interface/StageCrewMember/) that uses [standard output](https://en.wikipedia.org/wiki/Standard_streams)
  * to report on progress of your Serenity/JS acceptance tests.
  *
  * `ConsoleReporter` ships with colour themes for both dark and light terminals,
@@ -167,9 +167,9 @@ export declare class ConsoleReporter implements ListensToDomainEvents {
      */
     constructor(printer: Printer, theme: TerminalTheme, stage?: Stage);
     /**
-     * Handles {@apilink DomainEvent} objects emitted by the {@apilink Stage}.
+     * Handles [`DomainEvent`](https://serenity-js.org/api/core-events/class/DomainEvent/) objects emitted by the [`Stage`](https://serenity-js.org/api/core/class/Stage/).
      *
-     * @see {@apilink StageCrewMember}
+     * @see [`StageCrewMember`](https://serenity-js.org/api/core/interface/StageCrewMember/)
      *
      * @listens {DomainEvent}
      *

package/lib/stage/crew/console-reporter/ConsoleReporter.js

@@ -11,7 +11,7 @@ const Summary_1 = require("./Summary");
 const SummaryFormatter_1 = require("./SummaryFormatter");
 const themes_1 = require("./themes");
 /**
- * A {@apilink StageCrewMember} that uses [standard output](https://en.wikipedia.org/wiki/Standard_streams)
+ * A [`StageCrewMember`](https://serenity-js.org/api/core/interface/StageCrewMember/) that uses [standard output](https://en.wikipedia.org/wiki/Standard_streams)
  * to report on progress of your Serenity/JS acceptance tests.
  *
  * `ConsoleReporter` ships with colour themes for both dark and light terminals,
@@ -202,9 +202,9 @@ class ConsoleReporter {
         this.summaryFormatter = new SummaryFormatter_1.SummaryFormatter(this.theme);
     }
     /**
-     * Handles {@apilink DomainEvent} objects emitted by the {@apilink Stage}.
+     * Handles [`DomainEvent`](https://serenity-js.org/api/core-events/class/DomainEvent/) objects emitted by the [`Stage`](https://serenity-js.org/api/core/class/Stage/).
      *
-     * @see {@apilink StageCrewMember}
+     * @see [`StageCrewMember`](https://serenity-js.org/api/core/interface/StageCrewMember/)
      *
      * @listens {DomainEvent}
      *

package/lib/stage/crew/console-reporter/ConsoleReporterConfig.d.ts

@@ -1,5 +1,5 @@
 /**
- * Used to configure the {@apilink ConsoleReporter}.
+ * Used to configure the [`ConsoleReporter`](https://serenity-js.org/api/console-reporter/class/ConsoleReporter/).
  *
  * @group Stage
  */

package/lib/stage/crew/console-reporter/Printer.d.ts

@@ -1,49 +1,31 @@
 import type { OutputStream } from '@serenity-js/core/lib/adapter';
 /**
- * @desc
- *  A simple abstraction around the standard output stream
- *  with support for indenting the printed text.
- *
- * @public
+ * A simple abstraction around the standard output stream
+ * with support for indenting the printed text.
  */
 export declare class Printer {
     private readonly stdout;
     private indentation;
     constructor(stdout?: OutputStream);
     /**
-     * @desc
-     *  Prints the `args` to the `stdout`, followed by a new line character (`\n`).
+     * Prints the `args` to the `stdout`, followed by a new line character (`\n`).
      *
-     *  Please note that this method bypasses any indentation as it's intended
-     *  to be used to print separator lines, etc.
+     * Please note that this method bypasses any indentation as it's intended
+     * to be used to print separator lines, etc.
      *
-     * @param {...any[]} args
-     *
-     * @returns {void}
      */
     println(...args: any[]): void;
     /**
-     * @desc
-     *  Prints the `args` to the `stdout`, indenting the output according to
-     *  the current indentation level.
-     *
-     * @param {...any[]} args
-     *
-     * @returns {void}
+     * Prints the `args` to the `stdout`, indenting the output according to
+     * the current indentation level.
      */
     print(...args: any[]): void;
     /**
-     * @desc
-     *  Increases the current indentation by 2 spaces.
-     *
-     * @returns {void}
+     * Increases the current indentation by 2 spaces.
      */
     indent(): void;
     /**
-     * @desc
-     *  Reduces the current indentation by 2 spaces.
-     *
-     * @returns {void}
+     * Reduces the current indentation by 2 spaces.
      */
     outdent(): void;
 }

package/lib/stage/crew/console-reporter/Printer.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"Printer.d.ts","sourceRoot":"","sources":["../../../../src/stage/crew/console-reporter/Printer.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,+BAA+B,CAAC;AAElE;;;;;;GAMG;AACH,qBAAa,OAAO;IAGJ,OAAO,CAAC,QAAQ,CAAC,MAAM;IAFnC,OAAO,CAAC,WAAW,CAAsB;gBAEZ,MAAM,GAAE,YAA6B;IAGlE;;;;;;;;;;OAUG;IACH,OAAO,CAAC,GAAG,IAAI,EAAE,GAAG,EAAE,GAAG,IAAI;IAI7B;;;;;;;;OAQG;IACH,KAAK,CAAC,GAAG,IAAI,EAAE,GAAG,EAAE,GAAG,IAAI;IAM3B;;;;;OAKG;IACH,MAAM,IAAI,IAAI;IAId;;;;;OAKG;IACH,OAAO,IAAI,IAAI;CAGlB"}
+{"version":3,"file":"Printer.d.ts","sourceRoot":"","sources":["../../../../src/stage/crew/console-reporter/Printer.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,+BAA+B,CAAC;AAElE;;;GAGG;AACH,qBAAa,OAAO;IAGJ,OAAO,CAAC,QAAQ,CAAC,MAAM;IAFnC,OAAO,CAAC,WAAW,CAAsB;gBAEZ,MAAM,GAAE,YAA6B;IAGlE;;;;;;OAMG;IACH,OAAO,CAAC,GAAG,IAAI,EAAE,GAAG,EAAE,GAAG,IAAI;IAI7B;;;OAGG;IACH,KAAK,CAAC,GAAG,IAAI,EAAE,GAAG,EAAE,GAAG,IAAI;IAM3B;;OAEG;IACH,MAAM,IAAI,IAAI;IAId;;OAEG;IACH,OAAO,IAAI,IAAI;CAGlB"}

package/lib/stage/crew/console-reporter/Printer.js

@@ -2,11 +2,8 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.Printer = void 0;
 /**
- * @desc
- *  A simple abstraction around the standard output stream
- *  with support for indenting the printed text.
- *
- * @public
+ * A simple abstraction around the standard output stream
+ * with support for indenting the printed text.
  */
 class Printer {
     stdout;
@@ -15,45 +12,30 @@ class Printer {
         this.stdout = stdout;
     }
     /**
-     * @desc
-     *  Prints the `args` to the `stdout`, followed by a new line character (`\n`).
+     * Prints the `args` to the `stdout`, followed by a new line character (`\n`).
      *
-     *  Please note that this method bypasses any indentation as it's intended
-     *  to be used to print separator lines, etc.
+     * Please note that this method bypasses any indentation as it's intended
+     * to be used to print separator lines, etc.
      *
-     * @param {...any[]} args
-     *
-     * @returns {void}
      */
     println(...args) {
         return this.print(...args, '\n');
     }
     /**
-     * @desc
-     *  Prints the `args` to the `stdout`, indenting the output according to
-     *  the current indentation level.
-     *
-     * @param {...any[]} args
-     *
-     * @returns {void}
+     * Prints the `args` to the `stdout`, indenting the output according to
+     * the current indentation level.
      */
     print(...args) {
         this.stdout.write(this.indentation.indented(`${args.map(String).join('')}`));
     }
     /**
-     * @desc
-     *  Increases the current indentation by 2 spaces.
-     *
-     * @returns {void}
+     * Increases the current indentation by 2 spaces.
      */
     indent() {
         this.indentation.increase();
     }
     /**
-     * @desc
-     *  Reduces the current indentation by 2 spaces.
-     *
-     * @returns {void}
+     * Reduces the current indentation by 2 spaces.
      */
     outdent() {
         this.indentation.decrease();

package/lib/stage/crew/console-reporter/Printer.js.map

@@ -1 +1 @@
-{"version":3,"file":"Printer.js","sourceRoot":"","sources":["../../../../src/stage/crew/console-reporter/Printer.ts"],"names":[],"mappings":";;;AAEA;;;;;;GAMG;AACH,MAAa,OAAO;IAGa;IAFrB,WAAW,GAAG,IAAI,WAAW,CAAC,CAAC,CAAC,CAAC;IAEzC,YAA6B,SAAuB,OAAO,CAAC,MAAM;QAArC,WAAM,GAAN,MAAM,CAA+B;IAClE,CAAC;IAED;;;;;;;;;;OAUG;IACH,OAAO,CAAC,GAAG,IAAW;QAClB,OAAO,IAAI,CAAC,KAAK,CAAC,GAAG,IAAI,EAAE,IAAI,CAAC,CAAC;IACrC,CAAC;IAED;;;;;;;;OAQG;IACH,KAAK,CAAC,GAAG,IAAW;QAChB,IAAI,CAAC,MAAM,CAAC,KAAK,CACb,IAAI,CAAC,WAAW,CAAC,QAAQ,CAAC,GAAI,IAAI,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC,IAAI,CAAC,EAAE,CAAE,EAAE,CAAC,CAC9D,CAAC;IACN,CAAC;IAED;;;;;OAKG;IACH,MAAM;QACF,IAAI,CAAC,WAAW,CAAC,QAAQ,EAAE,CAAC;IAChC,CAAC;IAED;;;;;OAKG;IACH,OAAO;QACH,IAAI,CAAC,WAAW,CAAC,QAAQ,EAAE,CAAC;IAChC,CAAC;CACJ;AAvDD,0BAuDC;AAED;;GAEG;AACH,MAAM,WAAW;IAGgB;IAFrB,OAAO,GAAG,CAAC,CAAC;IAEpB,YAA6B,IAAY;QAAZ,SAAI,GAAJ,IAAI,CAAQ;IACzC,CAAC;IAED,QAAQ;QACJ,IAAI,CAAC,OAAO,IAAI,IAAI,CAAC,IAAI,CAAC;IAC9B,CAAC;IAED,QAAQ;QACJ,IAAI,IAAI,CAAC,OAAO,GAAG,IAAI,CAAC,IAAI,IAAI,CAAC,EAAE;YAC/B,IAAI,CAAC,OAAO,IAAI,IAAI,CAAC,IAAI,CAAC;SAC7B;IACL,CAAC;IAED,QAAQ,CAAC,GAAG,SAAmB;QAC3B,OAAO,SAAS,CAAC,IAAI,CAAC,EAAE,CAAC;aACpB,KAAK,CAAC,IAAI,CAAC;aACX,GAAG,CAAC,IAAI,CAAC,EAAE,CAAC,IAAI;YACb,CAAC,CAAC,GAAG,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,GAAG,IAAI;YACjC,CAAC,CAAC,EAAE,CACP;aACA,IAAI,CAAC,IAAI,CAAC,CAAC;IACpB,CAAC;CACJ"}
+{"version":3,"file":"Printer.js","sourceRoot":"","sources":["../../../../src/stage/crew/console-reporter/Printer.ts"],"names":[],"mappings":";;;AAEA;;;GAGG;AACH,MAAa,OAAO;IAGa;IAFrB,WAAW,GAAG,IAAI,WAAW,CAAC,CAAC,CAAC,CAAC;IAEzC,YAA6B,SAAuB,OAAO,CAAC,MAAM;QAArC,WAAM,GAAN,MAAM,CAA+B;IAClE,CAAC;IAED;;;;;;OAMG;IACH,OAAO,CAAC,GAAG,IAAW;QAClB,OAAO,IAAI,CAAC,KAAK,CAAC,GAAG,IAAI,EAAE,IAAI,CAAC,CAAC;IACrC,CAAC;IAED;;;OAGG;IACH,KAAK,CAAC,GAAG,IAAW;QAChB,IAAI,CAAC,MAAM,CAAC,KAAK,CACb,IAAI,CAAC,WAAW,CAAC,QAAQ,CAAC,GAAI,IAAI,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC,IAAI,CAAC,EAAE,CAAE,EAAE,CAAC,CAC9D,CAAC;IACN,CAAC;IAED;;OAEG;IACH,MAAM;QACF,IAAI,CAAC,WAAW,CAAC,QAAQ,EAAE,CAAC;IAChC,CAAC;IAED;;OAEG;IACH,OAAO;QACH,IAAI,CAAC,WAAW,CAAC,QAAQ,EAAE,CAAC;IAChC,CAAC;CACJ;AAxCD,0BAwCC;AAED;;GAEG;AACH,MAAM,WAAW;IAGgB;IAFrB,OAAO,GAAG,CAAC,CAAC;IAEpB,YAA6B,IAAY;QAAZ,SAAI,GAAJ,IAAI,CAAQ;IACzC,CAAC;IAED,QAAQ;QACJ,IAAI,CAAC,OAAO,IAAI,IAAI,CAAC,IAAI,CAAC;IAC9B,CAAC;IAED,QAAQ;QACJ,IAAI,IAAI,CAAC,OAAO,GAAG,IAAI,CAAC,IAAI,IAAI,CAAC,EAAE;YAC/B,IAAI,CAAC,OAAO,IAAI,IAAI,CAAC,IAAI,CAAC;SAC7B;IACL,CAAC;IAED,QAAQ,CAAC,GAAG,SAAmB;QAC3B,OAAO,SAAS,CAAC,IAAI,CAAC,EAAE,CAAC;aACpB,KAAK,CAAC,IAAI,CAAC;aACX,GAAG,CAAC,IAAI,CAAC,EAAE,CAAC,IAAI;YACb,CAAC,CAAC,GAAG,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,GAAG,IAAI;YACjC,CAAC,CAAC,EAAE,CACP;aACA,IAAI,CAAC,IAAI,CAAC,CAAC;IACpB,CAAC;CACJ"}

package/lib/stage/crew/console-reporter/themes/TerminalTheme.d.ts

@@ -1,11 +1,7 @@
 import type { Outcome } from '@serenity-js/core/lib/model';
 /**
- * @desc
- *  Decorates text with control characters to make the terminal
- *  print output in colour.
- *
- * @public
- * @abstract
+ * Decorates text with control characters to make the terminal
+ * print output in colour.
  */
 export declare abstract class TerminalTheme {
     abstract heading(...parts: any[]): string;
@@ -13,27 +9,12 @@ export declare abstract class TerminalTheme {
     abstract separator(pattern: string): string;
     abstract log(...parts: any[]): string;
     /**
-     * @desc
-     *  Converts the `parts` to `string` and joins them together.
-     *
-     * @protected
-     *
-     * @param {any[]} parts
-     *
-     * @returns {string}
+     * Converts the `parts` to `string` and joins them together.
      */
     protected joined(parts: any[]): string;
     /**
-     * @desc
-     *  Repeats a given `pattern` so that it takes up to `maxLength` characters.
-     *  Used to produce separator lines.
-     *
-     * @protected
-     *
-     * @param {string} pattern
-     * @param {number} [maxLength=80] maxLength
-     *
-     * @returns {string}
+     * Repeats a given `pattern` so that it takes up to `maxLength` characters.
+     * Used to produce separator lines.
      */
     protected repeat(pattern: string, maxLength?: number): string;
 }

package/lib/stage/crew/console-reporter/themes/TerminalTheme.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"TerminalTheme.d.ts","sourceRoot":"","sources":["../../../../../src/stage/crew/console-reporter/themes/TerminalTheme.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,6BAA6B,CAAC;AAE3D;;;;;;;GAOG;AACH,8BAAsB,aAAa;IAC/B,QAAQ,CAAC,OAAO,CAAC,GAAG,KAAK,EAAE,GAAG,EAAE,GAAG,MAAM;IACzC,QAAQ,CAAC,OAAO,CAAC,OAAO,EAAE,OAAO,GAAG,MAAM,EAAE,GAAG,KAAK,EAAE,GAAG,EAAE,GAAG,MAAM;IACpE,QAAQ,CAAC,SAAS,CAAC,OAAO,EAAE,MAAM,GAAG,MAAM;IAC3C,QAAQ,CAAC,GAAG,CAAC,GAAG,KAAK,EAAE,GAAG,EAAE,GAAG,MAAM;IAErC;;;;;;;;;OASG;IACH,SAAS,CAAC,MAAM,CAAC,KAAK,EAAE,GAAG,EAAE,GAAG,MAAM;IAItC;;;;;;;;;;;OAWG;IACH,SAAS,CAAC,MAAM,CAAC,OAAO,EAAE,MAAM,EAAE,SAAS,SAAK,GAAG,MAAM;CAS5D"}
+{"version":3,"file":"TerminalTheme.d.ts","sourceRoot":"","sources":["../../../../../src/stage/crew/console-reporter/themes/TerminalTheme.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,6BAA6B,CAAC;AAE3D;;;GAGG;AACH,8BAAsB,aAAa;IAC/B,QAAQ,CAAC,OAAO,CAAC,GAAG,KAAK,EAAE,GAAG,EAAE,GAAG,MAAM;IACzC,QAAQ,CAAC,OAAO,CAAC,OAAO,EAAE,OAAO,GAAG,MAAM,EAAE,GAAG,KAAK,EAAE,GAAG,EAAE,GAAG,MAAM;IACpE,QAAQ,CAAC,SAAS,CAAC,OAAO,EAAE,MAAM,GAAG,MAAM;IAC3C,QAAQ,CAAC,GAAG,CAAC,GAAG,KAAK,EAAE,GAAG,EAAE,GAAG,MAAM;IAErC;;OAEG;IACH,SAAS,CAAC,MAAM,CAAC,KAAK,EAAE,GAAG,EAAE,GAAG,MAAM;IAItC;;;OAGG;IACH,SAAS,CAAC,MAAM,CAAC,OAAO,EAAE,MAAM,EAAE,SAAS,SAAK,GAAG,MAAM;CAS5D"}

package/lib/stage/crew/console-reporter/themes/TerminalTheme.js

@@ -2,38 +2,19 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.TerminalTheme = void 0;
 /**
- * @desc
- *  Decorates text with control characters to make the terminal
- *  print output in colour.
- *
- * @public
- * @abstract
+ * Decorates text with control characters to make the terminal
+ * print output in colour.
  */
 class TerminalTheme {
     /**
-     * @desc
-     *  Converts the `parts` to `string` and joins them together.
-     *
-     * @protected
-     *
-     * @param {any[]} parts
-     *
-     * @returns {string}
+     * Converts the `parts` to `string` and joins them together.
      */
     joined(parts) {
         return parts.map(String).join('');
     }
     /**
-     * @desc
-     *  Repeats a given `pattern` so that it takes up to `maxLength` characters.
-     *  Used to produce separator lines.
-     *
-     * @protected
-     *
-     * @param {string} pattern
-     * @param {number} [maxLength=80] maxLength
-     *
-     * @returns {string}
+     * Repeats a given `pattern` so that it takes up to `maxLength` characters.
+     * Used to produce separator lines.
      */
     repeat(pattern, maxLength = 80) {
         if (!pattern) {

package/lib/stage/crew/console-reporter/themes/TerminalTheme.js.map

@@ -1 +1 @@
-{"version":3,"file":"TerminalTheme.js","sourceRoot":"","sources":["../../../../../src/stage/crew/console-reporter/themes/TerminalTheme.ts"],"names":[],"mappings":";;;AAEA;;;;;;;GAOG;AACH,MAAsB,aAAa;IAM/B;;;;;;;;;OASG;IACO,MAAM,CAAC,KAAY;QACzB,OAAO,KAAK,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;IACtC,CAAC;IAED;;;;;;;;;;;OAWG;IACO,MAAM,CAAC,OAAe,EAAE,SAAS,GAAG,EAAE;QAC5C,IAAI,CAAE,OAAO,EAAE;YACX,OAAO,EAAE,CAAC;SACb;QAED,MAAM,WAAW,GAAG,IAAI,CAAC,KAAK,CAAC,SAAS,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC;QAE3D,OAAO,OAAO,CAAC,MAAM,CAAC,WAAW,CAAC,CAAC;IACvC,CAAC;CACJ;AAzCD,sCAyCC"}
+{"version":3,"file":"TerminalTheme.js","sourceRoot":"","sources":["../../../../../src/stage/crew/console-reporter/themes/TerminalTheme.ts"],"names":[],"mappings":";;;AAEA;;;GAGG;AACH,MAAsB,aAAa;IAM/B;;OAEG;IACO,MAAM,CAAC,KAAY;QACzB,OAAO,KAAK,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;IACtC,CAAC;IAED;;;OAGG;IACO,MAAM,CAAC,OAAe,EAAE,SAAS,GAAG,EAAE;QAC5C,IAAI,CAAE,OAAO,EAAE;YACX,OAAO,EAAE,CAAC;SACb;QAED,MAAM,WAAW,GAAG,IAAI,CAAC,KAAK,CAAC,SAAS,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC;QAE3D,OAAO,OAAO,CAAC,MAAM,CAAC,WAAW,CAAC,CAAC;IACvC,CAAC;CACJ;AA1BD,sCA0BC"}

package/lib/stage/crew/console-reporter/themes/ThemeForColourTerminals.d.ts

@@ -2,14 +2,8 @@ import { Outcome } from '@serenity-js/core/lib/model';
 import type { Chalk } from 'chalk';
 import { TerminalTheme } from './TerminalTheme';
 /**
- * @desc
- *  Base class for {@apilink TerminalTheme} implementations intended
- *  to print to terminals that support colour output.
- *
- * @extends {TerminalTheme}
- *
- * @public
- * @abstract
+ * Base class for `TerminalTheme` implementations intended
+ * to print to terminals that support colour output.
  */
 export declare abstract class ThemeForColourTerminals extends TerminalTheme {
     protected readonly chalk: Chalk;
@@ -21,10 +15,10 @@ export declare abstract class ThemeForColourTerminals extends TerminalTheme {
     constructor(chalk: Chalk);
     /**
      * Joins the `parts` into a single string and decorates it
-     * using a colour appropriate for a given {@apilink Outcome}.
+     * using a colour appropriate for a given `Outcome`.
      *
      * @param outcome
-     *  an instance of an {@apilink @serenity-js/core/lib/model~Outcome}
+     *  an instance of an `Outcome`
      *  or a string class name of one of its implementations.
      *
      * @param parts

package/lib/stage/crew/console-reporter/themes/ThemeForColourTerminals.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"ThemeForColourTerminals.d.ts","sourceRoot":"","sources":["../../../../../src/stage/crew/console-reporter/themes/ThemeForColourTerminals.ts"],"names":[],"mappings":"AAAA,OAAO,EAAgJ,OAAO,EAAE,MAAM,6BAA6B,CAAC;AACpM,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,OAAO,CAAC;AAEnC,OAAO,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAC;AAEhD;;;;;;;;;GASG;AACH,8BAAsB,uBAAwB,SAAQ,aAAa;IAOnD,SAAS,CAAC,QAAQ,CAAC,KAAK,EAAE,KAAK;IAL3C;;;;OAIG;gBAC4B,KAAK,EAAE,KAAK;IAI3C;;;;;;;;;;OAUG;IACH,OAAO,CAAC,OAAO,EAAE,OAAO,GAAG,MAAM,EAAE,GAAG,KAAK,EAAE,GAAG,EAAE,GAAG,MAAM;CAqB9D"}
+{"version":3,"file":"ThemeForColourTerminals.d.ts","sourceRoot":"","sources":["../../../../../src/stage/crew/console-reporter/themes/ThemeForColourTerminals.ts"],"names":[],"mappings":"AAAA,OAAO,EAAgJ,OAAO,EAAE,MAAM,6BAA6B,CAAC;AACpM,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,OAAO,CAAC;AAEnC,OAAO,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAC;AAEhD;;;GAGG;AACH,8BAAsB,uBAAwB,SAAQ,aAAa;IAOnD,SAAS,CAAC,QAAQ,CAAC,KAAK,EAAE,KAAK;IAL3C;;;;OAIG;gBAC4B,KAAK,EAAE,KAAK;IAI3C;;;;;;;;;;OAUG;IACH,OAAO,CAAC,OAAO,EAAE,OAAO,GAAG,MAAM,EAAE,GAAG,KAAK,EAAE,GAAG,EAAE,GAAG,MAAM;CAqB9D"}

package/lib/stage/crew/console-reporter/themes/ThemeForColourTerminals.js

@@ -4,14 +4,8 @@ exports.ThemeForColourTerminals = void 0;
 const model_1 = require("@serenity-js/core/lib/model");
 const TerminalTheme_1 = require("./TerminalTheme");
 /**
- * @desc
- *  Base class for {@apilink TerminalTheme} implementations intended
- *  to print to terminals that support colour output.
- *
- * @extends {TerminalTheme}
- *
- * @public
- * @abstract
+ * Base class for `TerminalTheme` implementations intended
+ * to print to terminals that support colour output.
  */
 class ThemeForColourTerminals extends TerminalTheme_1.TerminalTheme {
     chalk;
@@ -26,10 +20,10 @@ class ThemeForColourTerminals extends TerminalTheme_1.TerminalTheme {
     }
     /**
      * Joins the `parts` into a single string and decorates it
-     * using a colour appropriate for a given {@apilink Outcome}.
+     * using a colour appropriate for a given `Outcome`.
      *
      * @param outcome
-     *  an instance of an {@apilink @serenity-js/core/lib/model~Outcome}
+     *  an instance of an `Outcome`
      *  or a string class name of one of its implementations.
      *
      * @param parts

package/lib/stage/crew/console-reporter/themes/ThemeForColourTerminals.js.map

@@ -1 +1 @@
-{"version":3,"file":"ThemeForColourTerminals.js","sourceRoot":"","sources":["../../../../../src/stage/crew/console-reporter/themes/ThemeForColourTerminals.ts"],"names":[],"mappings":";;;AAAA,uDAAoM;AAGpM,mDAAgD;AAEhD;;;;;;;;;GASG;AACH,MAAsB,uBAAwB,SAAQ,6BAAa;IAOhC;IAL/B;;;;OAIG;IACH,YAA+B,KAAY;QACvC,KAAK,EAAE,CAAC;QADmB,UAAK,GAAL,KAAK,CAAO;IAE3C,CAAC;IAED;;;;;;;;;;OAUG;IACH,OAAO,CAAC,OAAyB,EAAE,GAAG,KAAY;QAC9C,MAAM,WAAW,GAAG,CAAC,OAAO,YAAY,eAAO,CAAC;YAC5C,CAAC,CAAC,OAAO,CAAC,WAAW,CAAC,IAAI;YAC1B,CAAC,CAAC,OAAO,CAAC;QAEd,QAAQ,WAAW,EAAE;YACjB,KAAK,4BAAoB,CAAC,IAAI;gBAC1B,OAAO,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC;YAClD,KAAK,gCAAwB,CAAC,IAAI,CAAC;YACnC,KAAK,yCAAiC,CAAC,IAAI;gBACvC,OAAO,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC;YAC9C,KAAK,6BAAqB,CAAC,IAAI;gBAC3B,OAAO,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC;YAC/C,KAAK,wBAAgB,CAAC,IAAI,CAAC;YAC3B,KAAK,wBAAgB,CAAC,IAAI;gBACtB,OAAO,IAAI,CAAC,KAAK,CAAC,WAAW,CAAC,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC;YACtD,iCAAiC;YACjC;gBACI,OAAO,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC;SACnD;IACL,CAAC;CACJ;AA3CD,0DA2CC"}
+{"version":3,"file":"ThemeForColourTerminals.js","sourceRoot":"","sources":["../../../../../src/stage/crew/console-reporter/themes/ThemeForColourTerminals.ts"],"names":[],"mappings":";;;AAAA,uDAAoM;AAGpM,mDAAgD;AAEhD;;;GAGG;AACH,MAAsB,uBAAwB,SAAQ,6BAAa;IAOhC;IAL/B;;;;OAIG;IACH,YAA+B,KAAY;QACvC,KAAK,EAAE,CAAC;QADmB,UAAK,GAAL,KAAK,CAAO;IAE3C,CAAC;IAED;;;;;;;;;;OAUG;IACH,OAAO,CAAC,OAAyB,EAAE,GAAG,KAAY;QAC9C,MAAM,WAAW,GAAG,CAAC,OAAO,YAAY,eAAO,CAAC;YAC5C,CAAC,CAAC,OAAO,CAAC,WAAW,CAAC,IAAI;YAC1B,CAAC,CAAC,OAAO,CAAC;QAEd,QAAQ,WAAW,EAAE;YACjB,KAAK,4BAAoB,CAAC,IAAI;gBAC1B,OAAO,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC;YAClD,KAAK,gCAAwB,CAAC,IAAI,CAAC;YACnC,KAAK,yCAAiC,CAAC,IAAI;gBACvC,OAAO,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC;YAC9C,KAAK,6BAAqB,CAAC,IAAI;gBAC3B,OAAO,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC;YAC/C,KAAK,wBAAgB,CAAC,IAAI,CAAC;YAC3B,KAAK,wBAAgB,CAAC,IAAI;gBACtB,OAAO,IAAI,CAAC,KAAK,CAAC,WAAW,CAAC,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC;YACtD,iCAAiC;YACjC;gBACI,OAAO,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC;SACnD;IACL,CAAC;CACJ;AA3CD,0DA2CC"}

package/lib/stage/crew/console-reporter/themes/ThemeForDarkTerminals.d.ts

@@ -1,12 +1,7 @@
 import type { Chalk } from 'chalk';
 import { ThemeForColourTerminals } from './ThemeForColourTerminals';
 /**
- * @desc
- *  A simple colour theme for terminals with dark backgrounds.
- *
- * @extends {ThemeForColourTerminals}
- *
- * @public
+ * A simple colour theme for terminals with dark backgrounds.
  */
 export declare class ThemeForDarkTerminals extends ThemeForColourTerminals {
     /**
@@ -16,32 +11,21 @@ export declare class ThemeForDarkTerminals extends ThemeForColourTerminals {
      */
     constructor(chalk: Chalk);
     /**
-     * @desc
-     *  Formats the heading
+     * Formats the heading
      *
-     * @param {...any[]} parts
+     * @param parts
      *  `parts` to be converted to string, joined together, and formatted as a heading
-     *
-     * @returns {string}
      */
     heading(...parts: any[]): string;
     /**
-     * @desc
-     *  Decorates the heading with theme colours.
+     * Decorates the heading with theme colours.
      *
-     * @param {string} pattern
+     * @param pattern
      *  The pattern to be repeated to create a separator, for example `-`, `✂ - - `, etc.
-     *
-     * @returns {string}
      */
     separator(pattern: string): string;
     /**
-     * @desc
-     *  Decorates the log entries that the developer wanted to have captured in the output.
-     *
-     * @param {...any[]} parts
-     *
-     * @returns {string}
+     * Decorates the log entries that the developer wanted to have captured in the output.
      */
     log(...parts: any[]): string;
 }

package/lib/stage/crew/console-reporter/themes/ThemeForDarkTerminals.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"ThemeForDarkTerminals.d.ts","sourceRoot":"","sources":["../../../../../src/stage/crew/console-reporter/themes/ThemeForDarkTerminals.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,OAAO,CAAC;AAEnC,OAAO,EAAE,uBAAuB,EAAE,MAAM,2BAA2B,CAAC;AAEpE;;;;;;;GAOG;AACH,qBAAa,qBAAsB,SAAQ,uBAAuB;IAE9D;;;;OAIG;gBACS,KAAK,EAAE,KAAK;IAIxB;;;;;;;;OAQG;IACH,OAAO,CAAC,GAAG,KAAK,EAAE,GAAG,EAAE,GAAG,MAAM;IAIhC;;;;;;;;OAQG;IACH,SAAS,CAAC,OAAO,EAAE,MAAM,GAAG,MAAM;IAIlC;;;;;;;OAOG;IACH,GAAG,CAAC,GAAG,KAAK,EAAE,GAAG,EAAE,GAAG,MAAM;CAG/B"}
+{"version":3,"file":"ThemeForDarkTerminals.d.ts","sourceRoot":"","sources":["../../../../../src/stage/crew/console-reporter/themes/ThemeForDarkTerminals.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,OAAO,CAAC;AAEnC,OAAO,EAAE,uBAAuB,EAAE,MAAM,2BAA2B,CAAC;AAEpE;;GAEG;AACH,qBAAa,qBAAsB,SAAQ,uBAAuB;IAE9D;;;;OAIG;gBACS,KAAK,EAAE,KAAK;IAIxB;;;;;OAKG;IACH,OAAO,CAAC,GAAG,KAAK,EAAE,GAAG,EAAE,GAAG,MAAM;IAIhC;;;;;OAKG;IACH,SAAS,CAAC,OAAO,EAAE,MAAM,GAAG,MAAM;IAIlC;;OAEG;IACH,GAAG,CAAC,GAAG,KAAK,EAAE,GAAG,EAAE,GAAG,MAAM;CAG/B"}

package/lib/stage/crew/console-reporter/themes/ThemeForDarkTerminals.js

@@ -3,12 +3,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.ThemeForDarkTerminals = void 0;
 const ThemeForColourTerminals_1 = require("./ThemeForColourTerminals");
 /**
- * @desc
- *  A simple colour theme for terminals with dark backgrounds.
- *
- * @extends {ThemeForColourTerminals}
- *
- * @public
+ * A simple colour theme for terminals with dark backgrounds.
  */
 class ThemeForDarkTerminals extends ThemeForColourTerminals_1.ThemeForColourTerminals {
     /**
@@ -20,36 +15,25 @@ class ThemeForDarkTerminals extends ThemeForColourTerminals_1.ThemeForColourTerm
         super(chalk);
     }
     /**
-     * @desc
-     *  Formats the heading
+     * Formats the heading
      *
-     * @param {...any[]} parts
+     * @param parts
      *  `parts` to be converted to string, joined together, and formatted as a heading
-     *
-     * @returns {string}
      */
     heading(...parts) {
         return this.chalk.bold.white(this.joined(parts));
     }
     /**
-     * @desc
-     *  Decorates the heading with theme colours.
+     * Decorates the heading with theme colours.
      *
-     * @param {string} pattern
+     * @param pattern
      *  The pattern to be repeated to create a separator, for example `-`, `✂ - - `, etc.
-     *
-     * @returns {string}
      */
     separator(pattern) {
         return this.chalk.yellow(this.repeat(pattern));
     }
     /**
-     * @desc
-     *  Decorates the log entries that the developer wanted to have captured in the output.
-     *
-     * @param {...any[]} parts
-     *
-     * @returns {string}
+     * Decorates the log entries that the developer wanted to have captured in the output.
      */
     log(...parts) {
         return this.chalk.yellow(this.joined(parts));

package/lib/stage/crew/console-reporter/themes/ThemeForDarkTerminals.js.map

@@ -1 +1 @@
-{"version":3,"file":"ThemeForDarkTerminals.js","sourceRoot":"","sources":["../../../../../src/stage/crew/console-reporter/themes/ThemeForDarkTerminals.ts"],"names":[],"mappings":";;;AAEA,uEAAoE;AAEpE;;;;;;;GAOG;AACH,MAAa,qBAAsB,SAAQ,iDAAuB;IAE9D;;;;OAIG;IACH,YAAY,KAAY;QACpB,KAAK,CAAC,KAAK,CAAC,CAAC;IACjB,CAAC;IAED;;;;;;;;OAQG;IACH,OAAO,CAAC,GAAG,KAAY;QACnB,OAAO,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC;IACrD,CAAC;IAED;;;;;;;;OAQG;IACH,SAAS,CAAC,OAAe;QACrB,OAAO,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,CAAC;IACnD,CAAC;IAED;;;;;;;OAOG;IACH,GAAG,CAAC,GAAG,KAAY;QACf,OAAO,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC;IACjD,CAAC;CACJ;AAhDD,sDAgDC"}
+{"version":3,"file":"ThemeForDarkTerminals.js","sourceRoot":"","sources":["../../../../../src/stage/crew/console-reporter/themes/ThemeForDarkTerminals.ts"],"names":[],"mappings":";;;AAEA,uEAAoE;AAEpE;;GAEG;AACH,MAAa,qBAAsB,SAAQ,iDAAuB;IAE9D;;;;OAIG;IACH,YAAY,KAAY;QACpB,KAAK,CAAC,KAAK,CAAC,CAAC;IACjB,CAAC;IAED;;;;;OAKG;IACH,OAAO,CAAC,GAAG,KAAY;QACnB,OAAO,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC;IACrD,CAAC;IAED;;;;;OAKG;IACH,SAAS,CAAC,OAAe;QACrB,OAAO,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,CAAC;IACnD,CAAC;IAED;;OAEG;IACH,GAAG,CAAC,GAAG,KAAY;QACf,OAAO,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC;IACjD,CAAC;CACJ;AArCD,sDAqCC"}

package/lib/stage/crew/console-reporter/themes/ThemeForLightTerminals.d.ts

@@ -1,47 +1,31 @@
 import type { Chalk } from 'chalk';
 import { ThemeForColourTerminals } from './ThemeForColourTerminals';
 /**
- * @desc
- *  A simple colour theme for terminals with light backgrounds.
- *
- * @extends {ThemeForColourTerminals}
- *
- * @public
+ * A simple colour theme for terminals with light backgrounds.
  */
 export declare class ThemeForLightTerminals extends ThemeForColourTerminals {
     /**
-     * @param {chalk~Chalk} chalk
-     *
      * @see https://www.npmjs.com/package/chalk
      */
     constructor(chalk: Chalk);
     /**
-     * @desc
-     *  Decorates the heading with theme colours.
+     * Decorates the heading with theme colours.
      *
-     * @param {...any[]} parts
+     * @param parts
      *  `parts` to be converted to string, joined together, and formatted as a heading
-     *
-     * @returns {string}
      */
     heading(...parts: any[]): string;
     /**
-     * @desc
-     *  Decorates the heading with theme colours.
+     * Decorates the heading with theme colours.
      *
-     * @param {string} pattern
+     * @param pattern
      *  The pattern to be repeated to create a separator, for example `-`, `✂ - - `, etc.
-     *
-     * @returns {string}
      */
     separator(pattern: string): string;
     /**
-     * @desc
-     *  Decorates the log entries that the developer wanted to have captured in the output.
-     *
-     * @param {...any[]} parts
+     * Decorates the log entries that the developer wanted to have captured in the output.
      *
-     * @returns {string}
+     * @param parts
      */
     log(...parts: any[]): string;
 }

package/lib/stage/crew/console-reporter/themes/ThemeForLightTerminals.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"ThemeForLightTerminals.d.ts","sourceRoot":"","sources":["../../../../../src/stage/crew/console-reporter/themes/ThemeForLightTerminals.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,OAAO,CAAC;AAEnC,OAAO,EAAE,uBAAuB,EAAE,MAAM,2BAA2B,CAAC;AAEpE;;;;;;;GAOG;AACH,qBAAa,sBAAuB,SAAQ,uBAAuB;IAE/D;;;;OAIG;gBACS,KAAK,EAAE,KAAK;IAIxB;;;;;;;;OAQG;IACH,OAAO,CAAC,GAAG,KAAK,EAAE,GAAG,EAAE,GAAG,MAAM;IAIhC;;;;;;;;OAQG;IACH,SAAS,CAAC,OAAO,EAAE,MAAM,GAAG,MAAM;IAIlC;;;;;;;OAOG;IACH,GAAG,CAAC,GAAG,KAAK,EAAE,GAAG,EAAE,GAAG,MAAM;CAG/B"}
+{"version":3,"file":"ThemeForLightTerminals.d.ts","sourceRoot":"","sources":["../../../../../src/stage/crew/console-reporter/themes/ThemeForLightTerminals.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,OAAO,CAAC;AAEnC,OAAO,EAAE,uBAAuB,EAAE,MAAM,2BAA2B,CAAC;AAEpE;;GAEG;AACH,qBAAa,sBAAuB,SAAQ,uBAAuB;IAE/D;;OAEG;gBACS,KAAK,EAAE,KAAK;IAIxB;;;;;OAKG;IACH,OAAO,CAAC,GAAG,KAAK,EAAE,GAAG,EAAE,GAAG,MAAM;IAIhC;;;;;OAKG;IACH,SAAS,CAAC,OAAO,EAAE,MAAM,GAAG,MAAM;IAIlC;;;;OAIG;IACH,GAAG,CAAC,GAAG,KAAK,EAAE,GAAG,EAAE,GAAG,MAAM;CAG/B"}

package/lib/stage/crew/console-reporter/themes/ThemeForLightTerminals.js

@@ -3,53 +3,37 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.ThemeForLightTerminals = void 0;
 const ThemeForColourTerminals_1 = require("./ThemeForColourTerminals");
 /**
- * @desc
- *  A simple colour theme for terminals with light backgrounds.
- *
- * @extends {ThemeForColourTerminals}
- *
- * @public
+ * A simple colour theme for terminals with light backgrounds.
  */
 class ThemeForLightTerminals extends ThemeForColourTerminals_1.ThemeForColourTerminals {
     /**
-     * @param {chalk~Chalk} chalk
-     *
      * @see https://www.npmjs.com/package/chalk
      */
     constructor(chalk) {
         super(chalk);
     }
     /**
-     * @desc
-     *  Decorates the heading with theme colours.
+     * Decorates the heading with theme colours.
      *
-     * @param {...any[]} parts
+     * @param parts
      *  `parts` to be converted to string, joined together, and formatted as a heading
-     *
-     * @returns {string}
      */
     heading(...parts) {
         return this.chalk.bold.black(this.joined(parts));
     }
     /**
-     * @desc
-     *  Decorates the heading with theme colours.
+     * Decorates the heading with theme colours.
      *
-     * @param {string} pattern
+     * @param pattern
      *  The pattern to be repeated to create a separator, for example `-`, `✂ - - `, etc.
-     *
-     * @returns {string}
      */
     separator(pattern) {
         return this.repeat(pattern);
     }
     /**
-     * @desc
-     *  Decorates the log entries that the developer wanted to have captured in the output.
-     *
-     * @param {...any[]} parts
+     * Decorates the log entries that the developer wanted to have captured in the output.
      *
-     * @returns {string}
+     * @param parts
      */
     log(...parts) {
         return this.joined(parts);

package/lib/stage/crew/console-reporter/themes/ThemeForLightTerminals.js.map

@@ -1 +1 @@
-{"version":3,"file":"ThemeForLightTerminals.js","sourceRoot":"","sources":["../../../../../src/stage/crew/console-reporter/themes/ThemeForLightTerminals.ts"],"names":[],"mappings":";;;AAEA,uEAAoE;AAEpE;;;;;;;GAOG;AACH,MAAa,sBAAuB,SAAQ,iDAAuB;IAE/D;;;;OAIG;IACH,YAAY,KAAY;QACpB,KAAK,CAAC,KAAK,CAAC,CAAC;IACjB,CAAC;IAED;;;;;;;;OAQG;IACH,OAAO,CAAC,GAAG,KAAY;QACnB,OAAO,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC;IACrD,CAAC;IAED;;;;;;;;OAQG;IACH,SAAS,CAAC,OAAe;QACrB,OAAO,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;IAChC,CAAC;IAED;;;;;;;OAOG;IACH,GAAG,CAAC,GAAG,KAAY;QACf,OAAO,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;IAC9B,CAAC;CACJ;AAhDD,wDAgDC"}
+{"version":3,"file":"ThemeForLightTerminals.js","sourceRoot":"","sources":["../../../../../src/stage/crew/console-reporter/themes/ThemeForLightTerminals.ts"],"names":[],"mappings":";;;AAEA,uEAAoE;AAEpE;;GAEG;AACH,MAAa,sBAAuB,SAAQ,iDAAuB;IAE/D;;OAEG;IACH,YAAY,KAAY;QACpB,KAAK,CAAC,KAAK,CAAC,CAAC;IACjB,CAAC;IAED;;;;;OAKG;IACH,OAAO,CAAC,GAAG,KAAY;QACnB,OAAO,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC;IACrD,CAAC;IAED;;;;;OAKG;IACH,SAAS,CAAC,OAAe;QACrB,OAAO,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;IAChC,CAAC;IAED;;;;OAIG;IACH,GAAG,CAAC,GAAG,KAAY;QACf,OAAO,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;IAC9B,CAAC;CACJ;AArCD,wDAqCC"}

package/lib/stage/crew/console-reporter/themes/ThemeForMonochromaticTerminals.d.ts

@@ -1,22 +1,14 @@
 import type { Outcome } from '@serenity-js/core/lib/model';
 import { TerminalTheme } from './TerminalTheme';
 /**
- * @desc
- *  A simple colour theme for terminals with no colour support.
- *
- * @extends {TerminalTheme}
- *
- * @public
+ * A simple colour theme for terminals with no colour support.
  */
 export declare class ThemeForMonochromaticTerminals extends TerminalTheme {
     /**
-     * @desc
-     *  Formats the heading
+     * Formats the heading
      *
-     * @param {...any[]} parts
+     * @param parts
      *  `parts` to be converted to string, joined together, and formatted as a heading
-     *
-     * @returns {string}
      */
     heading(...parts: any[]): string;
     /**
@@ -25,32 +17,24 @@ export declare class ThemeForMonochromaticTerminals extends TerminalTheme {
      * no decoration of the text is performed.
      *
      * @param outcome
-     *  an instance of an {@apilink Outcome}
+     *  an instance of an `Outcome`
      *  or a string class name of one of its implementations.
      *
      * @param parts
      *  the parts of the message
-     *
-     * @returns {string}
      */
     outcome(outcome: Outcome, ...parts: any[]): string;
     /**
-     * @desc
-     *  Decorates the heading with theme colours.
+     * Decorates the heading with theme colours.
      *
-     * @param {string} pattern
+     * @param pattern
      *  The pattern to be repeated to create a separator, for example `-`, `✂ - - `, etc.
-     *
-     * @returns {string}
      */
     separator(pattern: string): string;
     /**
-     * @desc
-     *  Decorates the log entries that the developer wanted to have captured in the output.
-     *
-     * @param {...any[]} parts
+     * Decorates the log entries that the developer wanted to have captured in the output.
      *
-     * @returns {string}
+     * @param parts
      */
     log(...parts: any[]): string;
 }

package/lib/stage/crew/console-reporter/themes/ThemeForMonochromaticTerminals.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"ThemeForMonochromaticTerminals.d.ts","sourceRoot":"","sources":["../../../../../src/stage/crew/console-reporter/themes/ThemeForMonochromaticTerminals.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,6BAA6B,CAAC;AAE3D,OAAO,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAC;AAEhD;;;;;;;GAOG;AACH,qBAAa,8BAA+B,SAAQ,aAAa;IAE7D;;;;;;;;OAQG;IACH,OAAO,CAAC,GAAG,KAAK,EAAE,GAAG,EAAE,GAAG,MAAM;IAIhC;;;;;;;;;;;;;OAaG;IACH,OAAO,CAAC,OAAO,EAAE,OAAO,EAAE,GAAG,KAAK,EAAE,GAAG,EAAE,GAAG,MAAM;IAIlD;;;;;;;;OAQG;IACH,SAAS,CAAC,OAAO,EAAE,MAAM,GAAG,MAAM;IAIlC;;;;;;;OAOG;IACH,GAAG,CAAC,GAAG,KAAK,EAAE,GAAG,EAAE,GAAG,MAAM;CAG/B"}
+{"version":3,"file":"ThemeForMonochromaticTerminals.d.ts","sourceRoot":"","sources":["../../../../../src/stage/crew/console-reporter/themes/ThemeForMonochromaticTerminals.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,6BAA6B,CAAC;AAE3D,OAAO,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAC;AAEhD;;GAEG;AACH,qBAAa,8BAA+B,SAAQ,aAAa;IAE7D;;;;;OAKG;IACH,OAAO,CAAC,GAAG,KAAK,EAAE,GAAG,EAAE,GAAG,MAAM;IAIhC;;;;;;;;;;;OAWG;IACH,OAAO,CAAC,OAAO,EAAE,OAAO,EAAE,GAAG,KAAK,EAAE,GAAG,EAAE,GAAG,MAAM;IAIlD;;;;;OAKG;IACH,SAAS,CAAC,OAAO,EAAE,MAAM,GAAG,MAAM;IAIlC;;;;OAIG;IACH,GAAG,CAAC,GAAG,KAAK,EAAE,GAAG,EAAE,GAAG,MAAM;CAG/B"}

package/lib/stage/crew/console-reporter/themes/ThemeForMonochromaticTerminals.js

@@ -3,22 +3,14 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.ThemeForMonochromaticTerminals = void 0;
 const TerminalTheme_1 = require("./TerminalTheme");
 /**
- * @desc
- *  A simple colour theme for terminals with no colour support.
- *
- * @extends {TerminalTheme}
- *
- * @public
+ * A simple colour theme for terminals with no colour support.
  */
 class ThemeForMonochromaticTerminals extends TerminalTheme_1.TerminalTheme {
     /**
-     * @desc
-     *  Formats the heading
+     * Formats the heading
      *
-     * @param {...any[]} parts
+     * @param parts
      *  `parts` to be converted to string, joined together, and formatted as a heading
-     *
-     * @returns {string}
      */
     heading(...parts) {
         return this.joined(parts);
@@ -29,36 +21,28 @@ class ThemeForMonochromaticTerminals extends TerminalTheme_1.TerminalTheme {
      * no decoration of the text is performed.
      *
      * @param outcome
-     *  an instance of an {@apilink Outcome}
+     *  an instance of an `Outcome`
      *  or a string class name of one of its implementations.
      *
      * @param parts
      *  the parts of the message
-     *
-     * @returns {string}
      */
     outcome(outcome, ...parts) {
         return this.joined(parts);
     }
     /**
-     * @desc
-     *  Decorates the heading with theme colours.
+     * Decorates the heading with theme colours.
      *
-     * @param {string} pattern
+     * @param pattern
      *  The pattern to be repeated to create a separator, for example `-`, `✂ - - `, etc.
-     *
-     * @returns {string}
      */
     separator(pattern) {
         return this.repeat(pattern);
     }
     /**
-     * @desc
-     *  Decorates the log entries that the developer wanted to have captured in the output.
-     *
-     * @param {...any[]} parts
+     * Decorates the log entries that the developer wanted to have captured in the output.
      *
-     * @returns {string}
+     * @param parts
      */
     log(...parts) {
         return this.joined(parts);

package/lib/stage/crew/console-reporter/themes/ThemeForMonochromaticTerminals.js.map

@@ -1 +1 @@
-{"version":3,"file":"ThemeForMonochromaticTerminals.js","sourceRoot":"","sources":["../../../../../src/stage/crew/console-reporter/themes/ThemeForMonochromaticTerminals.ts"],"names":[],"mappings":";;;AAEA,mDAAgD;AAEhD;;;;;;;GAOG;AACH,MAAa,8BAA+B,SAAQ,6BAAa;IAE7D;;;;;;;;OAQG;IACH,OAAO,CAAC,GAAG,KAAY;QACnB,OAAO,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;IAC9B,CAAC;IAED;;;;;;;;;;;;;OAaG;IACH,OAAO,CAAC,OAAgB,EAAE,GAAG,KAAY;QACrC,OAAO,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;IAC9B,CAAC;IAED;;;;;;;;OAQG;IACH,SAAS,CAAC,OAAe;QACrB,OAAO,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;IAChC,CAAC;IAED;;;;;;;OAOG;IACH,GAAG,CAAC,GAAG,KAAY;QACf,OAAO,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;IAC9B,CAAC;CACJ;AAzDD,wEAyDC"}
+{"version":3,"file":"ThemeForMonochromaticTerminals.js","sourceRoot":"","sources":["../../../../../src/stage/crew/console-reporter/themes/ThemeForMonochromaticTerminals.ts"],"names":[],"mappings":";;;AAEA,mDAAgD;AAEhD;;GAEG;AACH,MAAa,8BAA+B,SAAQ,6BAAa;IAE7D;;;;;OAKG;IACH,OAAO,CAAC,GAAG,KAAY;QACnB,OAAO,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;IAC9B,CAAC;IAED;;;;;;;;;;;OAWG;IACH,OAAO,CAAC,OAAgB,EAAE,GAAG,KAAY;QACrC,OAAO,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;IAC9B,CAAC;IAED;;;;;OAKG;IACH,SAAS,CAAC,OAAe;QACrB,OAAO,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;IAChC,CAAC;IAED;;;;OAIG;IACH,GAAG,CAAC,GAAG,KAAY;QACf,OAAO,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;IAC9B,CAAC;CACJ;AA9CD,wEA8CC"}

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@serenity-js/console-reporter",
-  "version": "3.25.0",
-  "description": "Serenity/JS console reporter",
+  "version": "3.25.2",
+  "description": "Serenity/JS console reporter that displays test results directly in the standard output",
   "author": {
     "name": "Jan Molak",
     "email": "jan.molak@smartcodeltd.co.uk",
@@ -43,7 +43,7 @@
     "node": "^16.13 || ^18.12 || ^20"
   },
   "dependencies": {
-    "@serenity-js/core": "3.25.0",
+    "@serenity-js/core": "3.25.2",
     "chalk": "4.1.2",
     "tiny-types": "1.22.0"
   },
@@ -57,5 +57,5 @@
     "ts-node": "10.9.2",
     "typescript": "5.2.2"
   },
-  "gitHead": "22657b685b6002f75b2569db54f4bea31ab91d12"
+  "gitHead": "98b68da1e04a8fcbb255dca509b7bc9c322a3b6b"
 }

package/src/stage/crew/console-reporter/ConsoleReporter.ts

@@ -40,7 +40,7 @@ import type { TerminalTheme} from './themes';
 import { ThemeForDarkTerminals, ThemeForLightTerminals, ThemeForMonochromaticTerminals } from './themes';
 
 /**
- * A {@apilink StageCrewMember} that uses [standard output](https://en.wikipedia.org/wiki/Standard_streams)
+ * A [`StageCrewMember`](https://serenity-js.org/api/core/interface/StageCrewMember/) that uses [standard output](https://en.wikipedia.org/wiki/Standard_streams)
  * to report on progress of your Serenity/JS acceptance tests.
  *
  * `ConsoleReporter` ships with colour themes for both dark and light terminals,
@@ -239,9 +239,9 @@ export class ConsoleReporter implements ListensToDomainEvents {
     }
 
     /**
-     * Handles {@apilink DomainEvent} objects emitted by the {@apilink Stage}.
+     * Handles [`DomainEvent`](https://serenity-js.org/api/core-events/class/DomainEvent/) objects emitted by the [`Stage`](https://serenity-js.org/api/core/class/Stage/).
      *
-     * @see {@apilink StageCrewMember}
+     * @see [`StageCrewMember`](https://serenity-js.org/api/core/interface/StageCrewMember/)
      *
      * @listens {DomainEvent}
      *

package/src/stage/crew/console-reporter/ConsoleReporterConfig.ts

@@ -1,5 +1,5 @@
 /**
- * Used to configure the {@apilink ConsoleReporter}.
+ * Used to configure the [`ConsoleReporter`](https://serenity-js.org/api/console-reporter/class/ConsoleReporter/).
  *
  * @group Stage
  */

package/src/stage/crew/console-reporter/Printer.ts

@@ -1,11 +1,8 @@
 import type { OutputStream } from '@serenity-js/core/lib/adapter';
 
 /**
- * @desc
- *  A simple abstraction around the standard output stream
- *  with support for indenting the printed text.
- *
- * @public
+ * A simple abstraction around the standard output stream
+ * with support for indenting the printed text.
  */
 export class Printer {
     private indentation = new Indentation(2);
@@ -14,28 +11,19 @@ export class Printer {
     }
 
     /**
-     * @desc
-     *  Prints the `args` to the `stdout`, followed by a new line character (`\n`).
+     * Prints the `args` to the `stdout`, followed by a new line character (`\n`).
      *
-     *  Please note that this method bypasses any indentation as it's intended
-     *  to be used to print separator lines, etc.
+     * Please note that this method bypasses any indentation as it's intended
+     * to be used to print separator lines, etc.
      *
-     * @param {...any[]} args
-     *
-     * @returns {void}
      */
     println(...args: any[]): void {
         return this.print(...args, '\n');
     }
 
     /**
-     * @desc
-     *  Prints the `args` to the `stdout`, indenting the output according to
-     *  the current indentation level.
-     *
-     * @param {...any[]} args
-     *
-     * @returns {void}
+     * Prints the `args` to the `stdout`, indenting the output according to
+     * the current indentation level.
      */
     print(...args: any[]): void {
         this.stdout.write(
@@ -44,20 +32,14 @@ export class Printer {
     }
 
     /**
-     * @desc
-     *  Increases the current indentation by 2 spaces.
-     *
-     * @returns {void}
+     * Increases the current indentation by 2 spaces.
      */
     indent(): void {
         this.indentation.increase();
     }
 
     /**
-     * @desc
-     *  Reduces the current indentation by 2 spaces.
-     *
-     * @returns {void}
+     * Reduces the current indentation by 2 spaces.
      */
     outdent(): void {
         this.indentation.decrease();

package/src/stage/crew/console-reporter/themes/TerminalTheme.ts

@@ -1,12 +1,8 @@
 import type { Outcome } from '@serenity-js/core/lib/model';
 
 /**
- * @desc
- *  Decorates text with control characters to make the terminal
- *  print output in colour.
- *
- * @public
- * @abstract
+ * Decorates text with control characters to make the terminal
+ * print output in colour.
  */
 export abstract class TerminalTheme {
     abstract heading(...parts: any[]): string;
@@ -15,30 +11,15 @@ export abstract class TerminalTheme {
     abstract log(...parts: any[]): string;
 
     /**
-     * @desc
-     *  Converts the `parts` to `string` and joins them together.
-     *
-     * @protected
-     *
-     * @param {any[]} parts
-     *
-     * @returns {string}
+     * Converts the `parts` to `string` and joins them together.
      */
     protected joined(parts: any[]): string {
         return parts.map(String).join('');
     }
 
     /**
-     * @desc
-     *  Repeats a given `pattern` so that it takes up to `maxLength` characters.
-     *  Used to produce separator lines.
-     *
-     * @protected
-     *
-     * @param {string} pattern
-     * @param {number} [maxLength=80] maxLength
-     *
-     * @returns {string}
+     * Repeats a given `pattern` so that it takes up to `maxLength` characters.
+     * Used to produce separator lines.
      */
     protected repeat(pattern: string, maxLength = 80): string {
         if (! pattern) {

package/src/stage/crew/console-reporter/themes/ThemeForColourTerminals.ts

@@ -4,14 +4,8 @@ import type { Chalk } from 'chalk'; // eslint-disable-line unicorn/import-style
 import { TerminalTheme } from './TerminalTheme';
 
 /**
- * @desc
- *  Base class for {@apilink TerminalTheme} implementations intended
- *  to print to terminals that support colour output.
- *
- * @extends {TerminalTheme}
- *
- * @public
- * @abstract
+ * Base class for `TerminalTheme` implementations intended
+ * to print to terminals that support colour output.
  */
 export abstract class ThemeForColourTerminals extends TerminalTheme {
 
@@ -26,10 +20,10 @@ export abstract class ThemeForColourTerminals extends TerminalTheme {
 
     /**
      * Joins the `parts` into a single string and decorates it
-     * using a colour appropriate for a given {@apilink Outcome}.
+     * using a colour appropriate for a given `Outcome`.
      *
      * @param outcome
-     *  an instance of an {@apilink @serenity-js/core/lib/model~Outcome}
+     *  an instance of an `Outcome`
      *  or a string class name of one of its implementations.
      *
      * @param parts

package/src/stage/crew/console-reporter/themes/ThemeForDarkTerminals.ts

@@ -3,12 +3,7 @@ import type { Chalk } from 'chalk'; // eslint-disable-line unicorn/import-style
 import { ThemeForColourTerminals } from './ThemeForColourTerminals';
 
 /**
- * @desc
- *  A simple colour theme for terminals with dark backgrounds.
- *
- * @extends {ThemeForColourTerminals}
- *
- * @public
+ * A simple colour theme for terminals with dark backgrounds.
  */
 export class ThemeForDarkTerminals extends ThemeForColourTerminals {
 
@@ -22,38 +17,27 @@ export class ThemeForDarkTerminals extends ThemeForColourTerminals {
     }
 
     /**
-     * @desc
-     *  Formats the heading
+     * Formats the heading
      *
-     * @param {...any[]} parts
+     * @param parts
      *  `parts` to be converted to string, joined together, and formatted as a heading
-     *
-     * @returns {string}
      */
     heading(...parts: any[]): string {
         return this.chalk.bold.white(this.joined(parts));
     }
 
     /**
-     * @desc
-     *  Decorates the heading with theme colours.
+     * Decorates the heading with theme colours.
      *
-     * @param {string} pattern
+     * @param pattern
      *  The pattern to be repeated to create a separator, for example `-`, `✂ - - `, etc.
-     *
-     * @returns {string}
      */
     separator(pattern: string): string {
         return this.chalk.yellow(this.repeat(pattern));
     }
 
     /**
-     * @desc
-     *  Decorates the log entries that the developer wanted to have captured in the output.
-     *
-     * @param {...any[]} parts
-     *
-     * @returns {string}
+     * Decorates the log entries that the developer wanted to have captured in the output.
      */
     log(...parts: any[]): string {
         return this.chalk.yellow(this.joined(parts));

package/src/stage/crew/console-reporter/themes/ThemeForLightTerminals.ts

@@ -3,18 +3,11 @@ import type { Chalk } from 'chalk'; // eslint-disable-line unicorn/import-style
 import { ThemeForColourTerminals } from './ThemeForColourTerminals';
 
 /**
- * @desc
- *  A simple colour theme for terminals with light backgrounds.
- *
- * @extends {ThemeForColourTerminals}
- *
- * @public
+ * A simple colour theme for terminals with light backgrounds.
  */
 export class ThemeForLightTerminals extends ThemeForColourTerminals {
 
     /**
-     * @param {chalk~Chalk} chalk
-     *
      * @see https://www.npmjs.com/package/chalk
      */
     constructor(chalk: Chalk) {
@@ -22,38 +15,29 @@ export class ThemeForLightTerminals extends ThemeForColourTerminals {
     }
 
     /**
-     * @desc
-     *  Decorates the heading with theme colours.
+     * Decorates the heading with theme colours.
      *
-     * @param {...any[]} parts
+     * @param parts
      *  `parts` to be converted to string, joined together, and formatted as a heading
-     *
-     * @returns {string}
      */
     heading(...parts: any[]): string {
         return this.chalk.bold.black(this.joined(parts));
     }
 
     /**
-     * @desc
-     *  Decorates the heading with theme colours.
+     * Decorates the heading with theme colours.
      *
-     * @param {string} pattern
+     * @param pattern
      *  The pattern to be repeated to create a separator, for example `-`, `✂ - - `, etc.
-     *
-     * @returns {string}
      */
     separator(pattern: string): string {
         return this.repeat(pattern);
     }
 
     /**
-     * @desc
-     *  Decorates the log entries that the developer wanted to have captured in the output.
-     *
-     * @param {...any[]} parts
+     * Decorates the log entries that the developer wanted to have captured in the output.
      *
-     * @returns {string}
+     * @param parts
      */
     log(...parts: any[]): string {
         return this.joined(parts);

package/src/stage/crew/console-reporter/themes/ThemeForMonochromaticTerminals.ts

@@ -3,23 +3,15 @@ import type { Outcome } from '@serenity-js/core/lib/model';
 import { TerminalTheme } from './TerminalTheme';
 
 /**
- * @desc
- *  A simple colour theme for terminals with no colour support.
- *
- * @extends {TerminalTheme}
- *
- * @public
+ * A simple colour theme for terminals with no colour support.
  */
 export class ThemeForMonochromaticTerminals extends TerminalTheme {
 
     /**
-     * @desc
-     *  Formats the heading
+     * Formats the heading
      *
-     * @param {...any[]} parts
+     * @param parts
      *  `parts` to be converted to string, joined together, and formatted as a heading
-     *
-     * @returns {string}
      */
     heading(...parts: any[]): string {
         return this.joined(parts);
@@ -31,38 +23,30 @@ export class ThemeForMonochromaticTerminals extends TerminalTheme {
      * no decoration of the text is performed.
      *
      * @param outcome
-     *  an instance of an {@apilink Outcome}
+     *  an instance of an `Outcome`
      *  or a string class name of one of its implementations.
      *
      * @param parts
      *  the parts of the message
-     *
-     * @returns {string}
      */
     outcome(outcome: Outcome, ...parts: any[]): string {
         return this.joined(parts);
     }
 
     /**
-     * @desc
-     *  Decorates the heading with theme colours.
+     * Decorates the heading with theme colours.
      *
-     * @param {string} pattern
+     * @param pattern
      *  The pattern to be repeated to create a separator, for example `-`, `✂ - - `, etc.
-     *
-     * @returns {string}
      */
     separator(pattern: string): string {
         return this.repeat(pattern);
     }
 
     /**
-     * @desc
-     *  Decorates the log entries that the developer wanted to have captured in the output.
-     *
-     * @param {...any[]} parts
+     * Decorates the log entries that the developer wanted to have captured in the output.
      *
-     * @returns {string}
+     * @param parts
      */
     log(...parts: any[]): string {
         return this.joined(parts);