MarkdownGenerator

JSDoc 데이터를 마크다운 문서로 변환하는 제너레이터 인터페이스예요.

시그니처

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

속성

• generateRequired · function
  

  JSDoc 데이터를 마크다운 문서 구조로 변환하는 함수

• serializeRequired · function
  

  마크다운 문서를 문자열로 변환하는 함수

• generateDocsRequired · function
  

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