Skip to content

Commit f79d9bd

Browse files
committed
improve javadoc on jsonb only
1 parent 1c90e5b commit f79d9bd

File tree

1 file changed

+9
-9
lines changed

1 file changed

+9
-9
lines changed

jsonb/src/main/java/io/avaje/jsonb/Jsonb.java

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -60,7 +60,7 @@
6060
public interface Jsonb {
6161

6262
/**
63-
* Create and return a new Jsonb.Builder to configure before building the Jsonb instance.
63+
* Create a new Jsonb.Builder to configure and build the Jsonb instance.
6464
* <p>
6565
* We can register JsonAdapter's to use for specific types before building and returning
6666
* the Jsonb instance to use.
@@ -87,22 +87,22 @@ static Builder newBuilder() {
8787
}
8888

8989
/**
90-
* Return JSON content for the given object.
90+
* Return json content for the given object.
9191
* <p>
9292
* This is a convenience method for using {@code jsonb.type(Object.class).toJson(any) }
9393
*
94-
* @param any The object to return as JSON string
95-
* @return Return JSON content for the given object.
94+
* @param any The object to return as json string
95+
* @return Return json content for the given object.
9696
*/
9797
String toJson(Object any);
9898

9999
/**
100-
* Return JSON content in pretty format for the given object.
100+
* Return json content in pretty format for the given object.
101101
* <p>
102102
* This is a convenience method for using {@code jsonb.type(Object.class).toJsonPretty(any) }
103103
*
104-
* @param any The object to return as JSON string in pretty format
105-
* @return Return JSON content in pretty format for the given object.
104+
* @param any The object to return as json string in pretty format
105+
* @return Return json content in pretty format for the given object.
106106
*/
107107
String toJsonPretty(Object any);
108108

@@ -133,7 +133,7 @@ static Builder newBuilder() {
133133
* is determined dynamically based on the type of the object value passed in.
134134
* <p>
135135
* When using <code>Object.class</code> and reading <code>fromJson()</code> then the java types used in
136-
* the result are determined dynamically based on the JSON types being read and the resulting java types
136+
* the result are determined dynamically based on the json types being read and the resulting java types
137137
* are ArrayList, LinkedHashMap, String, boolean, and double.
138138
*/
139139
<T> JsonType<T> type(Class<T> cls);
@@ -163,7 +163,7 @@ static Builder newBuilder() {
163163
* is determined dynamically based on the type of the object value passed in.
164164
* <p>
165165
* When using <code>Object.class</code> and reading <code>fromJson()</code> then the java types used in
166-
* the result are determined dynamically based on the JSON types being read and the resulting java types
166+
* the result are determined dynamically based on the json types being read and the resulting java types
167167
* are ArrayList, LinkedHashMap, String, boolean, and double.
168168
*/
169169
<T> JsonType<T> type(Type type);

0 commit comments

Comments
 (0)