Maslosoft Zamm API
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 <?php
/**
* This software package is licensed under `AGPL, Commercial` license[s].
*
* @package maslosoft/zamm
* @license AGPL, Commercial
*
* @copyright Copyright (c) Peter Maselkowski <pmaselkowski@gmail.com>
* @link https://maslosoft.com/zamm/
*/
namespace Maslosoft\Zamm\FileDecorators;
use Maslosoft\Zamm\Interfaces\FileDecoratorInterface;
use Maslosoft\Zamm\Zamm;
/**
* Add a little information about documentation utility used here.
*
* @author Piotr Maselkowski <pmaselkowski at gmail.com>
*/
class MadeByFileDecorator implements FileDecoratorInterface
{
public function decorate(&$docComment)
{
if (false === strstr($docComment, Zamm::MadeBy))
{
$docComment = implode("\n\n", [$docComment, Zamm::MadeBy]);
}
}
}
API documentation generated by ApiGen