Search Results for "phpdoc"

ReflectionDocBlock is a PHP component for parsing PHPDoc-style DocBlocks. It lets libraries and tools read structured documentation comments and extract information such as descriptions, tags, types, parameters, return values, and annotations. The component is associated with phpDocumentor and is designed to be compatible with the PHPDoc standard. It is useful for documentation generators, static analysis tools, IDE helpers, annotation systems, and frameworks that depend on metadata stored in comments. ...

The ReflectionDocBlock component of phpDocumentor provides a DocBlock parser that is 100% compatible with the PHPDoc standard. With this component, a library can provide support for annotations via DocBlocks or otherwise retrieve information that is embedded in a DocBlock. In order to parse the DocBlock one needs a DocBlockFactory that can be instantiated using its createInstance factory method. Then we can use the create method of the factory to interpret the DocBlock.