From 0cd7c71dc13c9dfe7578d9429239b76794e71293 Mon Sep 17 00:00:00 2001 From: Isaku Yamahata Date: Fri, 16 Dec 2016 18:08:10 -0800 Subject: [PATCH] checkstyle: enable JavadocParagraph Eliminate the violation of JavadocParagraph and enable it. Change-Id: I1f114f516d96bf0d3f5530d92e876b788cd73af6 Signed-off-by: Isaku Yamahata --- .../java/org/opendaylight/neutron/spi/NeutronFirewall.java | 1 + .../org/opendaylight/neutron/spi/NeutronFirewallPolicy.java | 1 + .../java/org/opendaylight/neutron/spi/NeutronFirewallRule.java | 1 + .../java/org/opendaylight/neutron/spi/NeutronLoadBalancer.java | 1 + .../neutron/spi/NeutronLoadBalancerHealthMonitor.java | 2 +- .../opendaylight/neutron/spi/NeutronLoadBalancerListener.java | 2 ++ .../org/opendaylight/neutron/spi/NeutronLoadBalancerPool.java | 1 + .../org/opendaylight/neutron/spi/NeutronSecurityGroup.java | 1 + .../java/org/opendaylight/neutron/spi/NeutronSecurityRule.java | 1 + .../neutron/northbound/api/BadRequestException.java | 1 + .../neutron/northbound/api/InternalServerErrorException.java | 1 + .../northbound/api/NeutronSecurityGroupsNorthbound.java | 1 + .../neutron/northbound/api/NeutronSecurityRulesNorthbound.java | 1 + .../neutron/northbound/api/ResourceConflictException.java | 1 + .../neutron/northbound/api/ResourceNotFoundException.java | 1 + .../neutron/northbound/api/ServiceUnavailableException.java | 1 + .../neutron/northbound/api/UnimplementedException.java | 1 + parent/checkstyle-suppressions.xml | 3 --- 18 files changed, 18 insertions(+), 4 deletions(-) diff --git a/neutron-spi/src/main/java/org/opendaylight/neutron/spi/NeutronFirewall.java b/neutron-spi/src/main/java/org/opendaylight/neutron/spi/NeutronFirewall.java index 565a23f5f..3417868f0 100644 --- a/neutron-spi/src/main/java/org/opendaylight/neutron/spi/NeutronFirewall.java +++ b/neutron-spi/src/main/java/org/opendaylight/neutron/spi/NeutronFirewall.java @@ -21,6 +21,7 @@ import javax.xml.bind.annotation.XmlRootElement; * v2.0 Reference for description of the fields: * Implemented fields are as follows: * + *

* id uuid-str * tenant_id uuid-str * name String diff --git a/neutron-spi/src/main/java/org/opendaylight/neutron/spi/NeutronFirewallPolicy.java b/neutron-spi/src/main/java/org/opendaylight/neutron/spi/NeutronFirewallPolicy.java index 872fef78d..12628a3dc 100644 --- a/neutron-spi/src/main/java/org/opendaylight/neutron/spi/NeutronFirewallPolicy.java +++ b/neutron-spi/src/main/java/org/opendaylight/neutron/spi/NeutronFirewallPolicy.java @@ -21,6 +21,7 @@ import javax.xml.bind.annotation.XmlRootElement; * v2.0 Reference for description of the fields. * The implemented fields are as follows: * + *

* id uuid-str * tenant_id uuid-str * name String diff --git a/neutron-spi/src/main/java/org/opendaylight/neutron/spi/NeutronFirewallRule.java b/neutron-spi/src/main/java/org/opendaylight/neutron/spi/NeutronFirewallRule.java index 360f9cb7c..83a625799 100644 --- a/neutron-spi/src/main/java/org/opendaylight/neutron/spi/NeutronFirewallRule.java +++ b/neutron-spi/src/main/java/org/opendaylight/neutron/spi/NeutronFirewallRule.java @@ -21,6 +21,7 @@ import javax.xml.bind.annotation.XmlRootElement; * v2.0 Reference for description of the fields. * The implemented fields are as follows: * + *

* tenant_id uuid-str * name String * admin_state_up Bool diff --git a/neutron-spi/src/main/java/org/opendaylight/neutron/spi/NeutronLoadBalancer.java b/neutron-spi/src/main/java/org/opendaylight/neutron/spi/NeutronLoadBalancer.java index 4f2503677..0c94ad73f 100644 --- a/neutron-spi/src/main/java/org/opendaylight/neutron/spi/NeutronLoadBalancer.java +++ b/neutron-spi/src/main/java/org/opendaylight/neutron/spi/NeutronLoadBalancer.java @@ -21,6 +21,7 @@ import javax.xml.bind.annotation.XmlRootElement; * v2.0 Reference for description of the fields: * Implemented fields are as follows: * + *

