Skip to content

Commit 4b7234a

Browse files
committed
Fixed javadocs warning
1 parent 8e51442 commit 4b7234a

File tree

54 files changed

+151
-91
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

54 files changed

+151
-91
lines changed

modules/org.restlet.ext.httpclient/src/main/java/org/restlet/ext/httpclient/HttpClientHelper.java

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -71,6 +71,7 @@
7171
* Here is the list of parameters that are supported. They should be set in the
7272
* Client's context before it is started:
7373
* <table>
74+
* <caption>list of supported parameters</caption>
7475
* <tr>
7576
* <th>Parameter name</th>
7677
* <th>Value type</th>

modules/org.restlet.ext.jackson/src/main/java/org/restlet/ext/jackson/JacksonConverter.java

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -77,6 +77,7 @@ public class JacksonConverter extends ConverterHelper {
7777
* Creates the marshaling {@link JacksonRepresentation}.
7878
*
7979
* @param <T>
80+
* The expected class of the representation Java object.
8081
* @param mediaType
8182
* The target media type.
8283
* @param source
@@ -91,6 +92,7 @@ protected <T> JacksonRepresentation<T> create(MediaType mediaType, T source) {
9192
* Creates the unmarshaling {@link JacksonRepresentation}.
9293
*
9394
* @param <T>
95+
* The expected class of the representation Java object.
9496
* @param source
9597
* The source representation to unmarshal.
9698
* @param objectClass

modules/org.restlet.ext.jaxb/src/main/java/org/restlet/ext/jaxb/JaxbRepresentation.java

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -366,6 +366,7 @@ public String getContextPath() {
366366
* Returns a JAXB SAX source.
367367
*
368368
* @return A JAXB SAX source.
369+
* @throws IOException
369370
*/
370371
public JAXBSource getJaxbSource() throws IOException {
371372
try {

modules/org.restlet.ext.jetty/src/main/java/org/restlet/ext/jetty/HttpClientHelper.java

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -52,6 +52,7 @@
5252
* that are supported. They should be set in the Client's context before it is
5353
* started:
5454
* <table>
55+
* <caption>list of supported parameters</caption>
5556
* <tr>
5657
* <th>Parameter name</th>
5758
* <th>Value type</th>

modules/org.restlet.ext.jetty/src/main/java/org/restlet/ext/jetty/HttpsServerHelper.java

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -41,6 +41,7 @@
4141
* are supported. They should be set in the Server's context before it is
4242
* started:
4343
* <table>
44+
* <caption>list of supported parameters</caption>
4445
* <tr>
4546
* <th>Parameter name</th>
4647
* <th>Value type</th>

modules/org.restlet.ext.jetty/src/main/java/org/restlet/ext/jetty/JettyServerHelper.java

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -50,6 +50,7 @@
5050
* Abstract Jetty web server connector. Here is the list of parameters that are
5151
* supported. They should be set in the Server's context before it is started:
5252
* <table>
53+
* <caption>list of supported parameters</caption>
5354
* <tr>
5455
* <th>Parameter name</th>
5556
* <th>Value type</th>

modules/org.restlet.ext.json/src/main/java/org/restlet/ext/json/JsonRepresentation.java

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -133,8 +133,7 @@ public JsonRepresentation(Object bean) {
133133
* @param jsonRepresentation
134134
* A source JSON representation to parse.
135135
*/
136-
public JsonRepresentation(Representation jsonRepresentation)
137-
throws IOException {
136+
public JsonRepresentation(Representation jsonRepresentation) {
138137
super((jsonRepresentation == null) ? null : jsonRepresentation
139138
.getMediaType());
140139
this.jsonRepresentation = jsonRepresentation;

modules/org.restlet.ext.odata/src/main/java/org/restlet/ext/odata/Query.java

Lines changed: 22 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -67,7 +67,7 @@ public class Query<T> implements Iterable<T> {
6767
*
6868
* @author Thierry Boileau
6969
*
70-
* @param <T>
70+
* @param <E>
7171
*/
7272
private class EntryIterator<E> implements Iterator<E> {
7373

@@ -237,15 +237,15 @@ public Query(Service service, String subpath, Class<T> entityClass) {
237237
}
238238

239239
/**
240-
* Creates a new Query<T> with the query parameter set in the URI generated
240+
* Creates a new Query with the query parameter set in the URI generated
241241
* by the returned query.
242242
*
243243
* @param name
244244
* The string value that contains the name of the query string
245245
* option to add.
246246
* @param value
247247
* The value of the query string option.
248-
* @return A new Query<T> with the query parameter set in the URI generated
248+
* @return A new Query with the query parameter set in the URI generated
249249
* by the returned query.
250250
*/
251251
@SuppressWarnings("unchecked")
@@ -262,12 +262,12 @@ public Query<T> addParameter(String name, String value) {
262262
}
263263

264264
/**
265-
* Creates a new Query<T> with the query parameter set in the URI generated
265+
* Creates a new Query with the query parameter set in the URI generated
266266
* by the returned query.
267267
*
268268
* @param params
269269
* the set of name/value pairs to add to the query string
270-
* @return A new Query<T> with the query parameter set in the URI generated
270+
* @return A new Query with the query parameter set in the URI generated
271271
* by the returned query.
272272
*/
273273
@SuppressWarnings("unchecked")
@@ -428,26 +428,26 @@ public void execute() throws Exception {
428428
}
429429

430430
/**
431-
* Creates a new Query<T> with the $expand option set in the URI generated
431+
* Creates a new Query with the $expand option set in the URI generated
432432
* by the returned query.
433433
*
434434
* @param path
435435
* A string value that contains the requesting URI.
436-
* @return A new Query<T> with the $expand option set in the URI generated
436+
* @return A new Query with the $expand option set in the URI generated
437437
* by the returned query.
438438
*/
439439
public Query<T> expand(String path) {
440440
return addParameter("$expand", path);
441441
}
442442

443443
/**
444-
* Creates a new Query<T> with the $filter option set in the URI generated
444+
* Creates a new Query with the $filter option set in the URI generated
445445
* by the returned query.
446446
*
447447
* @param predicate
448448
* A string value that contains the predicate used to filter the
449449
* data.
450-
* @return A new Query<T> with the $filter option set in the URI generated
450+
* @return A new Query with the $filter option set in the URI generated
451451
* by the returned query.
452452
*/
453453
public Query<T> filter(String predicate) {
@@ -602,13 +602,13 @@ private int guessType(String targetUri) {
602602
}
603603

604604
/**
605-
* Creates a new Query<T> with the $inlinecount option set in the URI
605+
* Creates a new Query with the $inlinecount option set in the URI
606606
* generated by the returned query.
607607
*
608608
* @param inlineCount
609609
* True if the total number of entities in the entity set must be
610610
* returned.
611-
* @return A new Query<T> with the $inlinecount option set in the URI
611+
* @return A new Query with the $inlinecount option set in the URI
612612
* generated by the returned query.
613613
*/
614614
public Query<T> inlineCount(boolean inlineCount) {
@@ -670,26 +670,26 @@ public Iterator<T> iterator() {
670670
}
671671

672672
/**
673-
* Creates a new Query<T> with the $orderby option set in the URI generated
673+
* Creates a new Query with the $orderby option set in the URI generated
674674
* by the returned query.
675675
*
676676
* @param criteria
677677
* A string value that contains the criteria used to order the
678678
* results.
679-
* @return A new Query<T> with the $orderby option set in the URI generated
679+
* @return A new Query with the $orderby option set in the URI generated
680680
* by the returned query.
681681
*/
682682
public Query<T> orderBy(String criteria) {
683683
return addParameter("$orderby", criteria);
684684
}
685685

686686
/**
687-
* Creates a new Query<T> with the $select option set in the URI generated
687+
* Creates a new Query with the $select option set in the URI generated
688688
* by the returned query.
689689
*
690690
* @param select
691691
* A string value that contains the requesting URI.
692-
* @return A new Query<T> with the $select option set in the URI generated
692+
* @return A new Query with the $select option set in the URI generated
693693
* by the returned query.
694694
*/
695695
public Query<T> select(String select) {
@@ -737,38 +737,38 @@ public void setQuery(String query) {
737737
}
738738

739739
/**
740-
* Creates a new Query<T> with the $skip option set in the URI generated by
740+
* Creates a new Query with the $skip option set in the URI generated by
741741
* the returned query.
742742
*
743743
* @param rowsCount
744744
* A number of rows to skip.
745-
* @return A new Query<T> with the $skip option set in the URI generated by
745+
* @return A new Query with the $skip option set in the URI generated by
746746
* the returned query.
747747
*/
748748
public Query<T> skip(int rowsCount) {
749749
return addParameter("$skip", Integer.toString(rowsCount));
750750
}
751751

752752
/**
753-
* Creates a new Query<T> with the $skiptoken option set in the URI
753+
* Creates a new Query with the $skiptoken option set in the URI
754754
* generated by the returned query.
755755
*
756756
* @param token
757757
* A string value that contains the requesting URI.
758-
* @return A new Query<T> with the $skiptoken option set in the URI
758+
* @return A new Query with the $skiptoken option set in the URI
759759
* generated by the returned query.
760760
*/
761761
public Query<T> skipToken(String token) {
762762
return addParameter("$skiptoken", token);
763763
}
764764

765765
/**
766-
* Creates a new Query<T> with the $top option set in the URI generated by
766+
* Creates a new Query with the $top option set in the URI generated by
767767
* the returned query.
768-
*
768+
*
769769
* @param rowsCount
770770
* A number of rows used to limit the number of results.
771-
* @return A new Query<T> with the $top option set in the URI generated by
771+
* @return A new Query with the $top option set in the URI generated by
772772
* the returned query.
773773
*/
774774
public Query<T> top(int rowsCount) {

modules/org.restlet.ext.odata/src/main/java/org/restlet/ext/odata/Service.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -878,7 +878,7 @@ public Representation invokeComplex(String service,
878878
* @throws ResourceException
879879
* Thrown when the service call is not successfull.
880880
* @throws Exception
881-
* Thrown when the value cannot be parsed.
881+
*
882882
* @see <a
883883
* href="http://msdn.microsoft.com/en-us/library/cc668788.aspx">Service
884884
* Operations</a>

modules/org.restlet.ext.servlet/src/main/java/org/restlet/ext/servlet/ServerServlet.java

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -67,6 +67,7 @@
6767
* Please note that you can also combine the two first of them whereas the last
6868
* one is a full alternative. They are described below by order of priority:
6969
* <table>
70+
* <caption>list of supported deployment modes</caption>
7071
* <tr>
7172
* <th>Mode</th>
7273
* <th>Description</th>

0 commit comments

Comments
 (0)