Generate API documentation alpha

Cloud based service which generates API documentation for your GitHub based project using the great documentation generator ApiGen.

Status of Doctrine 2 Common (doctrine/common)

Command: php -dmemory_limit=1024M /var/www/projects/apigen/apigen/apigen.php -s '/var/www/projects/apigen/repos/doctrine/common/lib/Doctrine/Common' -d '/var/www/projects/apigen/doc-progress/doctrine/common' --charset=auto --download --debug --colors=no --progress
PHP Warning:  PHP Startup: Unable to load dynamic library '/usr/lib/php5/20131226/newrelic.so' - /usr/lib/php5/20131226/newrelic.so: cannot open shared object file: No such file or directory in Unknown on line 0
PHP Warning:  PHP Startup: Unable to load dynamic library '/usr/lib/php5/20131226/newrelic.so' - /usr/lib/php5/20131226/newrelic.so: cannot open shared object file: No such file or directory in Unknown on line 0
PHP Deprecated:  iconv_set_encoding(): Use of iconv.internal_encoding is deprecated in .../apigen/vendor/Nette/Nette/loader.php on line 30
ApiGen 3.0dev
-------------
Scanning .../repos/doctrine/common/lib/Doctrine/Common
[===============================================================>] 100.00%  11MB
Found 5 errors

1. The TokenReflection library threw an exception while parsing the file .../repos/doctrine/common/lib/Doctrine/Common/Util/Inflector.php.

This can have two reasons: a) the source code in the file is not valid or b) you have just found a bug in the TokenReflection library.

If the license allows it please send the whole file or at least the following fragment describing where exacly is the problem along with the backtrace to apigen@apigen.org. Thank you!

The cause of the exception "Imported namespace name could not be determined." was the T_FUNCTION token (line 5) in the following part of Doctrine\Common\Util source code:

  1: <?php
  2: namespace Doctrine\Common\Util;
  3:
  4: use Doctrine\Common\Inflector\Inflector as BaseInflector;
* 5: use function trigger_error;
  6: use const E_USER_DEPRECATED;
  7:
  8: @trigger_error(Inflector::class . ' is deprecated.', E_USER_DEPRECATED);
  9:
 10: /**
 11:  * Doctrine inflector has static methods for inflecting text.
 12:  *
 13:  * Kept for backwards compatibility reasons, was moved to its own component.
 14:  *
 15:  * @deprecated The Inflector class is deprecated, use Doctrine\Common\Inflector\Inflector from doctrine/inflector package instead,
 16:  */
 17: class Inflector extends BaseInflector
 18: {
 19: }

The exception backtrace is following:

#0 .../apigen/vendor/TokenReflection/TokenReflection/ReflectionElement.php(122): TokenReflection\ReflectionFileNamespace->parseChildren(Object(TokenReflection\Stream\StringStream), Object(TokenReflection\ReflectionFile))
#1 .../apigen/vendor/TokenReflection/TokenReflection/ReflectionBase.php(73): TokenReflection\ReflectionElement->parseStream(Object(TokenReflection\Stream\StringStream), Object(TokenReflection\ReflectionFile))
#2 .../apigen/vendor/TokenReflection/TokenReflection/ReflectionElement.php(104): TokenReflection\ReflectionBase->__construct(Object(TokenReflection\Stream\StringStream), Object(TokenReflection\Broker), Object(TokenReflection\ReflectionFile))
#3 .../apigen/vendor/TokenReflection/TokenReflection/ReflectionFile.php(130): TokenReflection\ReflectionElement->__construct(Object(TokenReflection\Stream\StringStream), Object(TokenReflection\Broker), Object(TokenReflection\ReflectionFile))
#4 .../apigen/vendor/TokenReflection/TokenReflection/ReflectionBase.php(73): TokenReflection\ReflectionFile->parseStream(Object(TokenReflection\Stream\StringStream), NULL)
#5 .../apigen/vendor/TokenReflection/TokenReflection/Broker.php(168): TokenReflection\ReflectionBase->__construct(Object(TokenReflection\Stream\StringStream), Object(TokenReflection\Broker))
#6 .../apigen/ApiGen/Generator.php(216): TokenReflection\Broker->processString('<?php\nnamespace...', '/var/www/projec...')
#7 .../apigen/ApiGen/Application.php(125): ApiGen\Generator->parse()
#8 .../apigen/ApiGen/Application.php(84): ApiGen\Application->parse()
#9 .../apigen/apigen.php(50): ApiGen\Application->run()
#10 {main}

