com.power.doc.builder.rpc

类 RpcDocBuilderTemplate

java.lang.Object

com.power.doc.builder.BaseDocBuilderTemplate

com.power.doc.builder.rpc.RpcDocBuilderTemplate

public class RpcDocBuilderTemplate
extends BaseDocBuilderTemplate

作者:

yu 2020/5/16.

构造器概要

构造器

构造器和说明
RpcDocBuilderTemplate()

方法概要

限定符和类型	方法和说明
void	buildAllInOne(List<RpcApiDoc> apiDocList, ApiConfig config, com.thoughtworks.qdox.JavaProjectBuilder javaProjectBuilder, String template, String outPutFileName) Merge all api doc into one document
void	buildApiDoc(List<RpcApiDoc> apiDocList, ApiConfig config, String template, String fileExtension) Generate api documentation for all controllers.
void	buildErrorCodeDoc(ApiConfig config, String template, String outPutFileName) build error_code adoc
RpcApiAllData	getApiData(ApiConfig config, com.thoughtworks.qdox.JavaProjectBuilder javaProjectBuilder) get all api data

从类继承的方法 com.power.doc.builder.BaseDocBuilderTemplate

checkAndInit, checkAndInitForGetApiData, errorCodeDictToList, setDirectoryLanguageVariable

从类继承的方法 java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

构造器详细资料

RpcDocBuilderTemplate

public RpcDocBuilderTemplate()

方法详细资料

buildApiDoc

public void buildApiDoc(List<RpcApiDoc> apiDocList,
                        ApiConfig config,
                        String template,
                        String fileExtension)

Generate api documentation for all controllers.

参数:

apiDocList - list of api doc

config - api config

template - template

fileExtension - file extension

buildAllInOne

public void buildAllInOne(List<RpcApiDoc> apiDocList,
                          ApiConfig config,
                          com.thoughtworks.qdox.JavaProjectBuilder javaProjectBuilder,
                          String template,
                          String outPutFileName)

Merge all api doc into one document

参数:

apiDocList - list data of Api doc

config - api config

javaProjectBuilder - JavaProjectBuilder

template - template

outPutFileName - output file

buildErrorCodeDoc

public void buildErrorCodeDoc(ApiConfig config,
                              String template,
                              String outPutFileName)

build error_code adoc

参数:

config - api config

template - template

outPutFileName - output file

getApiData

public RpcApiAllData getApiData(ApiConfig config,
                                com.thoughtworks.qdox.JavaProjectBuilder javaProjectBuilder)

get all api data

参数:

config - ApiConfig

javaProjectBuilder - JavaProjectBuilder

返回:

ApiAllData