MarkdownGenerator

JSDoc 데이터를 Markdown 문서로 변환하는 Markdown 생성기의 인터페이스에요.

시그니처

interface MarkdownGenerator { generate(jsDocData: ParsedJSDoc, sourcePath?: string): MarkdownDocument; serialize(markdownDoc: MarkdownDocument): string; generateDocs(
    targetsWithJSDoc: TargetWithJSDoc,
    packagePath: string,
  ): GeneratedDoc }

매개변수

• generateRequired · function
  

  JSDoc 데이터를 Markdown 문서 구조로 변환하는 함수

• serializeRequired · function
  

  Markdown 문서를 문자열로 변환하는 함수

• generateDocsRequired · function
  

  대상들로부터 문서 파일을 생성하는 함수