2. The TokenReflection library threw an exception while parsing the file .../repos/doctrine/common/lib/Doctrine/Common/Lexer.php.

This can have two reasons: a) the source code in the file is not valid or b) you have just found a bug in the TokenReflection library.

If the license allows it please send the whole file or at least the following fragment describing where exacly is the problem along with the backtrace to apigen@apigen.org. Thank you!

The cause of the exception "Imported namespace name could not be determined." was the T_FUNCTION token (line 5) in the following part of Doctrine\Common source code:

  1: <?php
  2: namespace Doctrine\Common;
  3:
  4: use Doctrine\Common\Lexer\AbstractLexer;
* 5: use function trigger_error;
  6: use const E_USER_DEPRECATED;
  7:
  8: @trigger_error(Lexer::class . ' is deprecated.', E_USER_DEPRECATED);
  9:
 10: /**
 11:  * Base class for writing simple lexers, i.e. for creating small DSLs.
 12:  *
 13:  * Lexer moved into its own Component Doctrine\Common\Lexer. This class
 14:  * only stays for being BC.
 15:  *
 16:  * @since  2.0
 17:  * @author Guilherme Blanco <guilhermeblanco@hotmail.com>
 18:  * @author Jonathan Wage <jonwage@gmail.com>
 19:  * @author Roman Borschel <roman@code-factory.org>
 20:  *
 21:  * @deprecated Use Doctrine\Common\Lexer\AbstractLexer from doctrine/lexer package instead.
 22:  */
 23: abstract class Lexer extends AbstractLexer
 24: {
 25: }

The exception backtrace is following:

#0 .../apigen/vendor/TokenReflection/TokenReflection/ReflectionElement.php(122): TokenReflection\ReflectionFileNamespace->parseChildren(Object(TokenReflection\Stream\StringStream), Object(TokenReflection\ReflectionFile))
#1 .../apigen/vendor/TokenReflection/TokenReflection/ReflectionBase.php(73): TokenReflection\ReflectionElement->parseStream(Object(TokenReflection\Stream\StringStream), Object(TokenReflection\ReflectionFile))
#2 .../apigen/vendor/TokenReflection/TokenReflection/ReflectionElement.php(104): TokenReflection\ReflectionBase->__construct(Object(TokenReflection\Stream\StringStream), Object(TokenReflection\Broker), Object(TokenReflection\ReflectionFile))
#3 .../apigen/vendor/TokenReflection/TokenReflection/ReflectionFile.php(130): TokenReflection\ReflectionElement->__construct(Object(TokenReflection\Stream\StringStream), Object(TokenReflection\Broker), Object(TokenReflection\ReflectionFile))
#4 .../apigen/vendor/TokenReflection/TokenReflection/ReflectionBase.php(73): TokenReflection\ReflectionFile->parseStream(Object(TokenReflection\Stream\StringStream), NULL)
#5 .../apigen/vendor/TokenReflection/TokenReflection/Broker.php(168): TokenReflection\ReflectionBase->__construct(Object(TokenReflection\Stream\StringStream), Object(TokenReflection\Broker))
#6 .../apigen/ApiGen/Generator.php(216): TokenReflection\Broker->processString('<?php\nnamespace...', '/var/www/projec...')
#7 .../apigen/ApiGen/Application.php(125): ApiGen\Generator->parse()
#8 .../apigen/ApiGen/Application.php(84): ApiGen\Application->parse()
#9 .../apigen/apigen.php(50): ApiGen\Application->run()
#10 {main}

