updated travisCI towards javadoc automation

Author: Christian Zirkelbach

.travis.yml

@@ -39,11 +39,10 @@ jobs:
     - stage: documentation
       name: "Publish documentation"
       if: (branch = master)
-      script: .travis/javadoc-push.sh
+      script: ./gradlew alljavadoc && chmod +x .travis/javadoc-push.sh && .travis/javadoc-push.sh
 
 before_script:
   - chmod +x .travis/docker_push.sh
-  - chmod +x .travis/javadoc-push.sh
 
 branches:
   only:

authentication/src/main/java/net/explorviz/security/server/resources/TokenResource.java

@@ -65,6 +65,7 @@ public User issueToken(final UserCredentials credentials) {
    * This method refreshes a Json Web Token (JWT). The HTTP POST body must not contain data and the
    * to-be refreshed token inside of the ' Authorization: Bearer' header.
    *
+   * @param context - the context of the container
    * @return Refreshed JWT with an incremented refresh counter.
    */
   @POST

authentication/src/main/java/net/explorviz/security/server/resources/UserResource.java

@@ -145,12 +145,11 @@ public List<User> createAll(final List<User> users) {
 
   /**
    * Updates the details of a already existing user. The values of the targeted user will be
-   * overridden by the values of {@linkplain updatedUser}. All attributes that are {@code null} are
-   * ignored.
+   * overridden by the values of an updatedUser. All attributes that are {@code null} are ignored.
    *
-   * @param id the id of the user to update
-   * @param updatedUser a {@link User} object containing the changes. All fields set to {@code null}
-   *        will be ignored when updating.
+   * @param id - the id of the user to update
+   * @param updatedUser - a {@link User} object containing the changes. All fields set to
+   *        {@code null} will be ignored when updating.
    * @return the updated user
    */
   @PATCH
@@ -230,7 +229,7 @@ public User updateUser(@PathParam("id") final Long id, final User updatedUser) {
   /**
    * Retrieves all users that have a specific role.
    *
-   * @param role the role to be searched for
+   * @param role - the role to be searched for
    * @return a list of all users with the given role
    */
   @GET
@@ -256,7 +255,7 @@ public List<User> usersByRole(@QueryParam("role") final String role) {
   /**
    * Retrieves a single user identified by its id.
    *
-   * @param id the id of the user to return
+   * @param id - the id of the user to return
    * @return the {@link User} object with the given id
    */
   @GET
@@ -287,7 +286,8 @@ public User userById(@PathParam("id") final Long id) {
   /**
    * Removes the user with the given id.
    *
-   * @param id the id of the user to delete
+   * @param id - the id of the user to delete
+   * @return a response on success
    */
   @DELETE
   @Path("{id}")

authentication/src/main/java/net/explorviz/security/services/MongoCrudService.java

@@ -14,22 +14,23 @@ public interface MongoCrudService<T> {
   /**
    * Persists a new entity object.
    *
-   * @param entity the entity to persist
+   * @param entity - the entity to persist
+   * @return optional - found entity
    */
   Optional<T> saveNewEntity(final T entity);
 
 
   /**
    * Updates values of an existing entity.
    *
-   * @param entity the entity to update
+   * @param entity - the entity to update
    */
   void updateEntity(final T entity);
 
   /**
    * Retrieves an entity by its id.
    *
-   * @param id the id of the entity to find
+   * @param id - the id of the entity to find
    * @return optional the entity with the given id
    */
   Optional<T> getEntityById(final Long id);
@@ -46,16 +47,16 @@ public interface MongoCrudService<T> {
   /**
    * Deletes an entity.
    *
-   * @param id the id of the entity to delete
+   * @param id - the id of the entity to delete
    */
   void deleteEntityById(final Long id);
 
 
   /**
    * Retrieves an entity by a field and its value.
    *
-   * @param field name of the entity
-   * @param value for the field
+   * @param field - name of the entity
+   * @param value - value for the field
    * @return optional - found entity
    */
   Optional<T> findEntityByFieldValue(String field, Object value);

authentication/src/main/java/net/explorviz/security/services/UserMongoCrudService.java

@@ -1,7 +1,6 @@
 package net.explorviz.security.services;
 
 import com.mongodb.MongoException;
-import java.util.ArrayList;
 import java.util.List;
 import java.util.Optional;
 import java.util.stream.Collectors;
@@ -36,10 +35,10 @@ public class UserMongoCrudService implements MongoCrudService<User> {
   private final Datastore datastore;
 
 
-
   /**
-   * Creates a new {@code UserCrudMongoDb}.
+   * Creates a new UserMongoDB
    *
+   * @param datastore - the datastore instance
    */
   @Inject
   public UserMongoCrudService(final Datastore datastore) {
@@ -65,12 +64,16 @@ public List<User> getAll() {
   }
 
   @Override
+  /**
+   * Persists an user entity
+   *
+   * @param user - a user entity
+   * @return an Optional, which contains a User or is empty
+   */
   public Optional<User> saveNewEntity(final User user) throws MongoException {
     // Generate an id
     user.setId(this.idGen.next());
 
-
-
     this.datastore.save(user);
 
     if (LOGGER.isInfoEnabled()) {
@@ -124,8 +127,6 @@ public List<User> getUsersByRole(final String roleName) throws MongoException {
 
     final Role role = this.datastore.createQuery(Role.class).filter("descriptor", roleName).get();
 
-    final List<User> listToBeReturned = new ArrayList<>();
-
     List<User> userList = this.datastore.createQuery(User.class).asList();
 
     userList =

build.gradle

@@ -2,6 +2,23 @@ allprojects {
   apply plugin: 'java-library'
 }
 
+
+// Aggregate Javadoc in multiproject Gradle build
+def exportedProjects= [
+		':shared', 
+		':landscape',
+		':kiekeradapter',
+		':authentication',
+		':analysis',
+		':discovery'
+]
+
+task alljavadoc(type: Javadoc) {
+    source exportedProjects.collect { project(it).sourceSets.main.allJava }
+    classpath = files(exportedProjects.collect { project(it).sourceSets.main.compileClasspath })
+    destinationDir = file("${buildDir}/docs/javadoc")
+}
+
 subprojects {
 
   // BEGIN QA Tooling for subprojects

landscape/src/main/java/net/explorviz/landscape/model/application/Trace.java

@@ -7,7 +7,8 @@
 import net.explorviz.landscape.model.helper.BaseEntity;
 
 /**
- * Model representing a trace containing severals {@link TraceStep} between two {@link Clazz}.
+ * Model representing a trace containing severals {@link TraceStep} between two
+ * {@link net.explorviz.landscape.model.application.Clazz}.
  */
 @SuppressWarnings("serial")
 @Type("trace")
@@ -32,13 +33,12 @@ public Trace(final String traceId) {
   /**
    * Adds a new call within a trace as a {@link TraceStep}
    *
-   * @param traceId
-   * @param tracePosition
-   * @param requests
-   * @param averageResponseTime
-   * @param currentTraceDuration
-   * @param clazzCommunication
-   * @return TraceStep
+   * @param tracePosition - position within the trace
+   * @param requests - total number of requests
+   * @param averageResponseTime - average response time of the trace
+   * @param currentTraceDuration - current duration of the trace
+   * @param clazzCommunication - starting clazzCommunication
+   * @return a new TraceStep
    */
   public TraceStep addTraceStep(final int tracePosition, final int requests,
       final float averageResponseTime, final float currentTraceDuration,

landscape/src/main/java/net/explorviz/landscape/model/application/TraceStep.java

@@ -6,7 +6,7 @@
 
 /**
  * Model representing detailed runtime information for {@link ClazzCommunication} between two
- * {@link Clazz} in a specific {@link Trace}.
+ * {@link net.explorviz.landscape.model.application.Clazz} in a specific {@link Trace}.
  */
 @SuppressWarnings("serial")
 @Type("tracestep")
@@ -31,11 +31,14 @@ public class TraceStep extends BaseEntity {
   /**
    * Creates a new TraceStep and assigns related communication information
    *
-   * @param clazzCommunication
-   * @param currentTraceDuration
-   * @param averageResponseTime
-   * @param requests
-   * @param tracePosition
+   * @param parentTrace - related Trace
+   * @param clazzCommunication - starting clazzCommunication
+   * @param tracePosition - position within the trace
+   * @param requests - total number of requests
+   * @param averageResponseTime - average response time of the trace
+   * @param currentTraceDuration - current duration of the trace
+   *
+   * 
    */
   public TraceStep(final Trace parentTrace, final ClazzCommunication clazzCommunication,
       final int tracePosition, final int requests, final float averageResponseTime,

landscape/src/main/java/net/explorviz/landscape/model/store/helper/TimestampHelper.java

@@ -16,7 +16,7 @@ private TimestampHelper() {
   }
 
   /**
-   * Retrieves timestamps AFTER a passed {@link Timestamp}.
+   * Retrieves timestamps AFTER a passed {@link net.explorviz.landscape.model.store.Timestamp}.
    *
    * @param allTimestamps - All timestamps within the system
    * @param afterTimestamp - Define the timestamp which sets the limit
@@ -58,8 +58,9 @@ public static List<Timestamp> filterTimestampsAfterTimestamp(final List<Timestam
    * Retrieves the a passed {@link Timestamp} within a list of timestamps if found, otherwise the
    * following timestamp.
    *
-   * @param timestamps
-   * @param searchedTimestamp
+   * @param timestamps - a list of timestamps
+   * @param searchedTimestamp - a specific timestamp to be found
+   * @return a retrieved timestamp
    */
   public static Timestamp getTimestampPosition(final List<Timestamp> timestamps,
       final long searchedTimestamp) {

landscape/src/main/java/net/explorviz/landscape/repository/RepositoryStorage.java

@@ -70,7 +70,7 @@ private RepositoryStorage() {
   /**
    * Registers all classes for serialization
    *
-   * @return
+   * @return an FST configuration
    */
   public static FSTConfiguration createFSTConfiguration() {
     final FSTConfiguration result = FSTConfiguration.createDefaultConfiguration();