Facebook\HHAPIDoc\Index

An index of all the Documentables that we should act on

This can be used for auto-linking, generating index documents, or other purposes

namespace Facebook\HHAPIDoc;

type Index = shape(
  'types' => dict<string, Documentable>,
  'newtypes' => dict<string, Documentable>,
  'functions' => dict<string, Documentable>,
  'classes' => dict<string, Documentable>,
  'interfaces' => dict<string, Documentable>,
  'traits' => dict<string, Documentable>,
);

Fields

• 'types': dict<string, Documentable> - A list of all transparent type aliases
• 'newtypes': dict<string, Documentable> - A list of all opaque type aliases
• 'functions': dict<string, Documentable> - A list of all functions
• 'classes': dict<string, Documentable> - A list of all classes
• 'interfaces': dict<string, Documentable> - A list of all interfaces
• 'traits': dict<string, Documentable> - A list of all traits