3. The TokenReflection library threw an exception while parsing the file .../repos/doctrine/common/lib/Doctrine/Common/Proxy/Exception/InvalidArgumentException.php.

This can have two reasons: a) the source code in the file is not valid or b) you have just found a bug in the TokenReflection library.

If the license allows it please send the whole file or at least the following fragment describing where exacly is the problem along with the backtrace to apigen@apigen.org. Thank you!

The cause of the exception "Unexpected token found." was the : token (line 102) in the following part of Doctrine\Common\Proxy\Exception\InvalidArgumentException::invalidAutoGenerateMode() source code:

  91:
  92:     public static function classMustNotBeFinal($className)
  93:     {
  94:         return new self(sprintf('Unable to create a proxy for a final class "%s".', $className));
  95:     }
  96:
  97:     /**
  98:      * @param mixed $value
  99:      *
 100:      * @return self
 101:      */
*102:     public static function invalidAutoGenerateMode($value) : self
 103:     {
 104:         return new self(sprintf('Invalid auto generate mode "%s" given.', $value));
 105:     }
 106: }
 107:

The exception backtrace is following:

#0 .../apigen/vendor/TokenReflection/TokenReflection/ReflectionFunctionBase.php(302): TokenReflection\ReflectionFunctionBase->parseStaticVariables(Object(TokenReflection\Stream\StringStream))
#1 .../apigen/vendor/TokenReflection/TokenReflection/ReflectionElement.php(122): TokenReflection\ReflectionFunctionBase->parseChildren(Object(TokenReflection\Stream\StringStream), Object(TokenReflection\ReflectionClass))
#2 .../apigen/vendor/TokenReflection/TokenReflection/ReflectionBase.php(73): TokenReflection\ReflectionElement->parseStream(Object(TokenReflection\Stream\StringStream), Object(TokenReflection\ReflectionClass))
#3 .../apigen/vendor/TokenReflection/TokenReflection/ReflectionElement.php(104): TokenReflection\ReflectionBase->__construct(Object(TokenReflection\Stream\StringStream), Object(TokenReflection\Broker), Object(TokenReflection\ReflectionClass))
#4 .../apigen/vendor/TokenReflection/TokenReflection/ReflectionClass.php(1839): TokenReflection\ReflectionElement->__construct(Object(TokenReflection\Stream\StringStream), Object(TokenReflection\Broker), Object(TokenReflection\ReflectionClass))
#5 .../apigen/vendor/TokenReflection/TokenReflection/ReflectionElement.php(122): TokenReflection\ReflectionClass->parseChildren(Object(TokenReflection\Stream\StringStream), Object(TokenReflection\ReflectionFileNamespace))
#6 .../apigen/vendor/TokenReflection/TokenReflection/ReflectionBase.php(73): TokenReflection\ReflectionElement->parseStream(Object(TokenReflection\Stream\StringStream), Object(TokenReflection\ReflectionFileNamespace))
#7 .../apigen/vendor/TokenReflection/TokenReflection/ReflectionElement.php(104): TokenReflection\ReflectionBase->__construct(Object(TokenReflection\Stream\StringStream), Object(TokenReflection\Broker), Object(TokenReflection\ReflectionFileNamespace))
#8 .../apigen/vendor/TokenReflection/TokenReflection/ReflectionFileNamespace.php(299): TokenReflection\ReflectionElement->__construct(Object(TokenReflection\Stream\StringStream), Object(TokenReflection\Broker), Object(TokenReflection\ReflectionFileNamespace))
#9 .../apigen/vendor/TokenReflection/TokenReflection/ReflectionElement.php(122): TokenReflection\ReflectionFileNamespace->parseChildren(Object(TokenReflection\Stream\StringStream), Object(TokenReflection\ReflectionFile))
#10 .../apigen/vendor/TokenReflection/TokenReflection/ReflectionBase.php(73): TokenReflection\ReflectionElement->parseStream(Object(TokenReflection\Stream\StringStream), Object(TokenReflection\ReflectionFile))
#11 .../apigen/vendor/TokenReflection/TokenReflection/ReflectionElement.php(104): TokenReflection\ReflectionBase->__construct(Object(TokenReflection\Stream\StringStream), Object(TokenReflection\Broker), Object(TokenReflection\ReflectionFile))
#12 .../apigen/vendor/TokenReflection/TokenReflection/ReflectionFile.php(130): TokenReflection\ReflectionElement->__construct(Object(TokenReflection\Stream\StringStream), Object(TokenReflection\Broker), Object(TokenReflection\ReflectionFile))
#13 .../apigen/vendor/TokenReflection/TokenReflection/ReflectionBase.php(73): TokenReflection\ReflectionFile->parseStream(Object(TokenReflection\Stream\StringStream), NULL)
#14 .../apigen/vendor/TokenReflection/TokenReflection/Broker.php(168): TokenReflection\ReflectionBase->__construct(Object(TokenReflection\Stream\StringStream), Object(TokenReflection\Broker))
#15 .../apigen/ApiGen/Generator.php(216): TokenReflection\Broker->processString('<?php\nnamespace...', '/var/www/projec...')
#16 .../apigen/ApiGen/Application.php(125): ApiGen\Generator->parse()
#17 .../apigen/ApiGen/Application.php(84): ApiGen\Application->parse()
#18 .../apigen/apigen.php(50): ApiGen\Application->run()
#19 {main}

