Remove superfluous javadoc comments

Author: anderslindho

src/main/java/org/phoebus/channelfinder/ChannelManager.java

@@ -70,14 +70,6 @@ public class ChannelManager {
     @Autowired
     ChannelProcessorService channelProcessorService;
 
-    /**
-     * GET method for querying a collection of Channel instances, based on a
-     * multi-parameter query specifying patterns for tags, property values, and
-     * channel names to match against.
-     * 
-     * @param allRequestParams query parameters
-     * @return list of all channels
-     */
     @Operation(
         summary = "Query channels",
         description = "Query a collection of Channel instances based on tags, property values, and channel names.",
@@ -105,14 +97,6 @@ public List<Channel> query(@RequestParam MultiValueMap<String, String> allReques
         return channelRepository.search(allRequestParams).channels();
     }
 
-    /**
-     * GET method for querying for a collection of Channel instances, based on a
-     * multi-parameter query specifying patterns for tags, property values, and
-     * channel names to match against.
-     *
-     * @param allRequestParams query parameters
-     * @return SearchResult a count to the total number of matches and the first 10k hits
-     */
     @Operation(
         summary = "Combined query for channels",
         description = "Query for a collection of Channel instances and get a count and the first 10k hits.",
@@ -140,13 +124,6 @@ public SearchResult combinedQuery(@RequestParam MultiValueMap<String, String> al
         return channelRepository.search(allRequestParams);
     }
 
-    /**
-     * GET method for querying the number of matches to a multi-parameter query specifying patterns for tags, property values, and
-     * channel names to match against.
-     *
-     * @param allRequestParams query parameters
-     * @return a total number of channels that match the query parameters
-     */
     @Operation(
         summary = "Count channels matching query",
         description = "Get the number of channels matching the given query parameters.",
@@ -169,13 +146,6 @@ public long queryCount(@RequestParam MultiValueMap<String, String> allRequestPar
         return channelRepository.count(allRequestParams);
     }
 
-    /**
-     * GET method for retrieving an instance of Channel identified by
-     * <code>channelName</code>.
-     *
-     * @param channelName - channel name to search for
-     * @return found channel
-     */
     @Operation(
         summary = "Get channel by name",
         description = "Retrieve a Channel instance by its name.",
@@ -207,15 +177,6 @@ public Channel read(@PathVariable("channelName") String channelName) {
         }
     }
 
-    /**
-     * PUT method for creating/replacing a channel instance identified by the
-     * payload. The <b>complete</b> set of properties for the channel must be
-     * supplied, which will replace the existing set of properties.
-     *
-     * @param channelName - name of channel to be created 
-     * @param channel - new data (properties/tags) for channel <code>chan</code>
-     * @return the created channel
-     */
     @Operation(
         summary = "Create or replace a channel",
         description = "Create or replace a channel instance identified by the payload.",
@@ -279,12 +240,6 @@ public Channel create(@PathVariable("channelName") String channelName, @RequestB
         }
     }
 
-    /**
-     * PUT method for creating multiple channels.
-     *
-     * @param channels - XmlChannels to be created
-     * @return the list of channels created
-     */
     @Operation(
         summary = "Create or replace multiple channels",
         description = "Create or replace multiple channel instances.",
@@ -384,14 +339,6 @@ private void resetOwnersToExisting(Iterable<Channel> channels) {
         }
     }
 
-    /**
-     * POST method for merging properties and tags of the channel identified by the
-     * payload into an existing channel.
-     *
-     * @param channelName - name of channel to add
-     * @param channel - new Channel data (properties/tags) to be merged into channel <code>channelName</code>
-     * @return the updated channel         
-     */
     @Operation(
         summary = "Update a channel",
         description = "Merge properties and tags of the channel identified by the payload into an existing channel.",
@@ -470,13 +417,6 @@ public Channel update(@PathVariable("channelName") String channelName, @RequestB
         }
     }
 
-    /**
-     * POST method for merging properties and tags of the Channels identified by the
-     * payload into existing channels.
-     *
-     * @param channels - XmlChannels to be updated
-     * @return the updated channels
-     */
     @Operation(
         summary = "Update multiple channels",
         description = "Merge properties and tags of the channels identified by the payload into existing channels.",
@@ -546,12 +486,6 @@ public Iterable<Channel> update(@RequestBody Iterable<Channel> channels) {
         }
     }
 
-    /**
-     * DELETE method for deleting a channel instance identified by path parameter
-     * <code>channelName</code>.
-     *
-     * @param channelName - name of channel to remove
-     */
     @Operation(
         summary = "Delete a channel",
         description = "Delete a channel instance identified by its name.",

src/main/java/org/phoebus/channelfinder/ChannelScroll.java

@@ -55,14 +55,6 @@ public class ChannelScroll {
     @Qualifier("indexClient")
     ElasticsearchClient client;
 
-    /**
-     * GET method for retrieving a collection of Channel instances, based on a
-     * multi-parameter query specifying patterns for tags, property values, and
-     * channel names to match against.
-     *
-     * @param allRequestParams search parameters
-     * @return list of all channels
-     */
     @Operation(
         summary = "Scroll query for channels",
         description = "Retrieve a collection of Channel instances based on multi-parameter search.",
@@ -85,14 +77,6 @@ public Scroll query(@RequestParam MultiValueMap<String, String> allRequestParams
         return search(null, allRequestParams);
     }
 
-    /**
-     * GET method for retrieving a collection of Channel instances, based on a
-     * multi-parameter query specifying patterns for tags, property values, and
-     * channel names to match against.
-     *
-     * @param scrollId scroll Id
-     * @return list of all channels
-     */
     @Operation(
         summary = "Scroll query by scrollId",
         description = "Retrieve a collection of Channel instances using a scrollId and search parameters.",

src/main/java/org/phoebus/channelfinder/InfoManager.java

@@ -42,10 +42,6 @@ public class InfoManager {
 
     private static final ObjectMapper objectMapper = new ObjectMapper().enable(SerializationFeature.INDENT_OUTPUT);
 
-    /**
-     * 
-     * @return Information about the ChannelFinder service
-     */
     @Operation(
         summary = "Get ChannelFinder service info",
         description = "Returns information about the ChannelFinder service and its Elasticsearch backend.",

src/main/java/org/phoebus/channelfinder/PropertyManager.java

@@ -60,11 +60,6 @@ public class PropertyManager {
     @Autowired
     AuthorizationService authorizationService;
 
-    /**
-     * GET method for retrieving the list of properties in the database.
-     *
-     * @return list of all properties
-     */
     @Operation(
         summary = "List all properties",
         description = "Retrieve the list of all properties in the database.",
@@ -89,15 +84,6 @@ public Iterable<Property> list() {
         return propertyRepository.findAll();
     }
 
-    /**
-     * GET method for retrieving the property with the path parameter <code>propertyName</code> 
-     * <p>
-     * To get all its channels use the parameter "withChannels"
-     *
-     * @param propertyName - property name to search for
-     * @param withChannels - get the channels with the property
-     * @return found property
-     */
     @Operation(
         summary = "Get property by name",
         description = "Retrieve a property by its name. Optionally include its channels.",
@@ -135,18 +121,6 @@ public Property read(@PathVariable("propertyName") String propertyName,
         }
     }
 
-    /**
-     * PUT method for creating and <b>exclusively</b> adding the property
-     * identified by the path parameter <code>propertyName</code> to all channels
-     * identified by the payload structure <code>property</code>. Setting the owner
-     * attribute in the XML root element is mandatory. Values for the properties
-     * are taken from the payload.
-     *
-     *
-     * @param propertyName - name of property to be created
-     * @param property - an Property instance with the list of channels to add the property <code>propertyName</code> to
-     * @return the created property
-     */
     @Operation(
         summary = "Create or update a property",
         description = "Create and exclusively update the property identified by the path parameter.",
@@ -216,12 +190,6 @@ public Property create(@PathVariable("propertyName") String propertyName, @Reque
         }
     }
 
-    /**
-     * PUT method for creating multiple properties.
-     *
-     * @param properties - XmlProperties to be created
-     * @return the list of properties created
-     */
     @Operation(
         summary = "Create multiple properties",
         description = "Create multiple properties in a single request.",
@@ -292,18 +260,6 @@ public Iterable<Property> create(@RequestBody Iterable<Property> properties) {
         }
     }
 
-    /**
-     * PUT method for adding the property identified by <code>property</code> to the single
-     * channel <code>chan</code> (both path parameters).
-     * 
-     * TODO: could be simplified with multi index update and script which can use
-     * wildcards thus removing the need to explicitly define the entire property
-     * 
-     * @param propertyName - name of tag to be created
-     * @param channelName - channel to update <code>property</code> to
-     * @param property - property payload with value
-     * @return added property
-     */
     @Operation(
         summary = "Add property to a single channel",
         description = "Add the property identified by propertyName to the channel identified by channelName.",
@@ -374,16 +330,6 @@ public Property addSingle(@PathVariable("propertyName") String propertyName, @Pa
         }
     }
 
-    /**
-     * POST method for updating the property identified by the path parameter
-     * <code>propertyName</code>, adding it to all channels identified by the payload structure
-     * <code>property</code>. Setting the owner attribute in the XML root element is
-     * mandatory. Values for the properties are taken from the payload.
-     *
-     * @param propertyName - name of property to be updated
-     * @param property - a Property instance with the list of channels to add the property <code>propertyName</code> to
-     * @return the updated property
-     */
     @Operation(
         summary = "Update a property",
         description = "Update the property identified by the path parameter, adding it to all channels in the payload.",
@@ -498,18 +444,8 @@ public Property update(@PathVariable("propertyName") String propertyName, @Reque
         }
 
         return updatedProperty;
-
     }
 
-    /**
-     * POST method for updating multiple properties and updating all the appropriate
-     * channels.
-     *
-     * If the channels don't exist it will fail
-     *
-     * @param properties - XmlProperties to be updated
-     * @return the updated properties
-     */
     @Operation(
         summary = "Update multiple properties",
         description = "Update multiple properties and all appropriate channels.",
@@ -621,12 +557,6 @@ private void checkPropertyAuthorization(Optional<Property> existingProperty) {
         }
     }
 
-    /**
-     * DELETE method for deleting the property identified by the path parameter
-     * <code>propertyName</code> from all channels.
-     *
-     * @param propertyName - name of property to remove
-     */
     @Operation(
         summary = "Delete a property",
         description = "Delete the property identified by the path parameter from all channels.",
@@ -678,13 +608,6 @@ public void remove(@PathVariable("propertyName") String propertyName) {
         }
     }
 
-    /**
-     * DELETE method for deleting the property identified by <code>propertyName</code> from the
-     * channel <code>channelName</code> (both path parameters).
-     *
-     * @param propertyName - name of property to remove
-     * @param channelName - channel to remove <code>propertyName</code> from
-     */
     @Operation(
         summary = "Delete property from a channel",
         description = "Delete the property identified by propertyName from the channel identified by channelName.",