Facebook\HHAPIDoc\DocumentationBuilder

Main entrypoint to generate a document for a specific Documentable

Interface Synopsis

namespace Facebook\HHAPIDoc;

final class DocumentationBuilder {...}

Public Methods

• ->__construct(DocumentationBuilderContext $context)
  Create a new instance
• ->getDocumentation(Documentable $documentable): string
  Produce the actual documentation as a string

Protected Methods

• ->getContext(): DocumentationBuilderContext
• ->getDocumentationBody(Documentable $documentable): string
  Get the main body of the documentation in the context-appropriate output format
• ->getPageSections(): keyset<classname<PageSections\PageSection>>
  List of instantiable PageSection subclasses to include in the document
• ->wrapHTMLBody(Documentable $what, string $body): string
  Generate a full HTML document from a body