From 98a30c6c84862b82e9a912ba2c47c3ca9052e225 Mon Sep 17 00:00:00 2001
From: Daniel Gerhardt <code@dgerhardt.net>
Date: Thu, 27 Jun 2019 14:27:00 +0200
Subject: [PATCH] Add/adjust Javadocs to conform with style conventions
---
.../de/thm/arsnova/cache/ScheduledCacheBuster.java | 5 ++++-
src/main/java/de/thm/arsnova/cache/package-info.java | 2 +-
src/main/java/de/thm/arsnova/config/AppConfig.java | 2 ++
.../java/de/thm/arsnova/config/package-info.java | 2 +-
.../java/de/thm/arsnova/controller/package-info.java | 2 +-
.../thm/arsnova/controller/v2/ContentController.java | 8 ++++----
.../de/thm/arsnova/controller/v2/MotdController.java | 3 ---
src/main/java/de/thm/arsnova/event/package-info.java | 2 +-
src/main/java/de/thm/arsnova/model/Answer.java | 2 ++
src/main/java/de/thm/arsnova/model/Attachment.java | 2 ++
src/main/java/de/thm/arsnova/model/Comment.java | 2 ++
src/main/java/de/thm/arsnova/model/Content.java | 2 ++
src/main/java/de/thm/arsnova/model/LogEntry.java | 2 ++
.../java/de/thm/arsnova/model/MigrationState.java | 2 ++
src/main/java/de/thm/arsnova/model/Motd.java | 2 ++
src/main/java/de/thm/arsnova/model/Room.java | 2 ++
src/main/java/de/thm/arsnova/model/UserProfile.java | 2 ++
.../de/thm/arsnova/model/migration/v2/Answer.java | 2 ++
src/main/java/de/thm/arsnova/model/package-info.java | 2 +-
.../de/thm/arsnova/model/transport/package-info.java | 2 ++
src/main/java/de/thm/arsnova/package-info.java | 5 -----
.../de/thm/arsnova/persistence/CrudRepository.java | 3 ++-
.../couchdb/support/MangoCouchDbConnector.java | 10 +++++++++-
.../couchdb/support/PagedMangoResponse.java | 2 +-
.../java/de/thm/arsnova/security/package-info.java | 5 ++---
.../de/thm/arsnova/service/FeedbackServiceImpl.java | 2 +-
.../de/thm/arsnova/service/FindQueryService.java | 1 +
.../java/de/thm/arsnova/service/package-info.java | 3 ++-
.../service/score/ScoreCalculatorFactoryImpl.java | 2 ++
src/main/java/de/thm/arsnova/util/ImageUtils.java | 6 +++---
.../de/thm/arsnova/util/PaginationListDecorator.java | 12 ++++++------
.../de/thm/arsnova/web/exceptions/package-info.java | 2 +-
src/main/java/de/thm/arsnova/web/package-info.java | 2 +-
.../thm/arsnova/websocket/ArsnovaSocketioServer.java | 2 --
.../thm/arsnova/websocket/message/package-info.java | 2 +-
.../java/de/thm/arsnova/websocket/package-info.java | 2 +-
36 files changed, 70 insertions(+), 41 deletions(-)
delete mode 100644 src/main/java/de/thm/arsnova/package-info.java
diff --git a/src/main/java/de/thm/arsnova/cache/ScheduledCacheBuster.java b/src/main/java/de/thm/arsnova/cache/ScheduledCacheBuster.java
index 219d6186b..fa9e37d23 100644
--- a/src/main/java/de/thm/arsnova/cache/ScheduledCacheBuster.java
+++ b/src/main/java/de/thm/arsnova/cache/ScheduledCacheBuster.java
@@ -22,7 +22,9 @@ import org.springframework.cache.annotation.CacheEvict;
import org.springframework.scheduling.annotation.Scheduled;
import org.springframework.stereotype.Component;
-/** This component cleares caches at fixed time intervals:
+/** This component cleares caches at fixed time intervals.
+ *
+ * <p>Time intervals:
* <ul>
* <li><code>sessions</code>: 6h</li>
* <li><code>skillquestions</code>, <code>lecturequestions</code>, <code>preparationquestions</code>,
@@ -31,6 +33,7 @@ import org.springframework.stereotype.Component;
* <li><code>answers</code>: 15min</li>
* <li><code>learningprogress</code>: 15min</li>
* </ul>
+ * </p>
*/
@Component
public class ScheduledCacheBuster {
diff --git a/src/main/java/de/thm/arsnova/cache/package-info.java b/src/main/java/de/thm/arsnova/cache/package-info.java
index 24a4552da..18079c625 100644
--- a/src/main/java/de/thm/arsnova/cache/package-info.java
+++ b/src/main/java/de/thm/arsnova/cache/package-info.java
@@ -1,5 +1,5 @@
/**
- * Classes and interfaces related to caching
+ * Classes and interfaces related to caching.
*/
package de.thm.arsnova.cache;
diff --git a/src/main/java/de/thm/arsnova/config/AppConfig.java b/src/main/java/de/thm/arsnova/config/AppConfig.java
index fc360c599..4f21115f2 100644
--- a/src/main/java/de/thm/arsnova/config/AppConfig.java
+++ b/src/main/java/de/thm/arsnova/config/AppConfig.java
@@ -76,9 +76,11 @@ import de.thm.arsnova.websocket.ArsnovaSocketioServerImpl;
/**
* Loads property file and configures non-security related beans and components.
*
+ * <p>
* expose-proxy for AspectJ is needed to access the proxy object via AopContext.currentProxy() in CouchDBDao. It might
* have a negative impact on performance but is needed for caching until a better solution is implemented (e.g. use of
* AspectJ's weaving).
+ * </p>
*/
@ComponentScan({
"de.thm.arsnova.cache",
diff --git a/src/main/java/de/thm/arsnova/config/package-info.java b/src/main/java/de/thm/arsnova/config/package-info.java
index da30baa77..4f597a91c 100644
--- a/src/main/java/de/thm/arsnova/config/package-info.java
+++ b/src/main/java/de/thm/arsnova/config/package-info.java
@@ -1,5 +1,5 @@
/**
- * Configuration of Spring's and ARSnova's components
+ * Configuration of Spring's and ARSnova's components.
*/
package de.thm.arsnova.config;
diff --git a/src/main/java/de/thm/arsnova/controller/package-info.java b/src/main/java/de/thm/arsnova/controller/package-info.java
index 838e3210f..5ebf3889f 100644
--- a/src/main/java/de/thm/arsnova/controller/package-info.java
+++ b/src/main/java/de/thm/arsnova/controller/package-info.java
@@ -1,5 +1,5 @@
/**
- * The 'C' in MVC
+ * Controllers and helper classes which define the public API.
*/
package de.thm.arsnova.controller;
diff --git a/src/main/java/de/thm/arsnova/controller/v2/ContentController.java b/src/main/java/de/thm/arsnova/controller/v2/ContentController.java
index 88eb31b51..803595502 100644
--- a/src/main/java/de/thm/arsnova/controller/v2/ContentController.java
+++ b/src/main/java/de/thm/arsnova/controller/v2/ContentController.java
@@ -421,7 +421,7 @@ public class ContentController extends PaginationController {
}
/**
- * returns a JSON document which represents the given answer of a content.
+ * Returns a JSON document which represents the given answer of a content.
*
* @param contentId
* CouchDB Content ID for which the given answer should be
@@ -456,10 +456,10 @@ public class ContentController extends PaginationController {
}
/**
- * returns a list of {@link Answer}s encoded as a JSON document for a given
+ * Returns a list of {@link Answer}s encoded as a JSON document for a given
* content id. In this case only {@link Answer} <tt>contentId</tt>,
* <tt>answerText</tt>, <tt>answerSubject</tt> and <tt>answerCount</tt>
- * properties are set
+ * properties are set.
*
* @param contentId
* CouchDB Content ID for which the given answers should be
@@ -591,11 +591,11 @@ public class ContentController extends PaginationController {
}
/**
+ * Returns the count of answers for given content ID.
*
* @param contentId
* Content ID for which the given answers should be
* retrieved
- * @return count of answers for given content ID
* @throws NotFoundException
* if wrong room or wrong content
* @throws ForbiddenException
diff --git a/src/main/java/de/thm/arsnova/controller/v2/MotdController.java b/src/main/java/de/thm/arsnova/controller/v2/MotdController.java
index 9667802cf..8ccdcb554 100644
--- a/src/main/java/de/thm/arsnova/controller/v2/MotdController.java
+++ b/src/main/java/de/thm/arsnova/controller/v2/MotdController.java
@@ -50,9 +50,6 @@ import de.thm.arsnova.service.RoomService;
import de.thm.arsnova.service.UserService;
import de.thm.arsnova.web.exceptions.ForbiddenException;
-/**
- *
- */
@RestController("v2MotdController")
@RequestMapping("/v2/motd")
@Api(value = "/motd", description = "Message of the Day API")
diff --git a/src/main/java/de/thm/arsnova/event/package-info.java b/src/main/java/de/thm/arsnova/event/package-info.java
index d1ffd4be2..a89acef9e 100644
--- a/src/main/java/de/thm/arsnova/event/package-info.java
+++ b/src/main/java/de/thm/arsnova/event/package-info.java
@@ -1,5 +1,5 @@
/**
- * ARSnova's internal event system
+ * Event classes used for the application event system.
*/
package de.thm.arsnova.event;
diff --git a/src/main/java/de/thm/arsnova/model/Answer.java b/src/main/java/de/thm/arsnova/model/Answer.java
index 551fb7484..755054ce0 100644
--- a/src/main/java/de/thm/arsnova/model/Answer.java
+++ b/src/main/java/de/thm/arsnova/model/Answer.java
@@ -111,8 +111,10 @@ public class Answer extends Entity {
/**
* {@inheritDoc}
*
+ * <p>
* The following fields of <tt>Answer</tt> are excluded from equality checks:
* {@link #extensions}.
+ * </p>
*/
@Override
public boolean equals(final Object o) {
diff --git a/src/main/java/de/thm/arsnova/model/Attachment.java b/src/main/java/de/thm/arsnova/model/Attachment.java
index 6bb0af004..7cb6bb42a 100644
--- a/src/main/java/de/thm/arsnova/model/Attachment.java
+++ b/src/main/java/de/thm/arsnova/model/Attachment.java
@@ -97,7 +97,9 @@ public class Attachment extends Entity {
/**
* {@inheritDoc}
*
+ * <p>
* All fields of <tt>Attachment</tt> are included in equality checks.
+ * </p>
*/
@Override
public boolean equals(final Object o) {
diff --git a/src/main/java/de/thm/arsnova/model/Comment.java b/src/main/java/de/thm/arsnova/model/Comment.java
index 97160635e..4ae7708af 100644
--- a/src/main/java/de/thm/arsnova/model/Comment.java
+++ b/src/main/java/de/thm/arsnova/model/Comment.java
@@ -108,8 +108,10 @@ public class Comment extends Entity {
/**
* {@inheritDoc}
*
+ * <p>
* The following fields of <tt>LogEntry</tt> are excluded from equality checks:
* {@link #extensions}.
+ * </p>
*/
@Override
public boolean equals(final Object o) {
diff --git a/src/main/java/de/thm/arsnova/model/Content.java b/src/main/java/de/thm/arsnova/model/Content.java
index f708e6f9f..d0e45af14 100644
--- a/src/main/java/de/thm/arsnova/model/Content.java
+++ b/src/main/java/de/thm/arsnova/model/Content.java
@@ -281,8 +281,10 @@ public class Content extends Entity {
/**
* {@inheritDoc}
*
+ * <p>
* The following fields of <tt>LogEntry</tt> are excluded from equality checks:
* {@link #state}, {@link #extensions}, {@link #attachments}.
+ * </p>
*/
@Override
public boolean equals(final Object o) {
diff --git a/src/main/java/de/thm/arsnova/model/LogEntry.java b/src/main/java/de/thm/arsnova/model/LogEntry.java
index 5f6c48c33..1aaa62bb8 100644
--- a/src/main/java/de/thm/arsnova/model/LogEntry.java
+++ b/src/main/java/de/thm/arsnova/model/LogEntry.java
@@ -133,8 +133,10 @@ public class LogEntry extends Entity {
/**
* {@inheritDoc}
*
+ * <p>
* The following fields of <tt>LogEntry</tt> are excluded from equality checks:
* {@link #payload}.
+ * </p>
*/
@Override
public boolean equals(final Object o) {
diff --git a/src/main/java/de/thm/arsnova/model/MigrationState.java b/src/main/java/de/thm/arsnova/model/MigrationState.java
index 23d4dc28c..d04a124ae 100644
--- a/src/main/java/de/thm/arsnova/model/MigrationState.java
+++ b/src/main/java/de/thm/arsnova/model/MigrationState.java
@@ -117,7 +117,9 @@ public class MigrationState extends Entity {
/**
* {@inheritDoc}
*
+ * <p>
* All fields of <tt>MigrationState</tt> are included in equality checks.
+ * </p>
*/
@Override
public boolean equals(final Object o) {
diff --git a/src/main/java/de/thm/arsnova/model/Motd.java b/src/main/java/de/thm/arsnova/model/Motd.java
index 3677ee6ad..30f1f6c7b 100644
--- a/src/main/java/de/thm/arsnova/model/Motd.java
+++ b/src/main/java/de/thm/arsnova/model/Motd.java
@@ -116,7 +116,9 @@ public class Motd extends Entity {
/**
* {@inheritDoc}
*
+ * <p>
* All fields of <tt>Motd</tt> are included in equality checks.
+ * </p>
*/
@Override
public boolean equals(final Object o) {
diff --git a/src/main/java/de/thm/arsnova/model/Room.java b/src/main/java/de/thm/arsnova/model/Room.java
index 142ad48f8..00145bd28 100644
--- a/src/main/java/de/thm/arsnova/model/Room.java
+++ b/src/main/java/de/thm/arsnova/model/Room.java
@@ -625,9 +625,11 @@ public class Room extends Entity {
/**
* {@inheritDoc}
*
+ * <p>
* The following fields of <tt>Room</tt> are excluded from equality checks:
* {@link #contentGroups}, {@link #settings}, {@link #author}, {@link #poolProperties}, {@link #extensions},
* {@link #attachments}, {@link #statistics}.
+ * </p>
*/
@Override
public boolean equals(final Object o) {
diff --git a/src/main/java/de/thm/arsnova/model/UserProfile.java b/src/main/java/de/thm/arsnova/model/UserProfile.java
index 7d17f9fcf..80b18b5dd 100644
--- a/src/main/java/de/thm/arsnova/model/UserProfile.java
+++ b/src/main/java/de/thm/arsnova/model/UserProfile.java
@@ -274,8 +274,10 @@ public class UserProfile extends Entity {
/**
* {@inheritDoc}
*
+ * <p>
* The following fields of <tt>UserProfile</tt> are excluded from equality checks:
* {@link #account}, {@link #roomHistory}, {@link #acknowledgedMotds}, {@link #extensions}.
+ * </p>
*/
@Override
public boolean equals(final Object o) {
diff --git a/src/main/java/de/thm/arsnova/model/migration/v2/Answer.java b/src/main/java/de/thm/arsnova/model/migration/v2/Answer.java
index 1c9740751..0ce4ffb9d 100644
--- a/src/main/java/de/thm/arsnova/model/migration/v2/Answer.java
+++ b/src/main/java/de/thm/arsnova/model/migration/v2/Answer.java
@@ -28,7 +28,9 @@ import de.thm.arsnova.model.serialization.View;
/**
* Both a regular (single choice, evaluation, etc.) as well as a freetext answer.
*
+ * <p>
* This class has additional fields to transport generated answer statistics.
+ * </p>
*/
@ApiModel(value = "Answer", description = "Answer entity - Can represent a single answer or summarized statistics")
public class Answer implements Entity {
diff --git a/src/main/java/de/thm/arsnova/model/package-info.java b/src/main/java/de/thm/arsnova/model/package-info.java
index f7971e9b6..754644224 100644
--- a/src/main/java/de/thm/arsnova/model/package-info.java
+++ b/src/main/java/de/thm/arsnova/model/package-info.java
@@ -1,5 +1,5 @@
/**
- * Classes to translate objects to and from JSON
+ * Classes to translate objects to and from JSON.
*/
package de.thm.arsnova.model;
diff --git a/src/main/java/de/thm/arsnova/model/transport/package-info.java b/src/main/java/de/thm/arsnova/model/transport/package-info.java
index c23f58518..17526ecca 100644
--- a/src/main/java/de/thm/arsnova/model/transport/package-info.java
+++ b/src/main/java/de/thm/arsnova/model/transport/package-info.java
@@ -1,8 +1,10 @@
/**
* Contains classes similar to regular entities, but with a reduced set of properties.
*
+ * <p>
* Since sometimes only a subset of properties are needed, sending the whole entity is a waste of bandwith. Therefore,
* entities optimized for data transport are located here.
+ * </p>
*/
package de.thm.arsnova.model.transport;
diff --git a/src/main/java/de/thm/arsnova/package-info.java b/src/main/java/de/thm/arsnova/package-info.java
deleted file mode 100644
index e961b44b2..000000000
--- a/src/main/java/de/thm/arsnova/package-info.java
+++ /dev/null
@@ -1,5 +0,0 @@
-/**
- * Miscellaneous classes and interfaces that do not fit in any of the given sub-packages
- */
-
-package de.thm.arsnova;
diff --git a/src/main/java/de/thm/arsnova/persistence/CrudRepository.java b/src/main/java/de/thm/arsnova/persistence/CrudRepository.java
index fb7e741c2..0035af09c 100644
--- a/src/main/java/de/thm/arsnova/persistence/CrudRepository.java
+++ b/src/main/java/de/thm/arsnova/persistence/CrudRepository.java
@@ -28,8 +28,9 @@ package de.thm.arsnova.persistence;
*/
public interface CrudRepository<T, I> extends org.springframework.data.repository.CrudRepository<T, I> {
/**
+ * Retrieve a single entity by ID.
*
- * @param id The entity's Id
+ * @param id The entity's ID
* @return The retrieved entity or null
* @deprecated Use {@link #findById(Object)} instead.
*/
diff --git a/src/main/java/de/thm/arsnova/persistence/couchdb/support/MangoCouchDbConnector.java b/src/main/java/de/thm/arsnova/persistence/couchdb/support/MangoCouchDbConnector.java
index 5ca603939..17fdaebc4 100644
--- a/src/main/java/de/thm/arsnova/persistence/couchdb/support/MangoCouchDbConnector.java
+++ b/src/main/java/de/thm/arsnova/persistence/couchdb/support/MangoCouchDbConnector.java
@@ -118,6 +118,8 @@ public class MangoCouchDbConnector extends StdCouchDbConnector {
}
/**
+ * Create a {@link MangoQuery} from criteria used to select documents.
+ *
* @param selector See http://docs.couchdb.org/en/stable/api/database/find.html#selector-syntax.
*/
public MangoQuery(final Map<String, Object> selector) {
@@ -131,6 +133,8 @@ public class MangoCouchDbConnector extends StdCouchDbConnector {
}
/**
+ * Set a Map with criteria used to select documents.
+ *
* @param selector See http://docs.couchdb.org/en/stable/api/database/find.html#selector-syntax.
*/
public void setSelector(final Map<String, Object> selector) {
@@ -234,6 +238,7 @@ public class MangoCouchDbConnector extends StdCouchDbConnector {
}
/**
+ * Retrieves entities from the database selected by the query.
*
* @param query The query sent to CouchDB's Mango API
* @param rh Handler for the response to the query
@@ -257,6 +262,7 @@ public class MangoCouchDbConnector extends StdCouchDbConnector {
}
/**
+ * Retrieves entities from the database selected by the query.
*
* @param query The query sent to CouchDB's Mango API
* @param type Type for deserialization of retrieved entities
@@ -268,6 +274,7 @@ public class MangoCouchDbConnector extends StdCouchDbConnector {
}
/**
+ * Retrieves entities from the database selected by the query.
*
* @param query The query sent to CouchDB's Mango API
* @param propertyName Name of the entity's property to be parsed
@@ -282,10 +289,11 @@ public class MangoCouchDbConnector extends StdCouchDbConnector {
}
/**
+ * Retrieves entities with pagination metadata from the database selected by the query.
*
* @param query The query sent to CouchDB's Mango API
* @param type Type for deserialization of retrieved entities
- * @return List of retrieved entities
+ * @return List of retrieved entities wrapped with pagination metadata
*/
public <T> PagedMangoResponse<T> queryForPage(final MangoQuery query, final Class<T> type) {
final MangoResponseHandler<T> rh = new MangoResponseHandler<>(type, objectMapper, true);
diff --git a/src/main/java/de/thm/arsnova/persistence/couchdb/support/PagedMangoResponse.java b/src/main/java/de/thm/arsnova/persistence/couchdb/support/PagedMangoResponse.java
index dd8cbff5d..cbef4adca 100644
--- a/src/main/java/de/thm/arsnova/persistence/couchdb/support/PagedMangoResponse.java
+++ b/src/main/java/de/thm/arsnova/persistence/couchdb/support/PagedMangoResponse.java
@@ -23,7 +23,7 @@ import java.util.List;
/**
* Contains the entities of the response and the bookmark to query the next page.
*
- * @param <T>
+ * @param <T> Type of entites
* @author Daniel Gerhardt
*/
public class PagedMangoResponse<T> {
diff --git a/src/main/java/de/thm/arsnova/security/package-info.java b/src/main/java/de/thm/arsnova/security/package-info.java
index 399923049..2b8ededfc 100644
--- a/src/main/java/de/thm/arsnova/security/package-info.java
+++ b/src/main/java/de/thm/arsnova/security/package-info.java
@@ -1,6 +1,5 @@
-/** This package contains security related implementations
- * @author Paul-Christian Volkmer
- *
+/**
+ * Authentication and authorization related classes.
*/
package de.thm.arsnova.security;
diff --git a/src/main/java/de/thm/arsnova/service/FeedbackServiceImpl.java b/src/main/java/de/thm/arsnova/service/FeedbackServiceImpl.java
index d36364fd5..df6e52649 100644
--- a/src/main/java/de/thm/arsnova/service/FeedbackServiceImpl.java
+++ b/src/main/java/de/thm/arsnova/service/FeedbackServiceImpl.java
@@ -45,7 +45,7 @@ public class FeedbackServiceImpl implements FeedbackService, ApplicationEventPub
private static final int DEFAULT_SCHEDULER_DELAY = 5000;
/**
- * minutes, after which the feedback is deleted
+ * Minutes, after which the feedback is deleted.
*/
@Value("${feedback.cleanup}")
private int cleanupFeedbackDelay;
diff --git a/src/main/java/de/thm/arsnova/service/FindQueryService.java b/src/main/java/de/thm/arsnova/service/FindQueryService.java
index ebb5e2d57..0384aa78d 100644
--- a/src/main/java/de/thm/arsnova/service/FindQueryService.java
+++ b/src/main/java/de/thm/arsnova/service/FindQueryService.java
@@ -24,6 +24,7 @@ import de.thm.arsnova.model.Entity;
import de.thm.arsnova.model.FindQuery;
/**
+ * Provides a method to find entity IDs by {@link FindQuery}.
*
* @param <E> Entity type
* @author Daniel Gerhardt
diff --git a/src/main/java/de/thm/arsnova/service/package-info.java b/src/main/java/de/thm/arsnova/service/package-info.java
index aadfa1022..1f680add4 100644
--- a/src/main/java/de/thm/arsnova/service/package-info.java
+++ b/src/main/java/de/thm/arsnova/service/package-info.java
@@ -1,5 +1,6 @@
/**
- * Classes and interfaces for the service layer
+ * The service layer provides implementations of domain and system logic and defines rules for authorization and
+ * caching.
*/
package de.thm.arsnova.service;
diff --git a/src/main/java/de/thm/arsnova/service/score/ScoreCalculatorFactoryImpl.java b/src/main/java/de/thm/arsnova/service/score/ScoreCalculatorFactoryImpl.java
index b32e015a6..18e250498 100644
--- a/src/main/java/de/thm/arsnova/service/score/ScoreCalculatorFactoryImpl.java
+++ b/src/main/java/de/thm/arsnova/service/score/ScoreCalculatorFactoryImpl.java
@@ -36,7 +36,9 @@ import de.thm.arsnova.persistence.SessionStatisticsRepository;
/**
* Creates a score calculator implementation.
*
+ * <p>
* This class additionally clears all score caches and reports this via event system.
+ * </p>
*/
@Component
public class ScoreCalculatorFactoryImpl implements ScoreCalculatorFactory, ApplicationEventPublisherAware {
diff --git a/src/main/java/de/thm/arsnova/util/ImageUtils.java b/src/main/java/de/thm/arsnova/util/ImageUtils.java
index 6ada09249..b30d92cac 100644
--- a/src/main/java/de/thm/arsnova/util/ImageUtils.java
+++ b/src/main/java/de/thm/arsnova/util/ImageUtils.java
@@ -46,10 +46,10 @@ public class ImageUtils {
// Or whatever size you want to read in at a time.
static final int CHUNK_SIZE = 4096;
- /** Base64-Mimetype-Prefix start */
+ /* Base64-Mimetype-Prefix start */
static final String IMAGE_PREFIX_START = "data:image/";
- /** Base64-Mimetype-Prefix middle part */
+ /* Base64-Mimetype-Prefix middle part */
static final String IMAGE_PREFIX_MIDDLE = ";base64,";
/* default value is 200 pixel in width, set the value in the configuration file */
@@ -144,7 +144,7 @@ public class ImageUtils {
}
/**
- * Rescales an image represented by a Base64-encoded {@link String}
+ * Rescales an image represented by a Base64-encoded {@link String}.
*
* @param originalImageString
* The original image represented by a Base64-encoded
diff --git a/src/main/java/de/thm/arsnova/util/PaginationListDecorator.java b/src/main/java/de/thm/arsnova/util/PaginationListDecorator.java
index e630c1cf7..b66e73f1c 100644
--- a/src/main/java/de/thm/arsnova/util/PaginationListDecorator.java
+++ b/src/main/java/de/thm/arsnova/util/PaginationListDecorator.java
@@ -52,21 +52,21 @@ public class PaginationListDecorator<T> implements List<T> {
}
/**
- * @return the original (not paginated) List
+ * Returns the original (not paginated) List.
*/
public List<T> getList() {
return list;
}
/**
- * @return the number of skipped items
+ * Returns the number of skipped items.
*/
public int getOffset() {
return offset;
}
/**
- * @param offset the number of items to be skipped
+ * Sets the number of items to be skipped.
*/
public void setOffset(final int offset) {
this.offset = offset;
@@ -75,14 +75,14 @@ public class PaginationListDecorator<T> implements List<T> {
}
/**
- * @return the size limit of the paginated list
+ * Returns the size limit of the paginated list.
*/
public int getLimit() {
return limit;
}
/**
- * @param limit the size limit for the resulting list
+ * Sets the size limit for the resulting list.
*/
public void setLimit(final int limit) {
this.limit = limit;
@@ -91,7 +91,7 @@ public class PaginationListDecorator<T> implements List<T> {
}
/**
- * @return the size of the original (not paginated) List
+ * Returns the size of the original (not paginated) List.
*/
public int getTotalSize() {
return list.size();
diff --git a/src/main/java/de/thm/arsnova/web/exceptions/package-info.java b/src/main/java/de/thm/arsnova/web/exceptions/package-info.java
index 3a24af121..46d0486a8 100644
--- a/src/main/java/de/thm/arsnova/web/exceptions/package-info.java
+++ b/src/main/java/de/thm/arsnova/web/exceptions/package-info.java
@@ -1,5 +1,5 @@
/**
- * Contains exceptions used to return HTTP status codes
+ * Contains exceptions used to return HTTP status codes.
*/
package de.thm.arsnova.web.exceptions;
diff --git a/src/main/java/de/thm/arsnova/web/package-info.java b/src/main/java/de/thm/arsnova/web/package-info.java
index 92bdc3752..2407f2086 100644
--- a/src/main/java/de/thm/arsnova/web/package-info.java
+++ b/src/main/java/de/thm/arsnova/web/package-info.java
@@ -1,5 +1,5 @@
/**
- * Contains HTTP related classes and interfaces
+ * Contains application-wide HTTP/API related classes and interfaces.
*/
package de.thm.arsnova.web;
diff --git a/src/main/java/de/thm/arsnova/websocket/ArsnovaSocketioServer.java b/src/main/java/de/thm/arsnova/websocket/ArsnovaSocketioServer.java
index 220f12925..ac6edd91b 100644
--- a/src/main/java/de/thm/arsnova/websocket/ArsnovaSocketioServer.java
+++ b/src/main/java/de/thm/arsnova/websocket/ArsnovaSocketioServer.java
@@ -20,8 +20,6 @@ package de.thm.arsnova.websocket;
/**
* This interface is used to auto-wire the Socket Server.
- *
- * Extend this interface as you see fit.
*/
public interface ArsnovaSocketioServer {
diff --git a/src/main/java/de/thm/arsnova/websocket/message/package-info.java b/src/main/java/de/thm/arsnova/websocket/message/package-info.java
index 3f488a34d..c7336f52d 100644
--- a/src/main/java/de/thm/arsnova/websocket/message/package-info.java
+++ b/src/main/java/de/thm/arsnova/websocket/message/package-info.java
@@ -1,5 +1,5 @@
/**
- * Contains classes that are used as web socket messages
+ * Contains classes that are used as web socket messages.
*/
package de.thm.arsnova.websocket.message;
diff --git a/src/main/java/de/thm/arsnova/websocket/package-info.java b/src/main/java/de/thm/arsnova/websocket/package-info.java
index febedc2d5..065dea458 100644
--- a/src/main/java/de/thm/arsnova/websocket/package-info.java
+++ b/src/main/java/de/thm/arsnova/websocket/package-info.java
@@ -1,5 +1,5 @@
/**
- * Classes and interfaces for communication over web sockets
+ * Classes and interfaces for communication over web sockets.
*/
package de.thm.arsnova.websocket;
--
GitLab