Facebook\HHAPIDoc\Documentable

An API that can be documented

This includes things like classes, functions, methods, etc.

namespace Facebook\HHAPIDoc;

type Documentable = shape(
  'definition' => \Facebook\DefinitionFinder\ScannedDefinition,
  'parent' => ?\Facebook\DefinitionFinder\ScannedClassish,
  'sources' => vec<string>,
);

Fields

• 'definition': \Facebook\DefinitionFinder\ScannedDefinition - The item being documented
• 'parent': ?\Facebook\DefinitionFinder\ScannedClassish - The enclosing definition for the current item
• 'sources': vec<string> - The files that this definition was inferred from