Skip to content

Commit

Permalink
Merge d8cc764 into f6905da
Browse files Browse the repository at this point in the history
  • Loading branch information
dodie committed Aug 16, 2018
2 parents f6905da + d8cc764 commit e3ccde9
Show file tree
Hide file tree
Showing 4 changed files with 9 additions and 13 deletions.
5 changes: 2 additions & 3 deletions docs/guide/annotations/copyright.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,12 +9,11 @@ The `@Copyright` annotation may be applied to classes and provides a copyright s

To use it simply add it like so:

```
java
```java
@Copyright(startYear = 2015,
endYear = 2016,
holder = "John Doe")
public class MyClass { }
```

The `startYear` and `holder` are required while the `endYear` is optional.
The `startYear` and `holder` are required while the `endYear` is optional.
7 changes: 3 additions & 4 deletions docs/guide/annotations/examples.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,9 +9,8 @@ The `@Examples` annotation may be applied to classes and provides documentation

To use it add it like so:

```
java
@ExitCodes(examples =
```java
@Examples(examples =
{
"my-cmd --lower bar",
"my-cmd --raise bar"
Expand All @@ -24,4 +23,4 @@ java
public class MyClass { }
```

The annotation takes two arrays, the `examples` array specifies an example of using the command while `descriptions` provides corresponding description of what each example does.
The annotation takes two arrays, the `examples` array specifies an example of using the command while `descriptions` provides corresponding description of what each example does.
5 changes: 2 additions & 3 deletions docs/guide/annotations/exit-codes.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,8 +9,7 @@ The `@ExitCodes` annotation may be applied to classes and provides documentation

To use it add it like so:

```
java
```java
@ExitCodes(codes =
{
0,
Expand All @@ -24,4 +23,4 @@ java
public class MyClass { }
```

The annotation takes two arrays, the `codes` array specifies the exit codes that the command may produce while `descriptions` provides corresponding description of the meaning of the exit codes.
The annotation takes two arrays, the `codes` array specifies the exit codes that the command may produce while `descriptions` provides corresponding description of the meaning of the exit codes.
5 changes: 2 additions & 3 deletions docs/guide/annotations/license.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,8 +9,7 @@ The `@License` annotation may be applied to classes and provides a copyright sta

To use it simply add it like so:

```
java
```java
@License(paragraphs =
{
"This command is licensed under the Apache License 2.0"
Expand All @@ -19,4 +18,4 @@ java
public class MyClass { }
```

The `paragraphs` field provides an array of strings where each string is a paragraph that is used to describe the license. The `url` field may be used to provide a URL where the user can find further license information.
The `paragraphs` field provides an array of strings where each string is a paragraph that is used to describe the license. The `url` field may be used to provide a URL where the user can find further license information.

0 comments on commit e3ccde9

Please sign in to comment.