1 | <?php |
||
7 | trait DocBlockParamHelpers |
||
8 | { |
||
9 | use ParamHelpers; |
||
10 | |||
11 | /** |
||
12 | * Allows users to specify that we shouldn't generate an example for the parameter |
||
13 | * by writing 'No-example'. |
||
14 | * |
||
15 | * @param Tag $tag |
||
16 | * |
||
17 | * @return bool Whether no example should be generated |
||
18 | */ |
||
19 | protected function shouldExcludeExample(Tag $tag) |
||
23 | |||
24 | /** |
||
25 | * Allows users to specify an example for the parameter by writing 'Example: the-example', |
||
26 | * to be used in example requests and response calls. |
||
27 | * |
||
28 | * @param string $description |
||
29 | * @param string $type The type of the parameter. Used to cast the example provided, if any. |
||
30 | * |
||
31 | * @return array The description and included example. |
||
32 | */ |
||
33 | protected function parseParamDescription(string $description, string $type) |
||
45 | } |
||
46 |