Skip to content

Commit 0f7bdb5

Browse files
committed
Javadoc/checkstyle fixes
1 parent 4bf3f32 commit 0f7bdb5

File tree

7 files changed

+24
-5
lines changed

7 files changed

+24
-5
lines changed

etc/prepare-release.sh

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,6 @@
22

33
DIR=$(cd "$(dirname "$0")"; pwd)
44

5-
if sh $DIR/javadoc.sh; then
5+
if sh $DIR/checkstyle.sh; then
66
sh $DIR/versions.sh
77
fi

jooby/src/main/java/io/jooby/Context.java

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -699,6 +699,7 @@ public interface Context extends Registry {
699699
*
700700
* @param next Application code.
701701
* @return This context.
702+
* @throws Exception When detach operation fails.
702703
*/
703704
@Nonnull Context detach(@Nonnull Route.Handler next) throws Exception;
704705

jooby/src/main/java/io/jooby/Formdata.java

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,6 @@
99

1010
import javax.annotation.Nonnull;
1111
import java.util.Collection;
12-
import java.util.List;
1312

1413
/**
1514
* Formdata class for direct MVC parameter provisioning.

jooby/src/main/java/io/jooby/annotations/Consumes.java

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -235,7 +235,9 @@
235235
@Documented
236236
public @interface Consumes {
237237
/**
238-
* @return Media types the route can consume.
238+
* List of media types.
239+
*
240+
* @return Media types.
239241
*/
240242
String[] value();
241243
}

jooby/src/main/java/io/jooby/annotations/Produces.java

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -232,5 +232,10 @@
232232
@Retention(RetentionPolicy.RUNTIME)
233233
@Documented
234234
public @interface Produces {
235-
String[] value();
235+
/**
236+
* List of media types.
237+
*
238+
* @return Media types.
239+
*/
240+
String[] value();
236241
}

modules/jooby-test/src/main/java/io/jooby/MockContext.java

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -112,6 +112,7 @@ MockContext setMethod(@Nonnull String method) {
112112
* Set flash map.
113113
*
114114
* @param flashMap Flash map.
115+
* @return This context.
115116
*/
116117
public MockContext setFlashMap(@Nonnull FlashMap flashMap) {
117118
this.flashMap = flashMap;

modules/jooby-test/src/main/java/io/jooby/MockSession.java

Lines changed: 12 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,9 @@
1212
import java.util.Optional;
1313
import java.util.UUID;
1414

15+
/**
16+
* Mock session.
17+
*/
1518
public class MockSession implements Session {
1619
private String sessionId;
1720

@@ -21,12 +24,20 @@ public class MockSession implements Session {
2124
private boolean isNew;
2225
private boolean modified;
2326

24-
public MockSession(String sessionId) {
27+
/**
28+
* Creates a mock session.
29+
*
30+
* @param sessionId Session ID.
31+
*/
32+
public MockSession(@Nonnull String sessionId) {
2533
this.sessionId = sessionId;
2634
this.creationTime = Instant.now();
2735
this.lastAccessedTime = Instant.now();
2836
}
2937

38+
/**
39+
* Mock session with a random ID.
40+
*/
3041
public MockSession() {
3142
this(UUID.randomUUID().toString());
3243
}

0 commit comments

Comments
 (0)