External module "parse"

Index

Interfaces

Variables

JSDOC_REGEX

Functions

Variables

Const JSDOC_REGEX

JSDOC_REGEX: RegExp = /\/\*\*([\s\S]*?)\*\//gm

Functions

parseJSDoc

parseJSDoc(code: string): Annotation[]

- Defined in parse.ts:75
Parameters
- code: string
Returns Annotation[]

parseSwaggerV2DocBlocks

parseSwaggerV2DocBlocks(code: string, opts?: ParseSwaggerV2DocBlocksOptions): SwaggerV2DocBlock[]

- Defined in parse.ts:102
Extracts / parses Swagger V2 documentation inside JSDoc blocks.

Parameters
- code: string
  
  The source code with the JSDoc blocks.
- Optional opts: ParseSwaggerV2DocBlocksOptions
Returns SwaggerV2DocBlock[]

The list of documentation.

Generated using TypeDoc