From d8cc764478f2051e741832760335e3762ca65b10 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?D=C3=A1vid=20Cs=C3=A1kv=C3=A1ri?= Date: Thu, 16 Aug 2018 13:25:38 +0200 Subject: [PATCH] Fix docs (#83) - fix formatting - fix copy-paste error in the docs of @Examples --- docs/guide/annotations/copyright.md | 5 ++--- docs/guide/annotations/examples.md | 7 +++---- docs/guide/annotations/exit-codes.md | 5 ++--- docs/guide/annotations/license.md | 5 ++--- 4 files changed, 9 insertions(+), 13 deletions(-) diff --git a/docs/guide/annotations/copyright.md b/docs/guide/annotations/copyright.md index 7ef501f17..f6c558cf4 100644 --- a/docs/guide/annotations/copyright.md +++ b/docs/guide/annotations/copyright.md @@ -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. \ No newline at end of file +The `startYear` and `holder` are required while the `endYear` is optional. diff --git a/docs/guide/annotations/examples.md b/docs/guide/annotations/examples.md index da12cf7eb..380e1d1e8 100644 --- a/docs/guide/annotations/examples.md +++ b/docs/guide/annotations/examples.md @@ -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" @@ -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. \ No newline at end of file +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. diff --git a/docs/guide/annotations/exit-codes.md b/docs/guide/annotations/exit-codes.md index d63c03a63..9c0d5ec47 100644 --- a/docs/guide/annotations/exit-codes.md +++ b/docs/guide/annotations/exit-codes.md @@ -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, @@ -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. \ No newline at end of file +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. diff --git a/docs/guide/annotations/license.md b/docs/guide/annotations/license.md index 4568e8d36..b8b84c99f 100644 --- a/docs/guide/annotations/license.md +++ b/docs/guide/annotations/license.md @@ -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" @@ -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. \ No newline at end of file +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.