com.power.doc.template

接口 IDocBuildTemplate<T>

所有已知实现类:

RpcDocBuildTemplate, SpringBootDocBuildTemplate

public interface IDocBuildTemplate<T>

作者:

yu 2019/12/21.

方法概要

限定符和类型	方法和说明
default List<ApiParam>	buildReturnApiParams(DocJavaMethod docJavaMethod, ProjectDocConfigBuilder projectBuilder)
default String	createDocRenderHeaders(List<ApiReqHeader> headers, boolean isAdoc)
List<T>	getApiData(ProjectDocConfigBuilder projectBuilder)
T	getSingleApiData(ProjectDocConfigBuilder projectBuilder, String apiClassName)
default void	handleApiDoc(com.thoughtworks.qdox.model.JavaClass cls, List<ApiDoc> apiDocList, List<ApiMethodDoc> apiMethodDocs, int order, boolean isUseMD5)
boolean	ignoreReturnObject(String typeName, List<String> ignoreParams)
default String	paramCommentResolve(String comment)

方法详细资料

createDocRenderHeaders

default String createDocRenderHeaders(List<ApiReqHeader> headers,
                                      boolean isAdoc)

paramCommentResolve

default String paramCommentResolve(String comment)

handleApiDoc

default void handleApiDoc(com.thoughtworks.qdox.model.JavaClass cls,
                          List<ApiDoc> apiDocList,
                          List<ApiMethodDoc> apiMethodDocs,
                          int order,
                          boolean isUseMD5)

buildReturnApiParams

default List<ApiParam> buildReturnApiParams(DocJavaMethod docJavaMethod,
                                            ProjectDocConfigBuilder projectBuilder)

getApiData

List<T> getApiData(ProjectDocConfigBuilder projectBuilder)

getSingleApiData

T getSingleApiData(ProjectDocConfigBuilder projectBuilder,
                   String apiClassName)

ignoreReturnObject

boolean ignoreReturnObject(String typeName,
                           List<String> ignoreParams)