io.github.yedaxia.apidocs

类 DocContext

java.lang.Object

io.github.yedaxia.apidocs.DocContext

public class DocContext
extends java.lang.Object

to judge project which framework is using and make some initialization

构造器概要

构造器

构造器和说明
DocContext()

方法概要

限定符和类型	方法和说明
static AbsControllerParser	controllerParser() get controller parser, it will return different parser by different framework you are using.
static java.util.List<java.lang.String>	getApiVersionList()
static java.io.File[]	getControllerFiles() get all controllers in this project
static java.util.List<ControllerNode>	getControllerNodeList()
static java.lang.String	getCurrentApiVersion()
static java.lang.String	getDocPath() api docs output path
static DocsConfig	getDocsConfig()
static I18n	getI18n()
static java.util.List<java.lang.String>	getJavaSrcPaths() get java src paths
static java.util.List<ControllerNode>	getLastVersionControllerNodes()
static java.io.File	getLogFile() get log file path
static java.lang.String	getProjectPath() get project path
static IResponseWrapper	getResponseWrapper()
static void	init(DocsConfig config)

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

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

构造器详细资料

DocContext

public DocContext()

方法详细资料

init

public static void init(DocsConfig config)

getLogFile

public static java.io.File getLogFile()

get log file path

返回:

getProjectPath

public static java.lang.String getProjectPath()

get project path

getDocPath

public static java.lang.String getDocPath()

api docs output path

返回:

getJavaSrcPaths

public static java.util.List<java.lang.String> getJavaSrcPaths()

get java src paths

返回:

getControllerFiles

public static java.io.File[] getControllerFiles()

get all controllers in this project

返回:

controllerParser

public static AbsControllerParser controllerParser()

get controller parser, it will return different parser by different framework you are using.

返回:

getResponseWrapper

public static IResponseWrapper getResponseWrapper()

getControllerNodeList

public static java.util.List<ControllerNode> getControllerNodeList()

getDocsConfig

public static DocsConfig getDocsConfig()

getCurrentApiVersion

public static java.lang.String getCurrentApiVersion()

getApiVersionList

public static java.util.List<java.lang.String> getApiVersionList()

getLastVersionControllerNodes

public static java.util.List<ControllerNode> getLastVersionControllerNodes()

getI18n

public static I18n getI18n()