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 DBAL (doctrine/dbal)

Command: php -dmemory_limit=1024M /var/www/projects/apigen/apigen/apigen.php -s '/var/www/projects/apigen/repos/doctrine/dbal/lib/Doctrine/DBAL' -d '/var/www/projects/apigen/doc-progress/doctrine/dbal' --charset=auto --download --debug --colors=no --progressbar=ye
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/dbal/lib/Doctrine/DBAL
[===============================================================>] 100.00%  23MB
Found 2 errors

1. The TokenReflection library threw an exception while parsing the file .../repos/doctrine/dbal/lib/Doctrine/DBAL/DBALException.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 39) in the following part of Doctrine\DBAL\DBALException::invalidPlatformSpecified() source code:

 33:
 34:     public static function notSupported($method)
 35:     {
 36:         return new self("Operation '$method' is not supported by platform.");
 37:     }
 38:
*39:     public static function invalidPlatformSpecified() : self
 40:     {
 41:         return new self(
 42:             "Invalid 'platform' option specified, need to give an instance of ".
 43:             "\Doctrine\DBAL\Platforms\AbstractPlatform.");
 44:     }

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\n/*\n * THI...', '/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}

2. The TokenReflection library threw an exception while parsing the file .../repos/doctrine/dbal/lib/Doctrine/DBAL/DriverManager.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 134) in the following part of Doctrine\DBAL\DriverManager::getConnection() source code:

  73:
  74:     }
  75:
  76:     /**
  77:      * Creates a connection object based on the specified parameters.
  78:      * This method returns a Doctrine\DBAL\Connection which wraps the underlying
  79:      * driver connection.
  80:      *
  81:      * $params must contain at least one of the following.
  82:      *
  83:      * Either 'driver' with one of the following values:
  84:      *
  85:      *     pdo_mysql
  86:      *     pdo_sqlite
  87:      *     pdo_pgsql
  88:      *     pdo_oci (unstable)
  89:      *     pdo_sqlsrv
  90:      *     pdo_sqlsrv
  91:      *     mysqli
  92:      *     sqlanywhere
  93:      *     sqlsrv
  94:      *     ibm_db2 (unstable)
  95:      *     drizzle_pdo_mysql
  96:      *
  97:      * OR 'driverClass' that contains the full class name (with namespace) of the
  98:      * driver class to instantiate.
  99:      *
 100:      * Other (optional) parameters:
 101:      *
 102:      * <b>user (string)</b>:
 103:      * The username to use when connecting.
 104:      *
 105:      * <b>password (string)</b>:
 106:      * The password to use when connecting.
 107:      *
 108:      * <b>driverOptions (array)</b>:
 109:      * Any additional driver-specific options for the driver. These are just passed
 110:      * through to the driver.
 111:      *
 112:      * <b>pdo</b>:
 113:      * You can pass an existing PDO instance through this parameter. The PDO
 114:      * instance will be wrapped in a Doctrine\DBAL\Connection.
 115:      *
 116:      * <b>wrapperClass</b>:
 117:      * You may specify a custom wrapper class through the 'wrapperClass'
 118:      * parameter but this class MUST inherit from Doctrine\DBAL\Connection.
 119:      *
 120:      * <b>driverClass</b>:
 121:      * The driver class to use.
 122:      *
 123:      * @param array                              $params       The parameters.
 124:      * @param \Doctrine\DBAL\Configuration|null  $config       The configuration to use.
 125:      * @param \Doctrine\Common\EventManager|null $eventManager The event manager to use.
 126:      *
 127:      * @return \Doctrine\DBAL\Connection
 128:      *
 129:      * @throws \Doctrine\DBAL\DBALException
 130:      */
 131:     public static function getConnection(
 132:             array $params,
 133:             Configuration $config = null,
*134:             EventManager $eventManager = null): Connection
 135:     {
 136:         // create default config and event manager, if not set
 137:         if ( ! $config) {
 138:             $config = new Configuration();
 139:         }
 140:         if

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\n/*\n * THI...', '/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}

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