MarkdownGenerator

Interface for markdown generators that convert JSDoc data to markdown documents.

Signature

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

Properties

• generateRequired · function
  

  Function to convert JSDoc data to markdown document structure

• serializeRequired · function
  

  Function to convert markdown document to string

• generateDocsRequired · function
  

  Function to generate document files from targets