fix doclint errors (#46)

Author: Crim

README.md

@@ -1,5 +1,7 @@
 # Kafka WebView
 
+[![Build Status](https://travis-ci.org/SourceLabOrg/kafka-webview.svg?branch=master)](https://travis-ci.org/SourceLabOrg/kafka-webview)
+
 This project aims to be a full-featured web-based [Apache Kafka](https://kafka.apache.org/) consumer.  **Kafka WebView** presents an easy-to-use web based interface for reading data out of kafka topics and providing basic filtering and searching capabilities.
 
 ### Features

kafka-webview-ui/pom.xml

@@ -103,6 +103,12 @@
             <artifactId>spring-boot-starter-actuator</artifactId>
         </dependency>
 
+        <dependency>
+            <groupId>javax.interceptor</groupId>
+            <artifactId>javax.interceptor-api</artifactId>
+            <version>1.2.1</version>
+        </dependency>
+
         <!-- Allows for auto-reloading resources -->
         <dependency>
             <groupId>org.springframework.boot</groupId>

kafka-webview-ui/src/main/java/org/sourcelab/kafka/webview/ui/configuration/PluginConfig.java

@@ -44,6 +44,8 @@ public class PluginConfig {
 
     /**
      * Upload manager, for handling uploads of Plugins and Keystores.
+     * @param appProperties Definition of app properties.
+     * @return UploadManager for Plugins
      */
     @Bean
     public UploadManager getPluginUploadManager(final AppProperties appProperties) {
@@ -52,6 +54,8 @@ public UploadManager getPluginUploadManager(final AppProperties appProperties) {
 
     /**
      * PluginFactory for creating instances of Deserializers.
+     * @param appProperties Definition of app properties.
+     * @return PluginFactory for Deserializers.
      */
     @Bean
     public PluginFactory<Deserializer> getDeserializerPluginFactory(final AppProperties appProperties) {
@@ -61,6 +65,8 @@ public PluginFactory<Deserializer> getDeserializerPluginFactory(final AppPropert
 
     /**
      * PluginFactory for creating instances of Record Filters.
+     * @param appProperties Definition of app properties.
+     * @return PluginFactory for Record Filters.
      */
     @Bean
     public PluginFactory<RecordFilter> getRecordFilterPluginFactory(final AppProperties appProperties) {
@@ -70,6 +76,8 @@ public PluginFactory<RecordFilter> getRecordFilterPluginFactory(final AppPropert
 
     /**
      * For handling secrets, symmetrical encryption.
+     * @param appProperties Definition of app properties.
+     * @return SecretManager
      */
     @Bean
     public SecretManager getSecretManager(final AppProperties appProperties) {
@@ -78,6 +86,8 @@ public SecretManager getSecretManager(final AppProperties appProperties) {
 
     /**
      * For creating Kafka Consumers.
+     * @param appProperties Definition of app properties.
+     * @return Web Kafka Consumer Factory instance.
      */
     @Bean
     public WebKafkaConsumerFactory getWebKafkaConsumerFactory(final AppProperties appProperties) {
@@ -91,6 +101,8 @@ public WebKafkaConsumerFactory getWebKafkaConsumerFactory(final AppProperties ap
 
     /**
      * For creating Kafka operational consumers.
+     * @param appProperties Definition of app properties.
+     * @return Web Kafka Operations Client Factory instance.
      */
     @Bean
     public KafkaOperationsFactory getKafkaOperationsFactory(final AppProperties appProperties) {

kafka-webview-ui/src/main/java/org/sourcelab/kafka/webview/ui/configuration/WebSocketConfig.java

@@ -71,6 +71,7 @@ public PresenceEventListener presenceEventListener(final WebSocketConsumersManag
     /**
      * This thread runs the WebSocketConsumerManager, which manages any consumers for web sockets.
      * It only needs a single thread, because the manager starts up its own managed thread pool.
+     * @return new ThreadPool Task executor.
      */
     @Bean
     public TaskExecutor backgroundConsumerExecutor() {
@@ -86,6 +87,11 @@ public TaskExecutor backgroundConsumerExecutor() {
 
     /**
      * Manages kafka consumers running in a background processing thread for websocket consumers.
+     * @param webKafkaConsumerFactory Factory for creating new Consumers
+     * @param messagingTemplate messaging template instance for passing websocket messages.
+     * @param backgroundConsumerExecutor The executor to run our manager in.
+     * @param appProperties defined app properties.
+     * @return manager instance for web socket consumers.
      */
     @Bean
     public WebSocketConsumersManager getWebSocketConsumersManager(

kafka-webview-ui/src/main/java/org/sourcelab/kafka/webview/ui/manager/kafka/SocketKafkaConsumer.java

@@ -228,7 +228,7 @@ private void seekToTimestamp(final long timestamp) {
 
     /**
      * Seek to the specified offsets.
-     * @param partitionOffsetMap Map of PartitionId => Offset to seek to.
+     * @param partitionOffsetMap Map of PartitionId to Offset to seek to.
      * @return ConsumerState representing the consumer's positions.
      */
     private void seek(final Map<TopicPartition, Long> partitionOffsetMap) {

kafka-webview-ui/src/main/java/org/sourcelab/kafka/webview/ui/manager/kafka/WebKafkaConsumer.java

@@ -132,7 +132,7 @@ public KafkaResults consumePerPartition() {
 
     /**
      * Seek to the specified offsets.
-     * @param partitionOffsetMap Map of PartitionId => Offset to seek to.
+     * @param partitionOffsetMap Map of PartitionId to Offset to seek to.
      * @return ConsumerState representing the consumer's positions.
      */
     public ConsumerState seek(final Map<Integer, Long> partitionOffsetMap) {

kafka-webview-ui/src/main/java/org/sourcelab/kafka/webview/ui/manager/socket/StartingPosition.java

@@ -148,7 +148,7 @@ public static StartingPosition newPositionFromTimestamp(final long timestamp) {
     }
 
     /**
-     * @param offsets Maps from Partition => Offset.  Any not supplied offsets will resume from HEAD.
+     * @param offsets Maps from Partition to Offset.  Any not supplied offsets will resume from HEAD.
      * @return New StartingPosition instance configured to start from the supplied offsets map.
      */
     public static StartingPosition newPositionFromOffsets(final Map<Integer, Long> offsets) {

kafka-webview-ui/src/main/java/org/sourcelab/kafka/webview/ui/manager/socket/WebSocketConsumersManager.java

@@ -54,7 +54,7 @@ public class WebSocketConsumersManager implements Runnable {
     private static final Logger logger = LoggerFactory.getLogger(WebSocketConsumersManager.class);
 
     /**
-     * Holds a map of ConsumerKey => ConsumerEntry, which is basically a container
+     * Holds a map of ConsumerKey to ConsumerEntry, which is basically a container
      * for the running consumers.
      */
     private final Map<ConsumerKey, ConsumerEntry> consumers = new ConcurrentHashMap<>();

kafka-webview-ui/src/main/java/org/sourcelab/kafka/webview/ui/repository/ClusterRepository.java

@@ -35,14 +35,14 @@
 public interface ClusterRepository extends CrudRepository<Cluster, Long> {
     /**
      * Find cluster by name.
+     * @param name Name of cluster to retrieve.
+     * @return the Cluster instance, or null if none found.
      */
     Cluster findByName(final String name);
 
     /**
      * Retrieve all clusters ordered by name.
+     * @return all clusters ordered by name.
      */
     Iterable<Cluster> findAllByOrderByNameAsc();
-
-//    @Query(value = "SELECT * FROM location l where l.user_id = :userId order by id desc limit :limit", nativeQuery = true)
-//    List<Location> findLatest(@Param("userId") final long userId, @Param("limit") final int limit);
 }

kafka-webview-ui/src/main/java/org/sourcelab/kafka/webview/ui/repository/FilterRepository.java

@@ -35,11 +35,14 @@
 public interface FilterRepository extends CrudRepository<Filter, Long> {
     /**
      * Retrieve a Filter by the Name field.
+     * @param name Name of filter to retrieve.
+     * @return Filter, or null of none found.
      */
     Filter findByName(final String name);
 
     /**
      * Retrieve all Filters ordered by Name.
+     * @return all filters ordered by name.
      */
     Iterable<Filter> findAllByOrderByNameAsc();
 }