Function fileDocumentationGenerator

fileDocumentationGenerator(inputParts: readonly FileDocumentationParts[], splitLength?: number): string
Generate file documentation string.

Returns
The documentation multiline string that can be written to a file.
Parameters
- inputParts: readonly FileDocumentationParts[]
  
  List of documentation parts.
- splitLength: number = DEFAULT_MAX_LINE_LENGTH
  
  The length after which text should be split if possible.
Returns string
- Defined in src/documentation/fileDocumentationGenerator.ts:90