8000 [Console] : added phpdocs to InputOption constants · symfony/symfony@9f124f6 · GitHub
[go: up one dir, main page]

Skip to content

Commit 9f124f6

Browse files
clxmstaabfabpot
authored andcommitted
[Console] : added phpdocs to InputOption constants
1 parent 32cce9f commit 9f124f6

File tree

1 file changed

+15
-0
lines changed

1 file changed

+15
-0
lines changed

src/Symfony/Component/Console/Input/InputOption.php

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,9 +21,24 @@
2121
*/
2222
class InputOption
2323
{
24+
/**
25+
* Do not accept input for the option (e.g. --yell). This is the default behavior of options.
26+
*/
2427
public const VALUE_NONE = 1;
28+
29+
/**
30+
* A value must be passed when the option is used (e.g. --iterations=5 or -i5).
31+
*/
2532
public const VALUE_REQUIRED = 2;
33+
34+
/**
35+
* The option may or may not have a value (e.g. --yell or --yell=loud).
36+
*/
2637
public const VALUE_OPTIONAL = 4;
38+
39+
/**
40+
* The option accepts multiple values (e.g. --dir=/foo --dir=/bar).
41+
*/
2742
public const VALUE_IS_ARRAY = 8;
2843

2944
private $name;

0 commit comments

Comments
 (0)
0