Facebook\HHAPIDoc\IndexDocumentBuilder

Generate a document that contains links to all documented definitions

Interface Synopsis

namespace Facebook\HHAPIDoc;

final class IndexDocumentBuilder {...}

Public Methods

• ->__construct(DocumentationBuilderContext $context)
• ->getIndexDocument(): string
  Produce the index document in the format specified by the current context

Protected Methods

• ->getContext(): DocumentationBuilderContext
• ->getIndexDocumentMarkdown(): string
• ->renderPart(string $title, dict<string, Documentable> $entries, (function(string): ?string) $get_path): ?string
  Render an index section to Markdown
• ->renderToHTML(string $markdown): string