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 36 37 38 39 40 41 42 43 44 45 46 47 48 49
<?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\Decorators;
use Maslosoft\Zamm\Interfaces\Decorators\RendererDecoratorInterface;
use Maslosoft\Zamm\Meta\TagMeta;
/**
* This adds special zamm tags. It's usage is secret.
*
* @author Piotr Maselkowski <pmaselkowski at gmail.com>
*/
class ZammTags extends RendererDecorator implements RendererDecoratorInterface
{
const Open = '<!-- ZAMM:';
const Close = ':ZAMM -->';
/**
* Add ZAMM tags
* @param string $docComment
*/
public function decorate(&$docComment)
{
$docComment = sprintf("%s\n%s\n%s", $this->open(), $docComment, $this->close());
}
private function open()
{
return sprintf("%s%s", self::Open, (new TagMeta($this->getRenderer()))->toJson());
}
private function close()
{
return self::Close;
}
}
API documentation generated by ApiGen