PHP Classes

File: vendor/phpdocumentor/reflection-docblock/examples/01-interpreting-a-simple-docblock.php

Recommend this page to a friend!
  Classes of Renato De Oliveira Lucena  >  PHP Pokemon Script  >  vendor/phpdocumentor/reflection-docblock/examples/01-interpreting-a-simple-docblock.php  >  Download  
File: vendor/phpdocumentor/reflection-docblock/examples/01-interpreting-a-simple-docblock.php
Role: Example script
Content type: text/plain
Description: Example script
Class: PHP Pokemon Script
Provides an API to manage a database of Pokemons
Author: By
Last change:
Date: 2 years ago
Size: 893 bytes


Class file image Download
require_once(__DIR__ . '/../vendor/autoload.php');


$docComment = <<<DOCCOMMENT
 * This is an example of a summary.
 * This is a Description. A Summary and Description are separated by either
 * two subsequent newlines (thus a whiteline in between as can be seen in this
 * example), or when the Summary ends with a dot (`.`) and some form of
 * whitespace.

$factory = DocBlockFactory::createInstance();
$docblock = $factory->create($docComment);

// Should contain the first line of the DocBlock
$summary = $docblock->getSummary();

// Contains an object of type Description; you can either cast it to string or use
// the render method to get a string representation of the Description.
// In subsequent examples we will be fiddling a bit more with the Description.
$description = $docblock->getDescription();

For more information send a message to info at phpclasses dot org.