fix tsdoc issues

Author: davidjgoss

api-extractor.json

@@ -24,6 +24,9 @@
     "tsdocMessageReporting": {
       "tsdoc-undefined-tag": {
         "logLevel": "none"
+      },
+      "tsdoc-escape-greater-than": {
+        "logLevel": "none"
       }
     }
   }

src/index.ts

@@ -2,26 +2,20 @@ import { makeSourceReference } from './makeSourceReference.js'
 import { builder } from './runner/state.js'
 import { HookFunction, HookOptions, ParameterTypeOptions, StepFunction } from './types.js'
 
-/**
- * An implementation of Cucumber built around the Node.js test runner.
- *
- * @packageDocumentation
- */
-
 export * from './DataTable.js'
 export * from './types.js'
 
 /**
  * Define a custom parameter type for use in steps.
+ * @public
  * @param options - define the behaviour of this parameter type
- * @example
- * ParameterType({
+ * @example ParameterType(\{
  *   name: 'flight',
- *   regexp: /([A-Z]{3})-([A-Z]{3})/,
- *   transformer(from, to) {
+ *   regexp: /([A-Z]\{3\})-([A-Z]\{3\})/,
+ *   transformer(from, to) \{
  *     return new Flight(from, to)
- *   },
- * })
+ *   \},
+ * \})
  */
 export function ParameterType(options: ParameterTypeOptions) {
   builder.registerParameterType(options, makeSourceReference())
@@ -31,21 +25,19 @@ export function ParameterType(options: ParameterTypeOptions) {
  * Define a hook that should be executed before Gherkin-derived steps in each test.
  * @public
  * @param fn - the function to be executed
- * @example
- * Before(async () => {
+ * @example Before(async () => \{
  *   // do stuff here
- * })
+ * \})
  */
 export function Before(fn: HookFunction): void
 /**
  * Define a hook that should be executed before Gherkin-derived steps in each test.
  * @public
  * @param options - declare more information about this hook
  * @param fn - the function to be executed
- * @example
- * Before({ name: 'Provision resources', tagFilter: '@uses-resources' }, async () => {
+ * @example Before(\{ name: 'Provision resources', tagFilter: '\@uses-resources' \}, async () => \{
  *   // do stuff here
- * })
+ * \})
  */
 export function Before(options: HookOptions, fn: HookFunction): void
 export function Before(arg1: HookFunction | HookOptions, arg2?: HookFunction) {
@@ -58,21 +50,19 @@ export function Before(arg1: HookFunction | HookOptions, arg2?: HookFunction) {
  * Define a hook that should be executed after Gherkin-derived steps in each test.
  * @public
  * @param fn - the function to be executed
- * @example
- * After(async () => {
+ * @example After(async () => \{
  *   // do stuff here
- * })
+ * \})
  */
 export function After(fn: HookFunction): void
 /**
  * Define a hook that should be executed after Gherkin-derived steps in each test.
  * @public
  * @param options - declare more information about this hook
  * @param fn - the function to be executed
- * @example
- * After({ name: 'Teardown resources', tagFilter: '@uses-resources' }, async () => {
+ * @example After(\{ name: 'Teardown resources', tagFilter: '\@uses-resources' \}, async () => \{
  *   // do stuff here
- * })
+ * \})
  */
 export function After(options: HookOptions, fn: HookFunction): void
 export function After(arg1: HookFunction | HookOptions, arg2?: HookFunction) {
@@ -83,38 +73,38 @@ export function After(arg1: HookFunction | HookOptions, arg2?: HookFunction) {
 
 /**
  * Define a step to be used with the "Given" keyword
+ * @public
  * @param text - a Cucumber Expression used to match the step with steps from Gherkin
  * @param fn - the function to be executed
- * @example
- * Given('I have {int} cukes in my belly', async (t, count) => {
+ * @example Given('I have \{int\} cukes in my belly', async (t, count) => \{
  *   // do stuff here
- * })
+ * \})
  */
 export function Given(text: string, fn: StepFunction) {
   builder.registerStep(text, fn, makeSourceReference())
 }
 
 /**
  * Define a step to be used with the "When" keyword
+ * @public
  * @param text - a Cucumber Expression used to match the step with steps from Gherkin
  * @param fn - the function to be executed
- * @example
- * When('I have {int} cukes in my belly', async (t, count) => {
+ * @example When('I have \{int\} cukes in my belly', async (t, count) => \{
  *   // do stuff here
- * })
+ * \})
  */
 export function When(text: string, fn: StepFunction) {
   builder.registerStep(text, fn, makeSourceReference())
 }
 
 /**
  * Define a step to be used with the "Then" keyword
+ * @public
  * @param text - a Cucumber Expression used to match the step with steps from Gherkin
  * @param fn - the function to be executed
- * @example
- * Then('I have {int} cukes in my belly', async (t, count) => {
+ * @example Then('I have \{int\} cukes in my belly', async (t, count) => \{
  *   // do stuff here
- * })
+ * \})
  */
 export function Then(text: string, fn: StepFunction) {
   builder.registerStep(text, fn, makeSourceReference())

src/types.ts

@@ -51,15 +51,15 @@ export type TestCaseContext = {
    * Capture a "log" attachment.
    * @param text - the text to be logged
    * @remarks
-   * A shorthand for {@link log} with a special media type.
+   * A shorthand for {@link TestCaseContext.attach} with a special media type.
    */
   log(text: string): Promise<void>
   /**
    * Capture a URL attachment.
    * @param url - the URL to be captured
    * @param title - the text title that should accompany the URL
    * @remarks
-   * A shorthand for {@link log} with a special media type.
+   * A shorthand for {@link TestCaseContext.attach} with a special media type.
    */
   link(url: string, title?: string): Promise<void>
   /**
@@ -86,7 +86,7 @@ export type ParameterTypeOptions = {
   /**
    * A function for transforming the matched values to another object before passing to
    * the step function.
-   * @param match
+   * @param match - matched values from the regular expression
    * @remarks
    * If not provided, the raw matched value(s) will be passed to the step function.
    */