Merge pull request #921 from linwumingshi/refactor/java-doc

refactor: update java doc And error log

Author: shalousun

src/main/java/com/ly/doc/builder/AdocDocBuilder.java

@@ -38,8 +38,14 @@
  */
 public class AdocDocBuilder {
 
+	/**
+	 * api doc file name
+	 */
 	private static final String API_EXTENSION = "Api.adoc";
 
+	/**
+	 * index.adoc
+	 */
 	private static final String INDEX_DOC = "index.adoc";
 
 	/**

src/main/java/com/ly/doc/builder/ApiDataBuilder.java

@@ -26,6 +26,8 @@
 import com.thoughtworks.qdox.JavaProjectBuilder;
 
 /**
+ * Build Api Data
+ *
  * @author yu 2019/12/7.
  * @since 1.7.9
  */
@@ -56,6 +58,14 @@ public static ApiAllData getApiDataTree(ApiConfig config) {
 		return getApiData(config, Boolean.TRUE);
 	}
 
+	/**
+	 * Retrieves API data based on the given configuration.
+	 * @param config The API configuration object containing request parameters and data
+	 * source information.
+	 * @param toTree A flag indicating whether to convert the parameter data into a tree
+	 * structure.
+	 * @return An ApiAllData object containing all the API data information.
+	 */
 	private static ApiAllData getApiData(ApiConfig config, boolean toTree) {
 		config.setParamsDataToTree(toTree);
 		DocBuilderTemplate builderTemplate = new DocBuilderTemplate();

src/main/java/com/ly/doc/builder/HtmlApiDocBuilder.java

@@ -36,15 +36,26 @@
 import java.util.Objects;
 
 /**
+ * HTML API Doc Builder
+ *
  * @author yu 2019/9/20.
  * @since 1.7+
  */
 public class HtmlApiDocBuilder {
 
+	/**
+	 * error code html
+	 */
 	private static final String ERROR_CODE_HTML = "error.html";
 
+	/**
+	 * dict html
+	 */
 	private static final String DICT_HTML = "dict.html";
 
+	/**
+	 * index html
+	 */
 	private static String INDEX_HTML = "index.html";
 
 	/**

src/main/java/com/ly/doc/builder/JMeterBuilder.java

@@ -41,6 +41,9 @@
  */
 public class JMeterBuilder {
 
+	/**
+	 * Jmeter script extension
+	 */
 	private static final String JMETER_SCRIPT_EXTENSION = ".jmx";
 
 	/**

src/main/java/com/ly/doc/builder/PostmanJsonBuilder.java

@@ -45,10 +45,16 @@
 import java.util.*;
 
 /**
+ * Postman Json Builder
+ *
  * @author yu 2019/11/21.
+ * @since 1.7.8
  */
 public class PostmanJsonBuilder {
 
+	/**
+	 * Message
+	 */
 	private static final String MSG = "Interface name is not set.";
 
 	/**

src/main/java/com/ly/doc/builder/ProjectDocConfigBuilder.java

@@ -47,30 +47,68 @@
 import java.util.logging.Logger;
 
 /**
+ * ProjectDocConfigBuilder
+ *
  * @author yu 2019/12/21.
+ * @since 1.8.0
  */
 public class ProjectDocConfigBuilder {
 
+	/**
+	 * Logger
+	 */
 	private static final Logger log = Logger.getLogger(ProjectDocConfigBuilder.class.getName());
 
+	/**
+	 * JavaProjectBuilder
+	 */
 	private final JavaProjectBuilder javaProjectBuilder;
 
+	/**
+	 * classFilesMap
+	 */
 	private final Map<String, JavaClass> classFilesMap = new ConcurrentHashMap<>();
 
+	/**
+	 * enumClassMap
+	 */
 	private final Map<String, Class<? extends Enum<?>>> enumClassMap = new ConcurrentHashMap<>();
 
+	/**
+	 * customRespFieldMap
+	 */
 	private final Map<CustomField.Key, CustomField> customRespFieldMap = new ConcurrentHashMap<>();
 
+	/**
+	 * customReqFieldMap
+	 */
 	private final Map<CustomField.Key, CustomField> customReqFieldMap = new ConcurrentHashMap<>();
 
+	/**
+	 * replaceClassMap
+	 */
 	private final Map<String, String> replaceClassMap = new ConcurrentHashMap<>();
 
+	/**
+	 * constantsMap
+	 */
 	private final Map<String, String> constantsMap = new ConcurrentHashMap<>();
 
+	/**
+	 * serverUrl
+	 */
 	private final String serverUrl;
 
+	/**
+	 * ApiConfig
+	 */
 	private final ApiConfig apiConfig;
 
+	/**
+	 * Constructor
+	 * @param apiConfig ApiConfig
+	 * @param javaProjectBuilder JavaProjectBuilder
+	 */
 	public ProjectDocConfigBuilder(ApiConfig apiConfig, JavaProjectBuilder javaProjectBuilder) {
 		if (null == apiConfig) {
 			throw new NullPointerException("ApiConfig can't be null.");
@@ -105,6 +143,10 @@ public ProjectDocConfigBuilder(ApiConfig apiConfig, JavaProjectBuilder javaProje
 		this.checkBodyAdvice(apiConfig.getResponseBodyAdvice());
 	}
 
+	/**
+	 * Init data dictionary.
+	 * @param apiConfig apiConfig
+	 */
 	private void initDict(ApiConfig apiConfig) {
 		if (enumClassMap.isEmpty()) {
 			return;
@@ -129,6 +171,11 @@ private void initDict(ApiConfig apiConfig) {
 		}
 	}
 
+	/**
+	 * Get enum implements by interface.
+	 * @param enumClass enumClass
+	 * @return enum implements
+	 */
 	private Set<Class<? extends Enum<?>>> getEnumImplementsByInterface(Class<?> enumClass) {
 		if (!enumClass.isInterface()) {
 			return Collections.emptySet();
@@ -142,6 +189,11 @@ private Set<Class<? extends Enum<?>>> getEnumImplementsByInterface(Class<?> enum
 		return set;
 	}
 
+	/**
+	 * Get class by name.
+	 * @param simpleName simpleName
+	 * @return JavaClass
+	 */
 	public JavaClass getClassByName(String simpleName) {
 		JavaClass cls = javaProjectBuilder.getClassByName(simpleName);
 		List<DocJavaField> fieldList = JavaClassUtil.getFields(cls, 0, new LinkedHashMap<>(), null);
@@ -158,6 +210,11 @@ public JavaClass getClassByName(String simpleName) {
 		return cls;
 	}
 
+	/**
+	 * Load java source.
+	 * @param config ApiConfig
+	 * @param builder JavaProjectBuilder
+	 */
 	private void loadJavaSource(ApiConfig config, JavaProjectBuilder builder) {
 		if (CollectionUtil.isNotEmpty(config.getJarSourcePaths())) {
 			for (SourceCodePath path : config.getJarSourcePaths()) {
@@ -181,6 +238,11 @@ private void loadJavaSource(ApiConfig config, JavaProjectBuilder builder) {
 		}
 	}
 
+	/**
+	 * Load jar java source.
+	 * @param strPath path
+	 * @param builder builder
+	 */
 	private void loadJavaSource(String strPath, JavaProjectBuilder builder) {
 		DirectoryScanner scanner = new DirectoryScanner(new File(strPath));
 		scanner.addFilter(new SuffixFilter(".java"));
@@ -194,6 +256,11 @@ private void loadJavaSource(String strPath, JavaProjectBuilder builder) {
 		});
 	}
 
+	/**
+	 * Load jar java source.
+	 * @param path path
+	 * @param builder builder
+	 */
 	public void loadJarJavaSource(String path, JavaProjectBuilder builder) {
 		OutputStream out;
 		if (!path.endsWith(".jar")) {
@@ -228,6 +295,10 @@ public void loadJarJavaSource(String path, JavaProjectBuilder builder) {
 		}
 	}
 
+	/**
+	 * Delete dir.
+	 * @param file file
+	 */
 	public static void deleteDir(File file) {
 		File[] files = file.listFiles();
 		if (file.isFile() || Objects.isNull(files) || files.length == 0) {
@@ -241,6 +312,10 @@ public static void deleteDir(File file) {
 		file.delete();
 	}
 
+	/**
+	 * Init class files map.
+	 */
+	@SuppressWarnings({ "rawtypes", "unchecked" })
 	private void initClassFilesMap() {
 		Collection<JavaClass> javaClasses = javaProjectBuilder.getClasses();
 		for (JavaClass cls : javaClasses) {
@@ -264,6 +339,10 @@ private void initClassFilesMap() {
 		}
 	}
 
+	/**
+	 * Init custom response fields map.
+	 * @param config config
+	 */
 	private void initCustomResponseFieldsMap(ApiConfig config) {
 		if (CollectionUtil.isNotEmpty(config.getCustomResponseFields())) {
 			for (CustomField field : config.getCustomResponseFields()) {
@@ -273,6 +352,10 @@ private void initCustomResponseFieldsMap(ApiConfig config) {
 		}
 	}
 
+	/**
+	 * Init custom request fields map.
+	 * @param config config
+	 */
 	private void initCustomRequestFieldsMap(ApiConfig config) {
 		if (CollectionUtil.isNotEmpty(config.getCustomRequestFields())) {
 			for (CustomField field : config.getCustomRequestFields()) {
@@ -282,6 +365,10 @@ private void initCustomRequestFieldsMap(ApiConfig config) {
 		}
 	}
 
+	/**
+	 * Init replace class map.
+	 * @param config config
+	 */
 	private void initReplaceClassMap(ApiConfig config) {
 		if (CollectionUtil.isNotEmpty(config.getApiObjectReplacements())) {
 			for (ApiObjectReplacement replace : config.getApiObjectReplacements()) {
@@ -290,6 +377,10 @@ private void initReplaceClassMap(ApiConfig config) {
 		}
 	}
 
+	/**
+	 * Init constants.
+	 * @param config config
+	 */
 	private void initConstants(ApiConfig config) {
 		List<ApiConstant> apiConstants;
 		if (CollectionUtil.isEmpty(config.getApiConstants())) {
@@ -311,10 +402,14 @@ private void initConstants(ApiConfig config) {
 			}
 		}
 		catch (ClassNotFoundException | IllegalAccessException e) {
-			e.printStackTrace();
+			log.warning(e.getMessage());
 		}
 	}
 
+	/**
+	 * Check body advice.
+	 * @param bodyAdvice body advice
+	 */
 	private void checkBodyAdvice(BodyAdvice bodyAdvice) {
 		if (Objects.nonNull(bodyAdvice) && StringUtil.isNotEmpty(bodyAdvice.getClassName())) {
 			if (Objects.nonNull(bodyAdvice.getWrapperClass())) {
@@ -330,6 +425,9 @@ private void checkBodyAdvice(BodyAdvice bodyAdvice) {
 		}
 	}
 
+	/**
+	 * Set highlight style.
+	 */
 	private void setHighlightStyle() {
 		String style = apiConfig.getStyle();
 		if (HighLightJsConstants.HIGH_LIGHT_DEFAULT_STYLE.equals(style)) {

src/main/java/com/ly/doc/builder/WordDocBuilder.java

@@ -43,17 +43,31 @@
 import java.util.zip.ZipOutputStream;
 
 /**
+ * Word doc builder
+ *
  * @author <a href="mailto:cqmike0315@gmail.com">chenqi</a>
- * @version 1.0
+ * @since 3.0.1
  */
 public class WordDocBuilder {
 
+	/**
+	 * template docx
+	 */
 	private static final String TEMPLATE_DOCX = "template/word/template.docx";
 
+	/**
+	 * build docx file name
+	 */
 	private static final String BUILD_DOCX = "index.docx";
 
+	/**
+	 * build error code docx file name
+	 */
 	private static final String BUILD_ERROR_DOCX = "error.docx";
 
+	/**
+	 * build directory data docx file name
+	 */
 	private static final String BUILD_DICT_DOCX = "dict.docx";
 
 	/**

src/main/java/com/ly/doc/builder/javadoc/JavadocAdocBuilder.java

@@ -28,10 +28,22 @@
 
 import java.util.List;
 
+/**
+ * Javadoc Asciidoc Builder
+ *
+ * @author chenchuxin
+ * @since 3.0.5
+ */
 public class JavadocAdocBuilder {
 
+	/**
+	 * api extension
+	 */
 	private static final String API_EXTENSION = "JavadocApi.adoc";
 
+	/**
+	 * index extension
+	 */
 	private static final String INDEX_DOC = "javadoc-index.adoc";
 
 	/**

src/main/java/com/ly/doc/builder/javadoc/JavadocApiDataBuilder.java

@@ -26,6 +26,12 @@
 import com.ly.doc.model.javadoc.JavadocApiAllData;
 import com.thoughtworks.qdox.JavaProjectBuilder;
 
+/**
+ * Javadoc Api Data Builder
+ *
+ * @author chenchuxin
+ * @since 3.0.5
+ */
 public class JavadocApiDataBuilder {
 
 	/**