Facebook\HHAPIDoc\MarkdownExt\RenderContext

Context for rendering markdown using FBMarkdown and hh-apidoc's extensions

Interface Synopsis

namespace Facebook\HHAPIDoc\MarkdownExt;

final class RenderContext extends \Facebook\Markdown\RenderContext {...}

Public Methods

• ->getDocumentable(): \Facebook\HHAPIDoc\Documentable
  Return the item we're currently generating documentation for
• ->getImplicitPrefixes(): keyset<string>
  Places to always look for symbols
• ->getOutputFormat(): \Facebook\HHAPIDoc\OutputFormat
  Get the format of documentation we are generated
• ->getPathProvider(): \Facebook\HHAPIDoc\IPathProvider<?string>
  Return the path provider set with setPathProvider()
• ->resetFileData(): this
  Clear all per-Documentable state
• ->setDocumentable(\Facebook\HHAPIDoc\Documentable $documentable): this
  Set the item currently being documented
• ->setOutputFormat(\Facebook\HHAPIDoc\OutputFormat $f): this
  Set the desired documentation format
• ->setPathProvider(\Facebook\HHAPIDoc\IPathProvider<?string> $provider): this
  Set path provider used for internal references