release 1.8.8

CHANGELOG.md

@@ -6,8 +6,9 @@
     1. 修改忽略对LinkedHashMap的解析，gitee #I1JI5W。
     2. 修改接口或和实现类合并分析是字段重复问题，gitee #I1JHMW。
     3. 优化接口方法字段不能获取docletTag的问题。
-    4. 增加枚举内联展示功能。
-    5. 添加Feign的支持
+    4. 优化枚举参数展示，支持自定义控制显示。
+    5. 添加Feign的支持。
+    6. 优化递归执行，对外提供递归次数限制。
 #### 版本号：1.8.7
 - 更新日期: 2020-06-01
 - 更新内容：

README.md

@@ -89,6 +89,8 @@ When you need to use smart-doc to generate more API document information, you ca
   "projectName": "smart-doc", // Configure your own project name
   "skipTransientField": true, // Not currently implemented
   "requestFieldToUnderline":true, //convert request field to underline
+  "inlineEnum":true,// Set to true to display enumeration details in the parameter table
+  "recursionLimit":7,// Set the number of recursive executions to avoid stack overflow, the default is 7
   "responseFieldToUnderline":true,//convert response field to underline
   "dataDictionaries": [// Configure the data dictionary, no need to set
     {

README_CN.md

@@ -88,6 +88,8 @@ smart-doc官方目前已经开发完成maven 插件和gradle，你可以根据
   "showAuthor":true,//是否显示接口作者名称，默认是true,不想显示可关闭
   "requestFieldToUnderline":true,//自动将驼峰入参字段在文档中转为下划线格式,//@since 1.8.7版本开始
   "responseFieldToUnderline":true,//自动将驼峰入参字段在文档中转为下划线格式,//@since 1.8.7版本开始
+  "inlineEnum":true,//设置为true会将枚举详情展示到参数表中，默认关闭，//@since 1.8.8版本开始
+  "recursionLimit":7,//设置允许递归执行的次数用于避免一些对象解析卡主，默认是7，正常为3次以内，//@since 1.8.8版本开始
   "dataDictionaries": [ //配置数据字典，没有需求可以不设置
     {
       "title": "http状态码字典", //数据字典的名称

pom.xml

@@ -5,7 +5,7 @@
     <modelVersion>4.0.0</modelVersion>
     <artifactId>smart-doc</artifactId>
     <packaging>jar</packaging>
-    <version>1.8.7</version>
+    <version>1.8.8</version>
 
     <name>smart-doc</name>
     <url>https://github.com/shalousun/smart-doc.git</url>

src/main/java/com/power/doc/helper/ParamsBuildHelper.java

@@ -213,7 +213,7 @@ public class ParamsBuildHelper {
                     if (StringUtil.isNotEmpty(enumComments) && javaClass.isEnum()) {
                         if (projectBuilder.getApiConfig().getInlineEnum()) {
                             ApiDataDictionary dataDictionary = projectBuilder.getApiConfig().getDataDictionary(javaClass.getSimpleName());
-                            comment = comment + "(See: " + dictionaryListComment(dataDictionary) + ")";
+                            comment = comment + "(enum:" + dictionaryListComment(dataDictionary) + ")";
                         } else {
                             enumComments = DocUtil.replaceNewLineToHtmlBr(enumComments);
                             comment = comment + "(See: " + enumComments + ")";

src/main/java/com/power/doc/utils/DocUtil.java

@@ -356,7 +356,8 @@ public class DocUtil {
     /**
      * Get field tags
      *
-     * @param field JavaField
+     * @param field        JavaField
+     * @param docJavaField DocJavaField
      * @return map
      */
     public static Map<String, String> getFieldTagsValue(final JavaField field, DocJavaField docJavaField) {