Generate API documentation alpha

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

Status of Swift Mailer (swiftmailer/swiftmailer)

Command: php -dmemory_limit=1024M /var/www/projects/apigen/apigen/apigen.php -s '/var/www/projects/apigen/repos/swiftmailer/swiftmailer/lib/classes' -d '/var/www/projects/apigen/doc-progress/swiftmailer/swiftmailer' --charset=auto --download --debug --colors=no --
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/swiftmailer/swiftmailer/lib/classes
[===============================================================>] 100.00%  19MB
Found 4 errors

1. The TokenReflection library threw an exception while parsing the file .../repos/swiftmailer/swiftmailer/lib/classes/Swift/AddressEncoderException.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 28) in the following part of Swift_AddressEncoderException::getAddress() source code:

 21:
 22:     {
 23:         parent::__construct($message);
 24:
 25:         $this->address = $address;
 26:     }
 27:
*28:     public function getAddress(): string
 29:     {
 30:         return $this->address;
 31:     }
 32: }
 33:

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(121): 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/*\n * Th...', '/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/swiftmailer/swiftmailer/lib/classes/Swift/AddressEncoder/Utf8AddressEncoder.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 32) in the following part of Swift_AddressEncoder_Utf8AddressEncoder::encodeString() source code:

  1: <?php
  2:
  3: /*
  4:  * This file is part of SwiftMailer.
  5:  * (c) 2018 Christian Schmidt
  6:  *
  7:  * For the full copyright and license information, please view the LICENSE
  8:  * file that was distributed with this source code.
  9:  */
 10:
 11: /**
 12:  * A UTF-8 email address encoder.
 13:  *
 14:  * Returns the email address verbatimly in UTF-8 as permitted by RFC 6531 and
 15:  * RFC 6532. It supports addresses containing non-ASCII characters in both
 16:  * local-part and domain (i.e. on both sides of @).
 17:  *
 18:  * This encoder must be used together with Swift_Transport_Esmtp_SmtpUtf8Handler
 19:  * and requires that the outbound SMTP server supports the SMTPUTF8 extension.
 20:  *
 21:  * If your outbound SMTP server does not support SMTPUTF8, use
 22:  * Swift_AddressEncoder_IdnAddressEncoder instead. This allows sending to email
 23:  * addresses with non-ASCII characters in the domain, but not in local-part.
 24:  *
 25:  * @author Christian Schmidt
 26:  */
 27: class Swift_AddressEncoder_Utf8AddressEncoder implements Swift_AddressEncoder
 28: {
 29:     /**
 30:      * Returns the address verbatimly.
 31:      */
*32:     public function encodeString(string $address): string
 33:     {
 34:         return $address;
 35:     }
 36: }
 37:

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(121): 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/*\n * Th...', '/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}

3. The TokenReflection library threw an exception while parsing the file .../repos/swiftmailer/swiftmailer/lib/classes/Swift/AddressEncoder/IdnAddressEncoder.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 33) in the following part of Swift_AddressEncoder_IdnAddressEncoder::encodeString() source code:

  1: <?php
  2:
  3: /*
  4:  * This file is part of SwiftMailer.
  5:  * (c) 2018 Christian Schmidt
  6:  *
  7:  * For the full copyright and license information, please view the LICENSE
  8:  * file that was distributed with this source code.
  9:  */
 10:
 11: /**
 12:  * An IDN email address encoder.
 13:  *
 14:  * Encodes the domain part of an address using IDN. This is compatible will all
 15:  * SMTP servers.
 16:  *
 17:  * This encoder does not support email addresses with non-ASCII characters in
 18:  * local-part (the substring before @). To send to such addresses, use
 19:  * Swift_AddressEncoder_Utf8AddressEncoder together with
 20:  * Swift_Transport_Esmtp_SmtpUtf8Handler. Your outbound SMTP server must support
 21:  * the SMTPUTF8 extension.
 22:  *
 23:  * @author Christian Schmidt
 24:  */
 25: class Swift_AddressEncoder_IdnAddressEncoder implements Swift_AddressEncoder
 26: {
 27:     /**
 28:      * Encodes the domain part of an address using IDN.
 29:      *
 30:      * @throws Swift_AddressEncoderException If local-part contains non-ASCII characters,
 31:      *                                       or if no suitable IDN encoder is installed.
 32:      */
*33:     public function encodeString(string $address): string
 34:     {
 35:         $i = strrpos($address, '@');
 36:         if (false !== $i) {
 37:             $local = substr($address, 0, $i);
 38:             $domain

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(121): 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/*\n * Th...', '/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/swiftmailer/swiftmailer/lib/classes/Swift/AddressEncoder.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 24) in the following part of Swift_AddressEncoder::encodeString() source code:

  1: <?php
  2:
  3: /*
  4:  * This file is part of SwiftMailer.
  5:  * (c) 2018 Christian Schmidt
  6:  *
  7:  * For the full copyright and license information, please view the LICENSE
  8:  * file that was distributed with this source code.
  9:  */
 10:
 11: /**
 12:  * Email address encoder.
 13:  *
 14:  * @author Christian Schmidt
 15:  */
 16: interface Swift_AddressEncoder
 17: {
 18:     /**
 19:      * Encodes an email address.
 20:      *
 21:      * @throws Swift_AddressEncoderException If the email cannot be represented in
 22:      *                                       the encoding implemented by this class.
 23:      */
*24:     public function encodeString(string $address): string;
 25: }
 26:

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(121): 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/*\n * Th...', '/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 153 classes, 0 constants, 0 functions and other 5 used PHP internal classes
Documentation for 151 classes, 0 constants, 0 functions and other 5 used PHP internal classes will be generated
Generating to directory .../doc-progress/swiftmailer/swiftmailer
[===============================================================>] 100.00%  35MB
Done. Total time: 14 sec, used: 35 MB RAM