修改部分注释以满足javadoc的要求

saleson · saleson · commit c2ca551e1ffb · 2018-05-03T17:04:06.000+08:00
diff --git a/spring-cloud-bamboo/src/main/java/cn/springcloud/bamboo/LoadBalanceRequestTrigger.java b/spring-cloud-bamboo/src/main/java/cn/springcloud/bamboo/LoadBalanceRequestTrigger.java
@@ -9,15 +9,15 @@ public interface LoadBalanceRequestTrigger {
     /**
      * 判断是否需要执行的方法
      *
-     * @return
+     * @return boolean
      */
     boolean shouldExecute();
 
 
     /**
      * 请求之前执行
      *
-     * @param connectPointContext
+     * @param connectPointContext 连接点上下文
      */
     void before(ConnectPointContext connectPointContext);
 
@@ -26,7 +26,7 @@ public interface LoadBalanceRequestTrigger {
      * 请求完成之后执行
      * 如果出现异常，该方法依然会被执行
      *
-     * @param connectPointContext
+     * @param connectPointContext 连接点上下文
      */
     void after(ConnectPointContext connectPointContext);
 }
diff --git a/spring-cloud-bamboo/src/main/java/cn/springcloud/bamboo/ribbon/EurekaServerExtractor.java b/spring-cloud-bamboo/src/main/java/cn/springcloud/bamboo/ribbon/EurekaServerExtractor.java
@@ -31,9 +31,9 @@ public ServerIntrospector serverIntrospector(String serviceId) {
     /**
      * 获取实例的metadata信息
      *
-     * @param serviceId
-     * @param server
-     * @return
+     * @param serviceId 服务id
+     * @param server ribbon服务器(服务实例)
+     * @return 服务实例的metadata信息
      */
     public Map<String, String> getServerMetadata(String serviceId, Server server) {
         return serverIntrospector(serviceId).getMetadata(server);
diff --git a/spring-cloud-bamboo/src/main/java/cn/springcloud/bamboo/utils/WebUtils.java b/spring-cloud-bamboo/src/main/java/cn/springcloud/bamboo/utils/WebUtils.java
@@ -15,9 +15,10 @@ public class WebUtils {
     private static final Logger log = LoggerFactory.getLogger(WebUtils.class);
 
     /**
+     * url query 转换成map
      *
-     * @param urlQuery
-     * @return
+     * @param urlQuery url query信息,如"a=1&amp;b=2&amp;c=3"
+     * @return 转换后的map
      */
     public static Map<String, List<String>> getQueryParams(String urlQuery) {
         Map<String, List<String>> qp = new HashMap<String, List<String>>();
@@ -71,7 +72,6 @@ public static Map<String, List<String>> getQueryParams(String urlQuery) {
     }
 
 
-
     /**
      * <p>
      * 获取客户端的IP地址的方法是：request.getRemoteAddr()，这种方法在大部分情况下都是有效的。
@@ -82,8 +82,8 @@ public static Map<String, List<String>> getQueryParams(String urlQuery) {
      * 192.168.1.100 用户真实IP为： 192.168.1.110
      * </p>
      *
-     * @param request
-     * @return
+     * @param request HttpServletRequest
+     * @return 请求方的ip
      */
     public static String getIpAddr(HttpServletRequest request) {
         String ip = request.getHeader("x-forwarded-for");
diff --git a/spring-cloud-gray-client/src/main/java/cn/springcloud/gray/client/GrayClientConfig.java b/spring-cloud-gray-client/src/main/java/cn/springcloud/gray/client/GrayClientConfig.java
@@ -6,45 +6,45 @@ public interface GrayClientConfig {
     /**
      * 启动时是否灰度注册
      *
-     * @return
+     * @return boolean
      */
     boolean isGrayEnroll();
 
     /**
      * 向灰度服务器注册的延迟时间(ms)
      *
-     * @return
+     * @return 返回灰度服务器注册的延迟时间(ms)
      */
     int grayEnrollDealyTimeInMs();
 
 
     /**
      * 灰度服务器的url
      *
-     * @return
+     * @return 返回gray-server的url
      */
     String getServerUrl();
 
 
     /**
      * 更新灰度列表的时间间隔(ms)
      *
-     * @return
+     * @return 返回更新灰度列表的时间间隔(ms)
      */
     int getServiceUpdateIntervalTimerInMs();
 
 
     /**
      * 在和灰度服务器通信时，如果交互失败，是否重试。
      *
-     * @return
+     * @return 返回是否重试
      */
     boolean isRetryable();
 
     /**
      * 重试次数
      *
-     * @return
+     * @return 返回重试次数
      */
     int getRetryNumberOfRetries();
 
diff --git a/spring-cloud-gray-core/src/main/java/cn/springcloud/gray/core/GrayServiceManager.java b/spring-cloud-gray-core/src/main/java/cn/springcloud/gray/core/GrayServiceManager.java
@@ -30,20 +30,20 @@ public interface GrayServiceManager {
     /**
      * 更新实例实例灰度状态
      *
-     * @param serviceId
-     * @param instanceId
+     * @param serviceId 服务id
+     * @param instanceId 实例id
      * @param status     0:关闭, 1:启用
-     * @return
+     * @return boolean
      */
     boolean updateInstanceStatus(String serviceId, String instanceId, int status);
 
 
     /**
      * 更新实例策略组启用状态
      *
-     * @param serviceId
-     * @param instanceId
-     * @param groupId
+     * @param serviceId 服务id
+     * @param instanceId 实例id
+     * @param groupId 灰度策略组id
      * @param enable     0:关闭, 1:启用
      */
     boolean updatePolicyGroupStatus(String serviceId, String instanceId, String groupId, int enable);
diff --git a/spring-cloud-gray-core/src/main/java/cn/springcloud/gray/core/InformationClient.java b/spring-cloud-gray-core/src/main/java/cn/springcloud/gray/core/InformationClient.java
@@ -13,34 +13,34 @@ public interface InformationClient {
     /**
      * 返回在灰度中注册的所有实例(包括非灰度实例)
      *
-     * @return
+     * @return 类度服务列表
      */
     List<GrayService> listGrayService();
 
     /**
      * 根据serviceId返回灰度服务对象
      *
-     * @param serviceId
-     * @return
+     * @param serviceId 服务id
+     * @return 灰度服务
      */
     GrayService grayService(String serviceId);
 
 
     /**
      * 返回注册的实例对象
      *
-     * @param serviceId
-     * @param instanceId
-     * @return
+     * @param serviceId 服务id
+     * @param instanceId 实例id
+     * @return 灰度实例
      */
     GrayInstance grayInstance(String serviceId, String instanceId);
 
 
     /**
      * 注册灰度实例
      *
-     * @param serviceId
-     * @param instanceId
+     * @param serviceId 服务id
+     * @param instanceId 实例id
      */
     void addGrayInstance(String serviceId, String instanceId);
 
@@ -54,8 +54,8 @@ public interface InformationClient {
     /**
      * 灰度实例下线
      *
-     * @param serviceId
-     * @param instanceId
+     * @param serviceId 服务id
+     * @param instanceId 实例id
      */
     void serviceDownline(String serviceId, String instanceId);
 
diff --git a/spring-cloud-gray-server/src/main/java/cn/springcloud/gray/server/config/Swagger2Configuration.java b/spring-cloud-gray-server/src/main/java/cn/springcloud/gray/server/config/Swagger2Configuration.java
@@ -41,12 +41,16 @@ public void addViewControllers(ViewControllerRegistry registry) {
 
     /**
      * 这个地方要重新注入一下资源文件，不然不会注入资源的，也没有注入requestHandlerMappping,相当于xml配置的
+     * <pre>
+     * {@code
      * <!--swagger资源配置-->
      * <mvc:resources location="classpath:/META-INF/resources/" mapping="swagger-ui.html"/>
      * <mvc:resources location="classpath:/META-INF/resources/webjars/" mapping="/webjars/**"/>
+     * }
+     * </pre>
      * 不知道为什么，这也是spring boot的一个缺点（菜鸟觉得的）
      *
-     * @param registry
+     * @param registry ResourceHandlerRegistry
      */
     @Override
     public void addResourceHandlers(ResourceHandlerRegistry registry) {
@@ -114,10 +118,10 @@ public Docket createRestApi() {
 
     private ApiInfo apiInfo() {
         return new ApiInfoBuilder()
-                .title("Spring Boot中使用Swagger2构建RESTful APIs")
-                .description("相关文章请关注：http://www.baidu.com/")
-                .termsOfServiceUrl("http://www.baidu.com")
-                .version("1.0")
+                .title("spring cloud gray server接口列表")
+                .description("相关信息请关注：https://github.com/SpringCloud/spring-cloud-gray")
+                .termsOfServiceUrl("https://github.com/SpringCloud/spring-cloud-gray")
+//                .version("1.0.0")
                 .build();
     }
 
@@ -163,8 +167,7 @@ List<SecurityReference> defaultAuth() {
     /**
      * 自定义返回信息
      *
-     * @param
-     * @return
+     * @return 返回消息列表
      */
     private List<ResponseMessage> customerResponseMessage() {
 
diff --git a/spring-cloud-gray-server/src/main/java/cn/springcloud/gray/server/resources/rest/ServiceGrayResouce.java b/spring-cloud-gray-server/src/main/java/cn/springcloud/gray/server/resources/rest/ServiceGrayResouce.java
@@ -39,7 +39,7 @@ public class ServiceGrayResouce {
     /**
      * 返回所有服务
      *
-     * @return
+     * @return 灰度服务VO集合
      */
     @RequestMapping(value = "/services", method = RequestMethod.GET)
     public ResponseEntity<List<GrayServiceVO>> services() {
@@ -66,8 +66,8 @@ public ResponseEntity<List<GrayServiceVO>> services() {
     /**
      * 返回服务实例列表
      *
-     * @param serviceId
-     * @return
+     * @param serviceId 服务id
+     * @return 灰度服务实例VO列表
      */
     @RequestMapping(value = "/services/{serviceId}/instances", method = RequestMethod.GET)
     public ResponseEntity<List<GrayInstanceVO>> instances(@PathVariable("serviceId") String serviceId) {
@@ -107,9 +107,9 @@ public ResponseEntity<Void> editInstanceStatus(
     /**
      * 服务实例的所有灰度策略组
      *
-     * @param serviceId
-     * @param instanceId
-     * @return
+     * @param serviceId 服务id
+     * @param instanceId 实例id
+     * @return 灰策略组VO列表
      */
     @RequestMapping(value = "/services/{serviceId}/instance/policyGroups", method = RequestMethod.GET)
     public ResponseEntity<List<GrayPolicyGroupVO>> policyGroups(@PathVariable("serviceId") String serviceId,
@@ -133,10 +133,10 @@ public ResponseEntity<List<GrayPolicyGroupVO>> policyGroups(@PathVariable("servi
     /**
      * 灰度策略组
      *
-     * @param serviceId
-     * @param instanceId
-     * @param groupId
-     * @return
+     * @param serviceId 服务id
+     * @param instanceId 实例id
+     * @param groupId 灰度策略组id
+     * @return 灰度策略组VO
      */
     @RequestMapping(value = "/services/{serviceId}/instance/policyGroup/{groupId}", method = RequestMethod.GET)
     public ResponseEntity<GrayPolicyGroupVO> policyGroup(@PathVariable("serviceId") String serviceId,
@@ -171,9 +171,9 @@ public ResponseEntity<Void> editPolicyGroupStatus(@PathVariable("serviceId") Str
     /**
      * 添加策略组
      *
-     * @param serviceId
-     * @param policyGroupFO
-     * @return
+     * @param serviceId 服务id
+     * @param policyGroupFO 灰度策略组FO
+     * @return Void
      */
     @RequestMapping(value = "/services/{serviceId}/instance/policyGroup", method = RequestMethod.POST)
     public ResponseEntity<Void> policyGroup(
@@ -197,10 +197,10 @@ public ResponseEntity<Void> policyGroup(
     /**
      * 删除策略组
      *
-     * @param serviceId
-     * @param instanceId
-     * @param policyGroupId
-     * @return
+     * @param serviceId 服务id
+     * @param instanceId 实例id
+     * @param policyGroupId 灰度策略组id
+     * @return Void
      */
     @ApiOperation("删除策略组")
     @RequestMapping(value = "/services/{serviceId}/instance/policyGroup", method = RequestMethod.DELETE)
diff --git a/spring-cloud-mult-version-samples/spring-cloud-bamboo-service-b-samples/src/main/java/cn/springcloud/bamboo/service/b/rest/TestResource.java b/spring-cloud-mult-version-samples/spring-cloud-bamboo-service-b-samples/src/main/java/cn/springcloud/bamboo/service/b/rest/TestResource.java
@@ -24,8 +24,8 @@ public class TestResource {
     /**
      * test rest template invoke service-a
      *
-     * @param request
-     * @return
+     * @param request HttpServletRequest
+     * @return 消息体
      */
     @RequestMapping(value = "/restTemplateGet", method = RequestMethod.GET)
     @ResponseBody
@@ -44,8 +44,8 @@ public Map<String, Object> restTemplateGet(HttpServletRequest request) {
     /**
      * test feign invoke service-a
      *
-     * @param version
-     * @return
+     * @param version 请求版本
+     * @return 消息体
      */
     @RequestMapping(value = "/feignGet", method = RequestMethod.GET)
     @ResponseBody

Original file line number	Diff line number	Diff line change
`@@ -9,15 +9,15 @@ public interface LoadBalanceRequestTrigger {`
`9`	`9`	`/**`
`10`	`10`	`* 判断是否需要执行的方法`
`11`	`11`	`*`
`12`		`- * @return`
	`12`	`+ * @return boolean`
`13`	`13`	`*/`
`14`	`14`	`boolean shouldExecute();`
`15`	`15`
`16`	`16`
`17`	`17`	`/**`
`18`	`18`	`* 请求之前执行`
`19`	`19`	`*`
`20`		`- * @param connectPointContext`
	`20`	`+ * @param connectPointContext 连接点上下文`
`21`	`21`	`*/`
`22`	`22`	`void before(ConnectPointContext connectPointContext);`
`23`	`23`
`@@ -26,7 +26,7 @@ public interface LoadBalanceRequestTrigger {`
`26`	`26`	`* 请求完成之后执行`
`27`	`27`	`* 如果出现异常，该方法依然会被执行`
`28`	`28`	`*`
`29`		`- * @param connectPointContext`
	`29`	`+ * @param connectPointContext 连接点上下文`
`30`	`30`	`*/`
`31`	`31`	`void after(ConnectPointContext connectPointContext);`
`32`	`32`	`}`