4. The TokenReflection library threw an exception while parsing the file .../repos/doctrine/common/lib/Doctrine/Common/Proxy/AbstractProxyFactory.php.

This can have two reasons: a) the source code in the file is not valid or b) you have just found a bug in the TokenReflection library.

If the license allows it please send the whole file or at least the following fragment describing where exacly is the problem along with the backtrace to apigen@apigen.org. Thank you!

The cause of the exception "The property name could not be determined." was the T_CONST token (line 56) in the following part of the source code:

 24:
 25:     const AUTOGENERATE_NEVER = 0;
 26:
 27:     /**
 28:      * Always generates a new proxy in every request.
 29:      *
 30:      * This is only sane during development.
 31:      *
 32:      * @var integer
 33:      */
 34:     const AUTOGENERATE_ALWAYS = 1;
 35:
 36:     /**
 37:      * Autogenerate the proxy class when the proxy file does not exist.
 38:      *
 39:      * This strategy causes a file exists call whenever any proxy is used the
 40:      * first time in a request.
 41:      *
 42:      * @var integer
 43:      */
 44:     const AUTOGENERATE_FILE_NOT_EXISTS = 2;
 45:
 46:     /**
 47:      * Generate the proxy classes using eval().
 48:      *
 49:      * This strategy is only sane for development, and even then it gives me
 50:      * the creeps a little.
 51:      *
 52:      * @var integer
 53:      */
 54:     const AUTOGENERATE_EVAL = 3;
 55:
*56:     private const AUTOGENERATE_MODES = [
 57:         self::AUTOGENERATE_NEVER,
 58:         self::AUTOGENERATE_ALWAYS,
 59:         self::AUTOGENERATE_FILE_NOT_EXISTS,
 60:         self::AUTOGENERATE_EVAL,
 61:     ]

The exception backtrace is following:

