com.power.doc.builder

类 DocBuilderTemplate

java.lang.Object

com.power.doc.builder.BaseDocBuilderTemplate

com.power.doc.builder.DocBuilderTemplate

public class DocBuilderTemplate
extends BaseDocBuilderTemplate

作者:

yu 2019/9/26.

构造器概要

构造器

构造器和说明
DocBuilderTemplate()

方法概要

限定符和类型	方法和说明
void	buildAllInOne(List<ApiDoc> apiDocList, ApiConfig config, com.thoughtworks.qdox.JavaProjectBuilder javaProjectBuilder, String template, String outPutFileName) Merge all api doc into one document
void	buildApiDoc(List<ApiDoc> apiDocList, ApiConfig config, String template, String fileExtension) Generate api documentation for all controllers.
List<ApiDocDict>	buildDictionary(ApiConfig config, com.thoughtworks.qdox.JavaProjectBuilder javaProjectBuilder) Build dictionary
void	buildDirectoryDataDoc(ApiConfig config, com.thoughtworks.qdox.JavaProjectBuilder javaProjectBuilder, List<ApiDoc> apiDocList, String template, String outPutFileName, String indexAlias) build common_data doc
void	buildDirectoryDataDoc(ApiConfig config, com.thoughtworks.qdox.JavaProjectBuilder javaProjectBuilder, String template, String outPutFileName) build common_data doc
void	buildDoc(List<ApiDoc> apiDocList, ApiConfig config, com.thoughtworks.qdox.JavaProjectBuilder javaProjectBuilder, String template, String outPutFileName, ApiDoc apiDoc, String index) Merge all api doc into one document
void	buildErrorCodeDoc(ApiConfig config, com.thoughtworks.qdox.JavaProjectBuilder javaProjectBuilder, List<ApiDoc> apiDocList, String template, String outPutFileName, String indexAlias) build error_code html
void	buildErrorCodeDoc(ApiConfig config, String template, String outPutFileName) build error_code adoc
void	buildSearchJs(ApiConfig config, com.thoughtworks.qdox.JavaProjectBuilder javaProjectBuilder, List<ApiDoc> apiDocList, String template)
void	buildSingleApi(ProjectDocConfigBuilder projectBuilder, String controllerName, String template, String fileExtension) Generate a single controller api document
ApiAllData	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

构造器详细资料

DocBuilderTemplate

public DocBuilderTemplate()

方法详细资料

getApiData

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

get all api data

参数:

config - ApiConfig

javaProjectBuilder - JavaProjectBuilder

返回:

ApiAllData

buildApiDoc

public void buildApiDoc(List<ApiDoc> 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<ApiDoc> 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

buildDoc

public void buildDoc(List<ApiDoc> apiDocList,
                     ApiConfig config,
                     com.thoughtworks.qdox.JavaProjectBuilder javaProjectBuilder,
                     String template,
                     String outPutFileName,
                     ApiDoc apiDoc,
                     String index)

Merge all api doc into one document

参数:

apiDocList - list data of Api doc

config - api config

javaProjectBuilder - JavaProjectBuilder

template - template

outPutFileName - output file

apiDoc - apiDoc

index - index html

buildSearchJs

public void buildSearchJs(ApiConfig config,
                          com.thoughtworks.qdox.JavaProjectBuilder javaProjectBuilder,
                          List<ApiDoc> apiDocList,
                          String template)

buildErrorCodeDoc

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

build error_code adoc

参数:

config - api config

template - template

outPutFileName - output file

buildErrorCodeDoc

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

build error_code html

参数:

config - api config

javaProjectBuilder - javaProjectBuilder

apiDocList - list data of Api doc

template - template

outPutFileName - output file

indexAlias - index alias

buildDirectoryDataDoc

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

build common_data doc

参数:

config - api config

javaProjectBuilder - JavaProjectBuilder

apiDocList - list data of Api doc

template - template

outPutFileName - output file

indexAlias - index alias

buildDirectoryDataDoc

public void buildDirectoryDataDoc(ApiConfig config,
                                  com.thoughtworks.qdox.JavaProjectBuilder javaProjectBuilder,
                                  String template,
                                  String outPutFileName)

build common_data doc

参数:

config - api config

javaProjectBuilder - JavaProjectBuilder

template - template

outPutFileName - output file

buildSingleApi

public void buildSingleApi(ProjectDocConfigBuilder projectBuilder,
                           String controllerName,
                           String template,
                           String fileExtension)

Generate a single controller api document

参数:

projectBuilder - projectBuilder

controllerName - controller name

template - template

fileExtension - file extension

buildDictionary

public List<ApiDocDict> buildDictionary(ApiConfig config,
                                        com.thoughtworks.qdox.JavaProjectBuilder javaProjectBuilder)

Build dictionary

参数:

config - api config

javaProjectBuilder - JavaProjectBuilder

返回:

list of ApiDocDict