* id uuid-str * tenant_id uuid-str * name String diff --git a/neutron-spi/src/main/java/org/opendaylight/neutron/spi/NeutronLoadBalancerHealthMonitor.java b/neutron-spi/src/main/java/org/opendaylight/neutron/spi/NeutronLoadBalancerHealthMonitor.java index 19ba2dfd8..afd7d4140 100644 --- a/neutron-spi/src/main/java/org/opendaylight/neutron/spi/NeutronLoadBalancerHealthMonitor.java +++ b/neutron-spi/src/main/java/org/opendaylight/neutron/spi/NeutronLoadBalancerHealthMonitor.java @@ -21,7 +21,7 @@ import javax.xml.bind.annotation.XmlRootElement; * v2.0 Reference for description of the fields: * Implemented fields are as follows: * - * + *

* id uuid-str * tenant_id uuid-str * type String diff --git a/neutron-spi/src/main/java/org/opendaylight/neutron/spi/NeutronLoadBalancerListener.java b/neutron-spi/src/main/java/org/opendaylight/neutron/spi/NeutronLoadBalancerListener.java index e37b1e2d4..5324593aa 100644 --- a/neutron-spi/src/main/java/org/opendaylight/neutron/spi/NeutronLoadBalancerListener.java +++ b/neutron-spi/src/main/java/org/opendaylight/neutron/spi/NeutronLoadBalancerListener.java @@ -21,6 +21,7 @@ import javax.xml.bind.annotation.XmlRootElement; * v2.0 Reference for description of the fields: * Implemented fields are as follows: * + *

* id uuid-str * default_pool_id String * tenant_id uuid-str @@ -32,6 +33,7 @@ import javax.xml.bind.annotation.XmlRootElement; * admin_state_up Boolean * status String * + *

* http://docs.openstack.org/api/openstack-network/2.0/openstack-network.pdf */ diff --git a/neutron-spi/src/main/java/org/opendaylight/neutron/spi/NeutronLoadBalancerPool.java b/neutron-spi/src/main/java/org/opendaylight/neutron/spi/NeutronLoadBalancerPool.java index adba5d3f6..6bfebd5ce 100644 --- a/neutron-spi/src/main/java/org/opendaylight/neutron/spi/NeutronLoadBalancerPool.java +++ b/neutron-spi/src/main/java/org/opendaylight/neutron/spi/NeutronLoadBalancerPool.java @@ -22,6 +22,7 @@ import javax.xml.bind.annotation.XmlRootElement; * v2.0 Reference for description of the fields: * Implemented fields are as follows: * + *

* id uuid-str * tenant_id uuid-str * name String diff --git a/neutron-spi/src/main/java/org/opendaylight/neutron/spi/NeutronSecurityGroup.java b/neutron-spi/src/main/java/org/opendaylight/neutron/spi/NeutronSecurityGroup.java index 62c16df58..b36afe37c 100644 --- a/neutron-spi/src/main/java/org/opendaylight/neutron/spi/NeutronSecurityGroup.java +++ b/neutron-spi/src/main/java/org/opendaylight/neutron/spi/NeutronSecurityGroup.java @@ -18,6 +18,7 @@ import javax.xml.bind.annotation.XmlRootElement; * OpenStack Neutron v2.0 Security Group bindings. * See OpenStack Network API v2.0 Reference for description of * annotated attributes. The current fields are as follows: + * *