#0 .../apigen/vendor/TokenReflection/TokenReflection/ReflectionProperty.php(436): TokenReflection\ReflectionProperty->parseName(Object(TokenReflection\Stream\StringStream))
#1 .../apigen/vendor/TokenReflection/TokenReflection/ReflectionElement.php(121): TokenReflection\ReflectionProperty->parse(Object(TokenReflection\Stream\StringStream), Object(TokenReflection\ReflectionClass))
#2 .../apigen/vendor/TokenReflection/TokenReflection/ReflectionBase.php(73): TokenReflection\ReflectionElement->parseStream(Object(TokenReflection\Stream\StringStream), Object(TokenReflection\ReflectionClass))
#3 .../apigen/vendor/TokenReflection/TokenReflection/ReflectionElement.php(104): TokenReflection\ReflectionBase->__construct(Object(TokenReflection\Stream\StringStream), Object(TokenReflection\Broker), Object(TokenReflection\ReflectionClass))
#4 .../apigen/vendor/TokenReflection/TokenReflection/ReflectionClass.php(1830): TokenReflection\ReflectionElement->__construct(Object(TokenReflection\Stream\StringStream), Object(TokenReflection\Broker), Object(TokenReflection\ReflectionClass))
#5 .../apigen/vendor/TokenReflection/TokenReflection/ReflectionElement.php(122): TokenReflection\ReflectionClass->parseChildren(Object(TokenReflection\Stream\StringStream), Object(TokenReflection\ReflectionFileNamespace))
#6 .../apigen/vendor/TokenReflection/TokenReflection/ReflectionBase.php(73): TokenReflection\ReflectionElement->parseStream(Object(TokenReflection\Stream\StringStream), Object(TokenReflection\ReflectionFileNamespace))
#7 .../apigen/vendor/TokenReflection/TokenReflection/ReflectionElement.php(104): TokenReflection\ReflectionBase->__construct(Object(TokenReflection\Stream\StringStream), Object(TokenReflection\Broker), Object(TokenReflection\ReflectionFileNamespace))
#8 .../apigen/vendor/TokenReflection/TokenReflection/ReflectionFileNamespace.php(299): TokenReflection\ReflectionElement->__construct(Object(TokenReflection\Stream\StringStream), Object(TokenReflection\Broker), Object(TokenReflection\ReflectionFileNamespace))
#9 .../apigen/vendor/TokenReflection/TokenReflection/ReflectionElement.php(122): TokenReflection\ReflectionFileNamespace->parseChildren(Object(TokenReflection\Stream\StringStream), Object(TokenReflection\ReflectionFile))
#10 .../apigen/vendor/TokenReflection/TokenReflection/ReflectionBase.php(73): TokenReflection\ReflectionElement->parseStream(Object(TokenReflection\Stream\StringStream), Object(TokenReflection\ReflectionFile))
#11 .../apigen/vendor/TokenReflection/TokenReflection/ReflectionElement.php(104): TokenReflection\ReflectionBase->__construct(Object(TokenReflection\Stream\StringStream), Object(TokenReflection\Broker), Object(TokenReflection\ReflectionFile))
#12 .../apigen/vendor/TokenReflection/TokenReflection/ReflectionFile.php(130): TokenReflection\ReflectionElement->__construct(Object(TokenReflection\Stream\StringStream), Object(TokenReflection\Broker), Object(TokenReflection\ReflectionFile))
#13 .../apigen/vendor/TokenReflection/TokenReflection/ReflectionBase.php(73): TokenReflection\ReflectionFile->parseStream(Object(TokenReflection\Stream\StringStream), NULL)
#14 .../apigen/vendor/TokenReflection/TokenReflection/Broker.php(168): TokenReflection\ReflectionBase->__construct(Object(TokenReflection\Stream\StringStream), Object(TokenReflection\Broker))
#15 .../apigen/ApiGen/Generator.php(216): TokenReflection\Broker->processString('<?php\nnamespace...', '/var/www/projec...')
#16 .../apigen/ApiGen/Application.php(125): ApiGen\Generator->parse()
#17 .../apigen/ApiGen/Application.php(84): ApiGen\Application->parse()
#18 .../apigen/apigen.php(50): ApiGen\Application->run()
#19 {main}

