Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Signed-off-by: Clement Escoffier <clement.escoffier@gmail.com>
- Loading branch information
1 parent
9e8b5f6
commit 1cfdc2b
Showing
26 changed files
with
604 additions
and
573 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,43 @@ | ||
== Argument | ||
|
||
++++ | ||
Defines a command line argument. Unlike options, argument don't have names and are identified using an index. The | ||
first index is 0 (because we are in the computer world). | ||
++++ | ||
''' | ||
|
||
[cols=">25%,^25%,50%"] | ||
[frame="topbot"] | ||
|=== | ||
^|Name | Type ^| Description | ||
|
||
|[[argName]]`argName` | ||
|`String` | ||
|+++ | ||
Sets the argument name of this link.+++ | ||
|
||
|[[defaultValue]]`defaultValue` | ||
|`String` | ||
|+++ | ||
Sets the default value of this link.+++ | ||
|
||
|[[description]]`description` | ||
|`String` | ||
|+++ | ||
Sets the description of the link.+++ | ||
|
||
|[[hidden]]`hidden` | ||
|`Boolean` | ||
|+++ | ||
Sets whether or not the current link is hidden.+++ | ||
|
||
|[[index]]`index` | ||
|`Number (int)` | ||
|+++ | ||
Sets the argument index.+++ | ||
|
||
|[[required]]`required` | ||
|`Boolean` | ||
|+++ | ||
Sets whether or not the current link is required.+++ | ||
|=== |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,69 @@ | ||
== Option | ||
|
||
++++ | ||
Models command line options. Options are values passed to a command line interface using -x or --x. Supported | ||
syntaxes depend on the parser. | ||
<p/> | ||
Short name is generally used with a single dash, while long name requires a double-dash. | ||
++++ | ||
''' | ||
|
||
[cols=">25%,^25%,50%"] | ||
[frame="topbot"] | ||
|=== | ||
^|Name | Type ^| Description | ||
|
||
|[[argName]]`argName` | ||
|`String` | ||
|+++ | ||
Sets te arg name for this option.+++ | ||
|
||
|[[defaultValue]]`defaultValue` | ||
|`String` | ||
|+++ | ||
Sets the default value of this option+++ | ||
|
||
|[[description]]`description` | ||
|`String` | ||
|+++ | ||
Sets te description of this option.+++ | ||
|
||
|[[flag]]`flag` | ||
|`Boolean` | ||
|+++ | ||
Configures the current link to be a flag. It will be evaluated to <code>true</code> if it's found in | ||
the command line. If you need a flag that may receive a value, use, in this order: | ||
<code><pre> | ||
option.setFlag(true).setSingleValued(true) | ||
</pre></code>+++ | ||
|
||
|[[hidden]]`hidden` | ||
|`Boolean` | ||
|+++ | ||
Sets whether or not this option should be hidden+++ | ||
|
||
|[[longName]]`longName` | ||
|`String` | ||
|+++ | ||
Sets the long name of this option.+++ | ||
|
||
|[[multiValued]]`multiValued` | ||
|`Boolean` | ||
|+++ | ||
Sets whether or not this option can receive several values.+++ | ||
|
||
|[[required]]`required` | ||
|`Boolean` | ||
|+++ | ||
Sets whether or not this option is mandatory.+++ | ||
|
||
|[[shortName]]`shortName` | ||
|`String` | ||
|+++ | ||
Sets the short name of this option.+++ | ||
|
||
|[[singleValued]]`singleValued` | ||
|`Boolean` | ||
|+++ | ||
Sets whether or not this option can receive a value.+++ | ||
|=== |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.