Facebook\HHAPIDoc\DocBlock\DocBlock

Class to represent and parse a docblock (a.k.a. doc comment)

These comments always are delimeted by /** and *\/.

DocBlocks are treated as GitHub Flavored Markdown, and standard JavaDoc style tags are supported, such as @param, @see, and @return.

Interface Synopsis

namespace Facebook\HHAPIDoc\DocBlock;

final class DocBlock {...}

Public Methods

• ::nullable(?string $comment): ?this
  Create a new instance if a comment is provided
• ->__construct(string $rawDocBlock)
  Create and parse a documentation block
• ->getDescription(): ?string
  Get the description of the item being documented
• ->getParameterInfo(): dict<string, ParameterInfo>
  Return information on function parameters from @param tags
• ->getReturnInfo(): vec<ReturnInfo>
  Get the return information for a function
• ->getSummary(): ?string
  Get the summary of the item being documented
• ->getTagsByName(string $name): vec<string>
  Return the content of all tags with the specified name

Protected Methods

• ::typeToTypes(?string $type): vec<string>
  Convert a string type specifiction to a list of types