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 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 <?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\Extractors;
use Maslosoft\Zamm\Interfaces\Extractors\ExtractorInterface;
/**
* This extractor simulates extracting. It just return some predefined doc comments.
*
* @author Piotr Maselkowski <pmaselkowski at gmail.com>
*/
class MockExtractor extends BaseExtractor implements ExtractorInterface
{
public function getClass()
{
return <<<COMMENT
/**
* This is mock class comment.
* Normally it should contain general description.
* But this one contains only dummy tex and:
* <ul>
* <li>some php doc</li>
* <li>some html</li>
* <li>some annotation</li>
* </ul>
* @author Piotr Maselkowski <pmaselkowski at gmail.com>
* @since 1.0.2
* @Target('class')
*/
COMMENT;
}
public function getMethod($name)
{
return <<<COMMENT
/**
* This is mock method $name comment.
* Normally it should contain method description.
* But this one contains only dummy tex and:
* <ul>
* <li>some method php doc</li>
* <li>some html</li>
* <li>some method annotations</li>
* </ul>
* @author Piotr Maselkowski <pmaselkowski at gmail.com>
* @since 1.0.2
* @Target('method')
* @param int \$id Identifier of user in mock method
* @param string \$name Name of user in mock method
*/
COMMENT;
}
public function getProperty($name)
{
return <<<COMMENT
/**
* This is mock property $name comment.
* Normally it should contain property description.
* But this one contains only dummy tex and:
* <ul>
* <li>some property php doc</li>
* <li>some html</li>
* <li>some property annotations</li>
* </ul>
* @author Piotr Maselkowski <pmaselkowski at gmail.com>
* @since 1.0.2
* @Target('field')
* @var int Identifier of user in mock property
*/
COMMENT;
}
}
API documentation generated by ApiGen