5. The TokenReflection library threw an exception while parsing the file .../repos/doctrine/common/lib/Doctrine/Common/ClassLoader.php.

This can have two reasons: a) the source code in the file is not valid or b) you have just found a bug in the TokenReflection library.

If the license allows it please send the whole file or at least the following fragment describing where exacly is the problem along with the backtrace to apigen@apigen.org. Thank you!

The cause of the exception "Imported namespace name could not be determined." was the T_FUNCTION token (line 4) in the following part of Doctrine\Common source code:

  1: <?php
  2: namespace Doctrine\Common;
  3:
* 4: use function trigger_error;
  5: use const E_USER_DEPRECATED;
  6:
  7: @trigger_error(ClassLoader::class . ' is deprecated.', E_USER_DEPRECATED);
  8:
  9: /**
 10:  * A <tt>ClassLoader</tt> is an autoloader for class files that can be
 11:  * installed on the SPL autoload stack. It is a class loader that either loads only classes
 12:  * of a specific namespace or all namespaces and it is suitable for working together
 13:  * with other autoloaders in the SPL autoload stack.
 14:  *
 15:  * If no include path is configured through the constructor or {@link setIncludePath}, a ClassLoader
 16:  * relies on the PHP <code>include_path</code>.
 17:  *
 18:  * @author Roman Borschel <roman@code-factory.org>
 19:  * @since 2.0
 20:  *
 21:  * @deprecated The ClassLoader is deprecated and will be removed in version 3.0 of doctrine/common.
 22:  */
 23: class ClassLoader
 24: {
 25:     /**
 26:      * PHP file extension.
 27:      *
 28:      * @var string
 29:      */

The exception backtrace is following:

#0 .../apigen/vendor/TokenReflection/TokenReflection/ReflectionElement.php(122): TokenReflection\ReflectionFileNamespace->parseChildren(Object(TokenReflection\Stream\StringStream), Object(TokenReflection\ReflectionFile))
#1 .../apigen/vendor/TokenReflection/TokenReflection/ReflectionBase.php(73): TokenReflection\ReflectionElement->parseStream(Object(TokenReflection\Stream\StringStream), Object(TokenReflection\ReflectionFile))
#2 .../apigen/vendor/TokenReflection/TokenReflection/ReflectionElement.php(104): TokenReflection\ReflectionBase->__construct(Object(TokenReflection\Stream\StringStream), Object(TokenReflection\Broker), Object(TokenReflection\ReflectionFile))
#3 .../apigen/vendor/TokenReflection/TokenReflection/ReflectionFile.php(130): TokenReflection\ReflectionElement->__construct(Object(TokenReflection\Stream\StringStream), Object(TokenReflection\Broker), Object(TokenReflection\ReflectionFile))
#4 .../apigen/vendor/TokenReflection/TokenReflection/ReflectionBase.php(73): TokenReflection\ReflectionFile->parseStream(Object(TokenReflection\Stream\StringStream), NULL)
#5 .../apigen/vendor/TokenReflection/TokenReflection/Broker.php(168): TokenReflection\ReflectionBase->__construct(Object(TokenReflection\Stream\StringStream), Object(TokenReflection\Broker))
#6 .../apigen/ApiGen/Generator.php(216): TokenReflection\Broker->processString('<?php\nnamespace...', '/var/www/projec...')
#7 .../apigen/ApiGen/Application.php(125): ApiGen\Generator->parse()
#8 .../apigen/ApiGen/Application.php(84): ApiGen\Application->parse()
#9 .../apigen/apigen.php(50): ApiGen\Application->run()
#10 {main}

Found 14 classes, 0 constants, 0 functions and other 0 used PHP internal classes
Documentation for 3 classes, 0 constants, 0 functions and other 0 used PHP internal classes will be generated
Generating to directory .../doc-progress/doctrine/common
[===============================================================>] 100.00%  14MB
Done. Total time: 1 sec, used: 19 MB RAM