* id uuid-str unique ID for the security group. * name String name of the security group. diff --git a/neutron-spi/src/main/java/org/opendaylight/neutron/spi/NeutronSecurityRule.java b/neutron-spi/src/main/java/org/opendaylight/neutron/spi/NeutronSecurityRule.java index 1f16ea7de..ba792fd56 100644 --- a/neutron-spi/src/main/java/org/opendaylight/neutron/spi/NeutronSecurityRule.java +++ b/neutron-spi/src/main/java/org/opendaylight/neutron/spi/NeutronSecurityRule.java @@ -18,6 +18,7 @@ import javax.xml.bind.annotation.XmlRootElement; /** * See OpenStack Network API v2.0 Reference for description of * annotated attributes. The current fields are as follows: + * *

* id uuid (String) UUID for the security group rule. * direction String Direction the VM traffic (ingress/egress). diff --git a/northbound-api/src/main/java/org/opendaylight/neutron/northbound/api/BadRequestException.java b/northbound-api/src/main/java/org/opendaylight/neutron/northbound/api/BadRequestException.java index 3836fb482..7e1e03668 100644 --- a/northbound-api/src/main/java/org/opendaylight/neutron/northbound/api/BadRequestException.java +++ b/northbound-api/src/main/java/org/opendaylight/neutron/northbound/api/BadRequestException.java @@ -15,6 +15,7 @@ import javax.ws.rs.core.Response; /** * Status Code 400 (Bad Request) * + *

* The request could not be understood by the server due to malformed syntax. * The client SHOULD NOT repeat the request without modifications. */ diff --git a/northbound-api/src/main/java/org/opendaylight/neutron/northbound/api/InternalServerErrorException.java b/northbound-api/src/main/java/org/opendaylight/neutron/northbound/api/InternalServerErrorException.java index b924baf1a..1a7e6a646 100644 --- a/northbound-api/src/main/java/org/opendaylight/neutron/northbound/api/InternalServerErrorException.java +++ b/northbound-api/src/main/java/org/opendaylight/neutron/northbound/api/InternalServerErrorException.java @@ -15,6 +15,7 @@ import javax.ws.rs.core.Response; /** * Status Code 500 (Internal Server Error) * + *

* The server encountered an unexpected condition which prevented * it from fulfilling the request. * diff --git a/northbound-api/src/main/java/org/opendaylight/neutron/northbound/api/NeutronSecurityGroupsNorthbound.java b/northbound-api/src/main/java/org/opendaylight/neutron/northbound/api/NeutronSecurityGroupsNorthbound.java index d3c034e09..f6bc7fa08 100644 --- a/northbound-api/src/main/java/org/opendaylight/neutron/northbound/api/NeutronSecurityGroupsNorthbound.java +++ b/northbound-api/src/main/java/org/opendaylight/neutron/northbound/api/NeutronSecurityGroupsNorthbound.java @@ -30,6 +30,7 @@ import org.opendaylight.neutron.spi.NeutronSecurityGroup; /** * Neutron Northbound REST APIs for Security Group.
* This class provides REST APIs for managing neutron Security Group + * *

*
*
diff --git a/northbound-api/src/main/java/org/opendaylight/neutron/northbound/api/NeutronSecurityRulesNorthbound.java b/northbound-api/src/main/java/org/opendaylight/neutron/northbound/api/NeutronSecurityRulesNorthbound.java index 5c23ca257..eb28af722 100644 --- a/northbound-api/src/main/java/org/opendaylight/neutron/northbound/api/NeutronSecurityRulesNorthbound.java +++ b/northbound-api/src/main/java/org/opendaylight/neutron/northbound/api/NeutronSecurityRulesNorthbound.java @@ -30,6 +30,7 @@ import org.opendaylight.neutron.spi.NeutronSecurityRule; /** * Neutron Northbound REST APIs for Security Rule.
* This class provides REST APIs for managing neutron Security Rule + * *

*
*
diff --git a/northbound-api/src/main/java/org/opendaylight/neutron/northbound/api/ResourceConflictException.java b/northbound-api/src/main/java/org/opendaylight/neutron/northbound/api/ResourceConflictException.java index a951be21e..b2af96355 100644 --- a/northbound-api/src/main/java/org/opendaylight/neutron/northbound/api/ResourceConflictException.java +++ b/northbound-api/src/main/java/org/opendaylight/neutron/northbound/api/ResourceConflictException.java @@ -15,6 +15,7 @@ import javax.ws.rs.core.Response; /** * Status Code 409 (Conflict) * + *

* The request could not be completed due to a conflict with the * current state of the resource. This code is only allowed in * situations where it is expected that the user might be able to diff --git a/northbound-api/src/main/java/org/opendaylight/neutron/northbound/api/ResourceNotFoundException.java b/northbound-api/src/main/java/org/opendaylight/neutron/northbound/api/ResourceNotFoundException.java index 8952a45fc..5a0754512 100644 --- a/northbound-api/src/main/java/org/opendaylight/neutron/northbound/api/ResourceNotFoundException.java +++ b/northbound-api/src/main/java/org/opendaylight/neutron/northbound/api/ResourceNotFoundException.java @@ -15,6 +15,7 @@ import javax.ws.rs.core.Response; /** * Status Code 404 (Not Found) * + *

* The server has not found anything matching the Request-URI. * No indication is given of whether the condition is temporary or permanent. * The 410 (Gone) status code SHOULD be used if the server knows, diff --git a/northbound-api/src/main/java/org/opendaylight/neutron/northbound/api/ServiceUnavailableException.java b/northbound-api/src/main/java/org/opendaylight/neutron/northbound/api/ServiceUnavailableException.java index 6ed2647bd..fde2f512f 100644 --- a/northbound-api/src/main/java/org/opendaylight/neutron/northbound/api/ServiceUnavailableException.java +++ b/northbound-api/src/main/java/org/opendaylight/neutron/northbound/api/ServiceUnavailableException.java @@ -15,6 +15,7 @@ import javax.ws.rs.core.Response; /** * Status Code 503 (Service Unavailable Error) * + *

* The server is currently unable to handle the request due to a temporary * overloading or maintenance of the server. * The implication is that this is a temporary condition which will be alleviated diff --git a/northbound-api/src/main/java/org/opendaylight/neutron/northbound/api/UnimplementedException.java b/northbound-api/src/main/java/org/opendaylight/neutron/northbound/api/UnimplementedException.java index a6ff0024e..914a4e91c 100644 --- a/northbound-api/src/main/java/org/opendaylight/neutron/northbound/api/UnimplementedException.java +++ b/northbound-api/src/main/java/org/opendaylight/neutron/northbound/api/UnimplementedException.java @@ -16,6 +16,7 @@ import javax.ws.rs.core.Response; /** * Status Code 501 (Not Implemented Error) * + *

* The function is not implemented. * */ diff --git a/parent/checkstyle-suppressions.xml b/parent/checkstyle-suppressions.xml index 461aaa125..2fca401a6 100644 --- a/parent/checkstyle-suppressions.xml +++ b/parent/checkstyle-suppressions.xml @@ -12,9 +12,6 @@ - -- 2.36.6