Skip to content

Commit 52e2b0d

Browse files
committed
Update documentation.
1 parent ce98d01 commit 52e2b0d

File tree

3 files changed

+8
-6
lines changed

3 files changed

+8
-6
lines changed

README.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -295,10 +295,11 @@ public class MathService extends WebService {
295295
}
296296
```
297297

298-
The `Description` annotation can also be applied to bean properties:
298+
The `Description` annotation can also be applied to bean types and properties:
299299

300300
```java
301-
public static class Item {
301+
@Description("Represents an item in a product catalog.")
302+
public class Item {
302303
...
303304

304305
@Description("The item's description.")

build.gradle

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@
1414

1515
subprojects {
1616
group = 'org.httprpc'
17-
version = '8.0'
17+
version = '8.0.1'
1818

1919
apply plugin: 'java-library'
2020
apply plugin: 'maven-publish'

httprpc-server/src/main/java/org/httprpc/Description.java

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -20,15 +20,16 @@
2020
import java.lang.annotation.Target;
2121

2222
/**
23-
* Annotation that associates a description with a service class, method, or
24-
* method parameter.
23+
* Annotation that associates a description with a service class, method,
24+
* parameter, or data structure.
2525
*/
2626
@Retention(RetentionPolicy.RUNTIME)
2727
@Target({ElementType.TYPE, ElementType.METHOD, ElementType.PARAMETER})
2828
public @interface Description {
2929
/**
3030
* @return
31-
* The description of the class, method, or method parameter.
31+
* The description of the service class, method, parameter, or data
32+
* structure.
3233
*/
3334
String value();
3435
}

0 commit comments

Comments
 (0)