extractFileOverview

Extract the module-level @file description text, if any.

Import:

import { extractFileOverview } from '@mnaoumov/typescript-dev-toolkit/docs-site/api-doc-jsdoc';

Signature:

function extractFileOverview(src: SourceFile): string

Parameters:

Parameter	Type	Description
src	SourceFile	The source file.

Returns: string — The overview, or an empty string when the file has no @file block.