跳过导航链接
A B C D E F G H I J L M N P R S T U V W 

A

AbsControllerParser - io.github.yedaxia.apidocs.parser中的类
parse Controller Java the common part, get all request nodes
AbsControllerParser() - 类 的构造器io.github.yedaxia.apidocs.parser.AbsControllerParser
 
AbsDocGenerator - io.github.yedaxia.apidocs.doc中的类
 
actionMethod - 类 中的变量io.github.yedaxia.apidocs.parser.PlayRoutesParser.RouteNode
 
addChildGenericNode(GenericNode) - 类 中的方法io.github.yedaxia.apidocs.parser.GenericNode
 
addChildNode(FieldNode) - 类 中的方法io.github.yedaxia.apidocs.parser.ClassNode
 
addGenericNode(GenericNode) - 类 中的方法io.github.yedaxia.apidocs.parser.ClassNode
 
addHeaderNode(HeaderNode) - 类 中的方法io.github.yedaxia.apidocs.parser.RequestNode
 
addJavaSrcPath(String) - 类 中的方法io.github.yedaxia.apidocs.DocsConfig
if cannot find the java file from other module, you can try to config the java src path yourself.
addMethod(String) - 类 中的方法io.github.yedaxia.apidocs.parser.RequestNode
 
addParam(String, String) - 类 中的方法io.github.yedaxia.apidocs.http.DHttpRequest
 
addParamNode(ParamNode) - 类 中的方法io.github.yedaxia.apidocs.parser.RequestNode
 
addPlugin(IPluginSupport) - 类 中的方法io.github.yedaxia.apidocs.DocsConfig
add your own plugin, example:
addRequestNode(RequestNode) - 类 中的方法io.github.yedaxia.apidocs.parser.ControllerNode
 
afterHandleController(ControllerNode, ClassOrInterfaceDeclaration) - 类 中的方法io.github.yedaxia.apidocs.parser.AbsControllerParser
called after controller node has handled
afterHandleMethod(RequestNode, MethodDeclaration) - 类 中的方法io.github.yedaxia.apidocs.parser.AbsControllerParser
called after request method node has handled
afterHandleMethod(RequestNode, MethodDeclaration) - 类 中的方法io.github.yedaxia.apidocs.parser.GenericControllerParser
 
afterHandleMethod(RequestNode, MethodDeclaration) - 类 中的方法io.github.yedaxia.apidocs.parser.JFinalControllerParser
 
afterHandleMethod(RequestNode, MethodDeclaration) - 类 中的方法io.github.yedaxia.apidocs.parser.PlayControllerParser
 
afterHandleMethod(RequestNode, MethodDeclaration) - 类 中的方法io.github.yedaxia.apidocs.parser.SpringControllerParser
 
ApiDoc - io.github.yedaxia.apidocs中的注释类型
 
ApiDoc.Null - io.github.yedaxia.apidocs中的类
 

B

basicUrl - 类 中的变量io.github.yedaxia.apidocs.parser.JFinalRoutesParser.RouteNode
 
beforeHandleController(ControllerNode, ClassOrInterfaceDeclaration) - 类 中的方法io.github.yedaxia.apidocs.parser.AbsControllerParser
called before controller node has handled
beforeHandleController(ControllerNode, ClassOrInterfaceDeclaration) - 类 中的方法io.github.yedaxia.apidocs.parser.SpringControllerParser
 
build() - 类 中的方法io.github.yedaxia.apidocs.codegenerator.CodeFileBuilder
 
build() - 接口 中的方法io.github.yedaxia.apidocs.codegenerator.ICodeBuilder
 
build() - 类 中的方法io.github.yedaxia.apidocs.codegenerator.ios.builder.ModelBuilder
 
build() - 类 中的方法io.github.yedaxia.apidocs.codegenerator.ios.builder.ModelFieldBuilder
 
build() - 类 中的方法io.github.yedaxia.apidocs.codegenerator.java.builder.JavaClassBuilder
 
build() - 类 中的方法io.github.yedaxia.apidocs.codegenerator.java.builder.JavaFieldBuilder
 
build() - 类 中的方法io.github.yedaxia.apidocs.codegenerator.java.builder.JavaGetterBuilder
 
build() - 类 中的方法io.github.yedaxia.apidocs.codegenerator.java.builder.JavaSetterBuilder
 
buildDoc(ControllerNode) - 类 中的方法io.github.yedaxia.apidocs.doc.HtmlControllerDocBuilder
 
buildDoc(ControllerNode) - 接口 中的方法io.github.yedaxia.apidocs.doc.IControllerDocBuilder
build api docs and return as string
buildHtmlDocs(DocsConfig) - 类 中的静态方法io.github.yedaxia.apidocs.Docs
build html api docs
BuildToolType - io.github.yedaxia.apidocs中的枚举
 

C

CacheUtils - io.github.yedaxia.apidocs中的类
cache all controller nodes
CacheUtils() - 类 的构造器io.github.yedaxia.apidocs.CacheUtils
 
capitalize(String) - 类 中的静态方法io.github.yedaxia.apidocs.Utils
make first word capitalize
ChangeFlag - io.github.yedaxia.apidocs.consts中的接口
Request Node Change Flag
ClassNode - io.github.yedaxia.apidocs.parser中的类
class node
ClassNode() - 类 的构造器io.github.yedaxia.apidocs.parser.ClassNode
 
cleanCommentContent(String) - 类 中的静态方法io.github.yedaxia.apidocs.Utils
remove some characters like [* \n]
closeSilently(Closeable) - 类 中的静态方法io.github.yedaxia.apidocs.Utils
close stream
CodeFileBuilder - io.github.yedaxia.apidocs.codegenerator中的类
 
CodeFileBuilder(String, String, String) - 类 的构造器io.github.yedaxia.apidocs.codegenerator.CodeFileBuilder
 
CodeGenerator - io.github.yedaxia.apidocs.codegenerator中的类
 
CodeGenerator(ResponseNode) - 类 的构造器io.github.yedaxia.apidocs.codegenerator.CodeGenerator
 
compilationUnit(File) - 类 中的静态方法io.github.yedaxia.apidocs.ParseUtils
get java file parser object
ConfigException - io.github.yedaxia.apidocs.exception中的异常错误
 
ConfigException() - 异常错误 的构造器io.github.yedaxia.apidocs.exception.ConfigException
 
ConfigException(String) - 异常错误 的构造器io.github.yedaxia.apidocs.exception.ConfigException
 
controllerFile - 类 中的变量io.github.yedaxia.apidocs.parser.JFinalRoutesParser.RouteNode
 
controllerFile - 类 中的变量io.github.yedaxia.apidocs.parser.PlayRoutesParser.RouteNode
 
ControllerNode - io.github.yedaxia.apidocs.parser中的类
a controller node corresponds to a controller file
ControllerNode() - 类 的构造器io.github.yedaxia.apidocs.parser.ControllerNode
 
controllerParser() - 类 中的静态方法io.github.yedaxia.apidocs.DocContext
get controller parser, it will return different parser by different framework you are using.
createProvider() - 类 中的静态方法io.github.yedaxia.apidocs.codegenerator.provider.ProviderFactory
 

D

decapitalize(String) - 类 中的静态方法io.github.yedaxia.apidocs.Utils
make first word lower case
description - 类 中的变量io.github.yedaxia.apidocs.parser.ParamNode
 
DHttpRequest - io.github.yedaxia.apidocs.http中的类
 
DHttpRequest() - 类 的构造器io.github.yedaxia.apidocs.http.DHttpRequest
 
DHttpResponse - io.github.yedaxia.apidocs.http中的类
 
DHttpResponse() - 类 的构造器io.github.yedaxia.apidocs.http.DHttpResponse
 
DHttpUtils - io.github.yedaxia.apidocs.http中的类
 
DocContext - io.github.yedaxia.apidocs中的类
to judge project which framework is using and make some initialization
DocContext() - 类 的构造器io.github.yedaxia.apidocs.DocContext
 
DocFieldHelper - io.github.yedaxia.apidocs.codegenerator.provider中的类
Created by user on 2016/12/25.
DocFieldHelper() - 类 的构造器io.github.yedaxia.apidocs.codegenerator.provider.DocFieldHelper
 
DocFieldProvider - io.github.yedaxia.apidocs.codegenerator.provider中的类
 
DocFieldProvider() - 类 的构造器io.github.yedaxia.apidocs.codegenerator.provider.DocFieldProvider
 
Docs - io.github.yedaxia.apidocs中的类
main entrance
Docs() - 类 的构造器io.github.yedaxia.apidocs.Docs
 
DocsConfig - io.github.yedaxia.apidocs中的类
 
DocsConfig() - 类 的构造器io.github.yedaxia.apidocs.DocsConfig
 
doLogin(String, String, String) - 类 中的方法io.github.yedaxia.apidocs.plugin.rap.RapSupportPlugin
 

E

error(String, Object...) - 类 中的静态方法io.github.yedaxia.apidocs.LogUtils
 
error(String, Throwable) - 类 中的静态方法io.github.yedaxia.apidocs.LogUtils
 
execute(List<ControllerNode>) - 接口 中的方法io.github.yedaxia.apidocs.IPluginSupport
a hook method
execute(List<ControllerNode>) - 类 中的方法io.github.yedaxia.apidocs.plugin.markdown.MarkdownDocPlugin
 
execute(List<ControllerNode>) - 类 中的方法io.github.yedaxia.apidocs.plugin.rap.RapSupportPlugin
 

F

FieldModel - io.github.yedaxia.apidocs.codegenerator.model中的类
Created by Darcy https://yedaxia.github.io/
FieldModel() - 类 的构造器io.github.yedaxia.apidocs.codegenerator.model.FieldModel
 
FieldNode - io.github.yedaxia.apidocs.parser中的类
a field node corresponds to a response field
FieldNode() - 类 的构造器io.github.yedaxia.apidocs.parser.FieldNode
 

G

generateCode() - 类 中的方法io.github.yedaxia.apidocs.codegenerator.CodeGenerator
生成代码
generateDocs() - 类 中的方法io.github.yedaxia.apidocs.doc.AbsDocGenerator
generate api Docs
generateNodeCode(ClassNode) - 类 中的方法io.github.yedaxia.apidocs.codegenerator.CodeGenerator
产生单个ResponseNode节点的Code
generateNodeCode(ClassNode) - 类 中的方法io.github.yedaxia.apidocs.codegenerator.ios.ModelCodeGenerator
 
generateNodeCode(ClassNode) - 类 中的方法io.github.yedaxia.apidocs.codegenerator.java.JavaCodeGenerator
 
GenericControllerParser - io.github.yedaxia.apidocs.parser中的类
can apply to any java project, but you have to set the request url and method in annotation $ApiDoc by yourself.
GenericControllerParser() - 类 的构造器io.github.yedaxia.apidocs.parser.GenericControllerParser
 
GenericNode - io.github.yedaxia.apidocs.parser中的类
generic node of model class
GenericNode() - 类 的构造器io.github.yedaxia.apidocs.parser.GenericNode
 
getActionUrl(String, String) - 类 中的静态方法io.github.yedaxia.apidocs.Utils
get url with base url
getAndroidCodePath() - 类 中的方法io.github.yedaxia.apidocs.parser.RequestNode
 
getApiVersion() - 类 中的方法io.github.yedaxia.apidocs.DocsConfig
 
getApiVersionList() - 类 中的静态方法io.github.yedaxia.apidocs.DocContext
 
getAssign() - 类 中的方法io.github.yedaxia.apidocs.codegenerator.model.FieldModel
 
getAuthor() - 类 中的方法io.github.yedaxia.apidocs.parser.ControllerNode
 
getAuthor() - 类 中的方法io.github.yedaxia.apidocs.parser.RequestNode
 
getAutoGenerate() - 类 中的方法io.github.yedaxia.apidocs.DocsConfig
 
getBaseUrl() - 类 中的方法io.github.yedaxia.apidocs.parser.ControllerNode
 
getCaseFieldName() - 类 中的方法io.github.yedaxia.apidocs.codegenerator.model.FieldModel
 
getChangeFlag() - 类 中的方法io.github.yedaxia.apidocs.parser.RequestNode
 
getChildGenericNode() - 类 中的方法io.github.yedaxia.apidocs.parser.GenericNode
 
getChildNode() - 类 中的方法io.github.yedaxia.apidocs.parser.FieldNode
 
getChildNodes() - 类 中的方法io.github.yedaxia.apidocs.parser.ClassNode
 
getClassFileName() - 类 中的方法io.github.yedaxia.apidocs.parser.ClassNode
 
getClassInJavaFile(File, String) - 类 中的静态方法io.github.yedaxia.apidocs.ParseUtils
获取java文件中的类对象
getClassName() - 类 中的方法io.github.yedaxia.apidocs.parser.ClassNode
 
getClassName() - 类 中的方法io.github.yedaxia.apidocs.parser.ControllerNode
 
getClassName(String) - 类 中的静态方法io.github.yedaxia.apidocs.Utils
get simple class name
getClassNode() - 类 中的方法io.github.yedaxia.apidocs.parser.FieldNode
 
getClassType() - 类 中的方法io.github.yedaxia.apidocs.parser.GenericNode
 
getCode() - 类 中的方法io.github.yedaxia.apidocs.http.DHttpResponse
 
getCodeFileUrl() - 类 中的方法io.github.yedaxia.apidocs.parser.RequestNode
 
getCodeTemplate() - 类 中的方法io.github.yedaxia.apidocs.codegenerator.CodeGenerator
获取最终的代码模板
getCodeTemplate() - 类 中的方法io.github.yedaxia.apidocs.codegenerator.ios.ModelCodeGenerator
 
getCodeTemplate() - 类 中的方法io.github.yedaxia.apidocs.codegenerator.java.JavaCodeGenerator
 
getCodeTemplateFile(String) - 类 中的静态方法io.github.yedaxia.apidocs.Resources
get code template file
getComment() - 类 中的方法io.github.yedaxia.apidocs.codegenerator.model.FieldModel
 
getControllerFiles() - 类 中的静态方法io.github.yedaxia.apidocs.DocContext
get all controllers in this project
getControllerNode() - 类 中的方法io.github.yedaxia.apidocs.parser.RequestNode
 
getControllerNodeList() - 类 中的方法io.github.yedaxia.apidocs.doc.AbsDocGenerator
 
getControllerNodeList() - 类 中的静态方法io.github.yedaxia.apidocs.DocContext
 
getControllerNodes(String) - 类 中的静态方法io.github.yedaxia.apidocs.CacheUtils
get controller nodes of api version
getCurrentApiVersion() - 类 中的静态方法io.github.yedaxia.apidocs.DocContext
 
getDeprecated() - 类 中的方法io.github.yedaxia.apidocs.parser.RequestNode
 
getDescription() - 类 中的方法io.github.yedaxia.apidocs.parser.ClassNode
 
getDescription() - 类 中的方法io.github.yedaxia.apidocs.parser.ControllerNode
 
getDescription() - 类 中的方法io.github.yedaxia.apidocs.parser.FieldNode
 
getDescription() - 类 中的方法io.github.yedaxia.apidocs.parser.ParamNode
 
getDescription() - 类 中的方法io.github.yedaxia.apidocs.parser.RequestNode
 
getDocFileName() - 类 中的方法io.github.yedaxia.apidocs.parser.ControllerNode
 
getDocPath() - 类 中的静态方法io.github.yedaxia.apidocs.DocContext
api docs output path
getDocsConfig() - 类 中的静态方法io.github.yedaxia.apidocs.DocContext
 
getFieldName() - 类 中的方法io.github.yedaxia.apidocs.codegenerator.model.FieldModel
 
getFieldType() - 类 中的方法io.github.yedaxia.apidocs.codegenerator.model.FieldModel
 
getFreemarkerTemplate(String) - 类 中的静态方法io.github.yedaxia.apidocs.Resources
get freemarker template
getFromJavaFile() - 类 中的方法io.github.yedaxia.apidocs.parser.GenericNode
 
getGenerateDocs() - 类 中的方法io.github.yedaxia.apidocs.parser.ControllerNode
 
getGenericNode(int) - 类 中的方法io.github.yedaxia.apidocs.parser.ClassNode
 
getGenericNode(String) - 类 中的方法io.github.yedaxia.apidocs.parser.ClassNode
 
getGenericNodes() - 类 中的方法io.github.yedaxia.apidocs.parser.ClassNode
 
getHeader(String) - 类 中的方法io.github.yedaxia.apidocs.http.DHttpResponse
 
getHeader() - 类 中的方法io.github.yedaxia.apidocs.parser.RequestNode
 
getHeaders() - 类 中的方法io.github.yedaxia.apidocs.http.DHttpRequest
 
getHeaders() - 类 中的方法io.github.yedaxia.apidocs.http.DHttpResponse
 
getI18n() - 类 中的静态方法io.github.yedaxia.apidocs.DocContext
 
getIFieldType() - 类 中的方法io.github.yedaxia.apidocs.codegenerator.model.FieldModel
 
getIosCodePath() - 类 中的方法io.github.yedaxia.apidocs.parser.RequestNode
 
getIosFieldType(String) - 类 中的静态方法io.github.yedaxia.apidocs.codegenerator.provider.DocFieldHelper
 
getJavaFileName(File) - 类 中的静态方法io.github.yedaxia.apidocs.Utils
get file name without extension
getJavaSrcPaths() - 类 中的静态方法io.github.yedaxia.apidocs.DocContext
get java src paths
getJavaSrcPaths() - 类 中的方法io.github.yedaxia.apidocs.DocsConfig
 
getLastRequestNode() - 类 中的方法io.github.yedaxia.apidocs.parser.RequestNode
 
getLastVersionControllerNodes() - 类 中的静态方法io.github.yedaxia.apidocs.DocContext
 
getLimit() - 类 中的方法io.github.yedaxia.apidocs.parser.MockNode
 
getLocale() - 类 中的方法io.github.yedaxia.apidocs.DocsConfig
 
getLogFile() - 类 中的静态方法io.github.yedaxia.apidocs.DocContext
get log file path
getLoopNode() - 类 中的方法io.github.yedaxia.apidocs.parser.FieldNode
 
getMessage(String) - 类 中的方法io.github.yedaxia.apidocs.I18n
 
getMethod() - 类 中的方法io.github.yedaxia.apidocs.parser.RequestNode
 
getMethodName() - 类 中的方法io.github.yedaxia.apidocs.parser.RequestNode
 
getMockNode() - 类 中的方法io.github.yedaxia.apidocs.parser.FieldNode
 
getModelClass() - 类 中的方法io.github.yedaxia.apidocs.parser.ClassNode
 
getModelClass() - 类 中的方法io.github.yedaxia.apidocs.parser.GenericNode
 
getModuleNames(File) - 类 中的静态方法io.github.yedaxia.apidocs.Utils
get project modules name
getName() - 类 中的方法io.github.yedaxia.apidocs.parser.FieldNode
 
getName() - 类 中的方法io.github.yedaxia.apidocs.parser.ParamNode
 
getNotNull() - 类 中的方法io.github.yedaxia.apidocs.parser.FieldNode
 
getOpenReflection() - 类 中的方法io.github.yedaxia.apidocs.DocsConfig
 
getPackageName() - 类 中的方法io.github.yedaxia.apidocs.parser.ControllerNode
 
getParamNodeByName(String) - 类 中的方法io.github.yedaxia.apidocs.parser.RequestNode
 
getParamNodes() - 类 中的方法io.github.yedaxia.apidocs.parser.RequestNode
 
getParams() - 类 中的方法io.github.yedaxia.apidocs.http.DHttpRequest
 
getParentNode() - 类 中的方法io.github.yedaxia.apidocs.parser.ClassNode
 
getPlaceholder() - 类 中的方法io.github.yedaxia.apidocs.parser.GenericNode
 
getPrefFieldName(String) - 类 中的静态方法io.github.yedaxia.apidocs.codegenerator.provider.DocFieldHelper
 
getPrefFieldType(String) - 类 中的静态方法io.github.yedaxia.apidocs.codegenerator.provider.DocFieldHelper
 
getProjectName() - 类 中的方法io.github.yedaxia.apidocs.DocsConfig
 
getProjectPath() - 类 中的静态方法io.github.yedaxia.apidocs.DocContext
get project path
getRapAccount() - 类 中的方法io.github.yedaxia.apidocs.DocsConfig
 
getRapHost() - 类 中的方法io.github.yedaxia.apidocs.DocsConfig
 
getRapLoginCookie() - 类 中的方法io.github.yedaxia.apidocs.DocsConfig
 
getRapPassword() - 类 中的方法io.github.yedaxia.apidocs.DocsConfig
 
getRapProjectId() - 类 中的方法io.github.yedaxia.apidocs.DocsConfig
 
getRelativeCodeDir() - 类 中的方法io.github.yedaxia.apidocs.codegenerator.CodeGenerator
获取代码的写入的相对目录
getRelativeCodeDir() - 类 中的方法io.github.yedaxia.apidocs.codegenerator.ios.ModelCodeGenerator
 
getRelativeCodeDir() - 类 中的方法io.github.yedaxia.apidocs.codegenerator.java.JavaCodeGenerator
 
getRemoteFieldName() - 类 中的方法io.github.yedaxia.apidocs.codegenerator.model.FieldModel
 
getRequestNode() - 类 中的方法io.github.yedaxia.apidocs.parser.ResponseNode
 
getRequestNodes() - 类 中的方法io.github.yedaxia.apidocs.parser.ControllerNode
 
getResourcePath() - 类 中的方法io.github.yedaxia.apidocs.DocsConfig
 
getResponseNode() - 类 中的方法io.github.yedaxia.apidocs.parser.RequestNode
 
getResponseWrapper() - 类 中的静态方法io.github.yedaxia.apidocs.DocContext
 
getRouteNode(String) - 类 中的方法io.github.yedaxia.apidocs.parser.JFinalRoutesParser
 
getRouteNode(File, String) - 类 中的方法io.github.yedaxia.apidocs.parser.PlayRoutesParser
 
getRouteNodeList() - 类 中的方法io.github.yedaxia.apidocs.parser.JFinalRoutesParser
 
getRouteNodeList() - 类 中的方法io.github.yedaxia.apidocs.parser.PlayRoutesParser
 
getShowFieldNotNull() - 类 中的方法io.github.yedaxia.apidocs.parser.ClassNode
 
getSrcFileName() - 类 中的方法io.github.yedaxia.apidocs.parser.ControllerNode
 
getStream() - 类 中的方法io.github.yedaxia.apidocs.http.DHttpResponse
 
getTemplateFile(String) - 类 中的静态方法io.github.yedaxia.apidocs.Resources
get template file
getType() - 类 中的方法io.github.yedaxia.apidocs.parser.FieldNode
 
getType() - 类 中的方法io.github.yedaxia.apidocs.parser.ParamNode
 
getUrl() - 类 中的方法io.github.yedaxia.apidocs.http.DHttpRequest
 
getUrl() - 类 中的方法io.github.yedaxia.apidocs.parser.RequestNode
 
getValue() - 类 中的方法io.github.yedaxia.apidocs.parser.MockNode
 

H

handleResponseNode(ResponseNode, Type, File) - 类 中的方法io.github.yedaxia.apidocs.parser.AbsControllerParser
handle response object
handleResponseNode(ResponseNode, Type, File) - 类 中的方法io.github.yedaxia.apidocs.parser.SpringControllerParser
 
hasDirInFile(File, File, String) - 类 中的静态方法io.github.yedaxia.apidocs.Utils
judge dir is in file's path or not
HeaderNode - io.github.yedaxia.apidocs.parser中的类
Created by lzw on 2017/8/23.
HeaderNode(String, String) - 类 的构造器io.github.yedaxia.apidocs.parser.HeaderNode
 
HtmlControllerDocBuilder - io.github.yedaxia.apidocs.doc中的类
build html api docs for a controller
HtmlControllerDocBuilder() - 类 的构造器io.github.yedaxia.apidocs.doc.HtmlControllerDocBuilder
 
HtmlDocGenerator - io.github.yedaxia.apidocs.doc中的类
Html Api docs generator
HtmlDocGenerator() - 类 的构造器io.github.yedaxia.apidocs.doc.HtmlDocGenerator
 
httpGet(String) - 类 中的静态方法io.github.yedaxia.apidocs.http.DHttpUtils
send get request
httpPost(DHttpRequest) - 类 中的静态方法io.github.yedaxia.apidocs.http.DHttpUtils
send post request

I

I18n - io.github.yedaxia.apidocs中的类
 
I18n() - 类 的构造器io.github.yedaxia.apidocs.I18n
 
I18n(Locale) - 类 的构造器io.github.yedaxia.apidocs.I18n
 
ICodeBuilder - io.github.yedaxia.apidocs.codegenerator中的接口
 
IControllerDocBuilder - io.github.yedaxia.apidocs.doc中的接口
an interface of build a controller api docs
IFieldProvider - io.github.yedaxia.apidocs.codegenerator中的接口
 
Ignore - io.github.yedaxia.apidocs中的注释类型
Ignore Field
info(String, Object...) - 类 中的静态方法io.github.yedaxia.apidocs.LogUtils
 
init(DocsConfig) - 类 中的静态方法io.github.yedaxia.apidocs.DocContext
 
INSTANCE - 类 中的静态变量io.github.yedaxia.apidocs.parser.JFinalRoutesParser
 
INSTANCE - 类 中的静态变量io.github.yedaxia.apidocs.parser.PlayRoutesParser
 
io.github.yedaxia.apidocs - 程序包 io.github.yedaxia.apidocs
 
io.github.yedaxia.apidocs.codegenerator - 程序包 io.github.yedaxia.apidocs.codegenerator
 
io.github.yedaxia.apidocs.codegenerator.ios - 程序包 io.github.yedaxia.apidocs.codegenerator.ios
 
io.github.yedaxia.apidocs.codegenerator.ios.builder - 程序包 io.github.yedaxia.apidocs.codegenerator.ios.builder
 
io.github.yedaxia.apidocs.codegenerator.java - 程序包 io.github.yedaxia.apidocs.codegenerator.java
 
io.github.yedaxia.apidocs.codegenerator.java.builder - 程序包 io.github.yedaxia.apidocs.codegenerator.java.builder
 
io.github.yedaxia.apidocs.codegenerator.model - 程序包 io.github.yedaxia.apidocs.codegenerator.model
 
io.github.yedaxia.apidocs.codegenerator.provider - 程序包 io.github.yedaxia.apidocs.codegenerator.provider
 
io.github.yedaxia.apidocs.consts - 程序包 io.github.yedaxia.apidocs.consts
 
io.github.yedaxia.apidocs.doc - 程序包 io.github.yedaxia.apidocs.doc
 
io.github.yedaxia.apidocs.exception - 程序包 io.github.yedaxia.apidocs.exception
 
io.github.yedaxia.apidocs.http - 程序包 io.github.yedaxia.apidocs.http
 
io.github.yedaxia.apidocs.parser - 程序包 io.github.yedaxia.apidocs.parser
 
io.github.yedaxia.apidocs.plugin.markdown - 程序包 io.github.yedaxia.apidocs.plugin.markdown
 
io.github.yedaxia.apidocs.plugin.rap - 程序包 io.github.yedaxia.apidocs.plugin.rap
 
IPluginSupport - io.github.yedaxia.apidocs中的接口
an plugin interface, please feel free to to do what ever you want.
IResponseWrapper - io.github.yedaxia.apidocs中的接口
wrap response into a common structure, you should put the response into a map , for now this just use for upload apis to rap.
isAutoRedirect() - 类 中的方法io.github.yedaxia.apidocs.http.DHttpRequest
 
isCollectionType(String) - 类 中的静态方法io.github.yedaxia.apidocs.ParseUtils
is implements from Collection or not
isExcludeParam(Parameter) - 类 中的静态方法io.github.yedaxia.apidocs.ParseUtils
like HttpServletRequest, HttpServletSession should be auto ignore
isJFinalFramework(File) - 类 中的静态方法io.github.yedaxia.apidocs.Utils
the project is a jfinal framework or not
isJsonBody() - 类 中的方法io.github.yedaxia.apidocs.parser.ParamNode
 
isList() - 类 中的方法io.github.yedaxia.apidocs.parser.ClassNode
 
isModelType(String) - 类 中的静态方法io.github.yedaxia.apidocs.ParseUtils
is model type or not
isNotEmpty(String) - 类 中的静态方法io.github.yedaxia.apidocs.Utils
judge input string is not empty
isNotNullAnnotation(String) - 类 中的静态方法io.github.yedaxia.apidocs.ParseUtils
 
isPlayFramework(File) - 类 中的静态方法io.github.yedaxia.apidocs.Utils
the project is a play framework or not
isRequired() - 类 中的方法io.github.yedaxia.apidocs.parser.ParamNode
 
isSpringFramework(File) - 类 中的静态方法io.github.yedaxia.apidocs.Utils
the project is a spring mvc framework or not
isValueType(Object) - 类 中的静态方法io.github.yedaxia.apidocs.Utils
is value type or not

J

JavaClassBuilder - io.github.yedaxia.apidocs.codegenerator.java.builder中的类
Created by Darcy https://yedaxia.github.io/
JavaClassBuilder(String, String, String, String) - 类 的构造器io.github.yedaxia.apidocs.codegenerator.java.builder.JavaClassBuilder
 
JavaCodeGenerator - io.github.yedaxia.apidocs.codegenerator.java中的类
Created by Darcy https://yedaxia.github.io/
JavaCodeGenerator(ResponseNode) - 类 的构造器io.github.yedaxia.apidocs.codegenerator.java.JavaCodeGenerator
 
JavaFieldBuilder - io.github.yedaxia.apidocs.codegenerator.java.builder中的类
Created by Darcy https://yedaxia.github.io/
JavaFieldBuilder(String, FieldModel) - 类 的构造器io.github.yedaxia.apidocs.codegenerator.java.builder.JavaFieldBuilder
 
JavaFileNotFoundException - io.github.yedaxia.apidocs.exception中的异常错误
 
JavaFileNotFoundException() - 异常错误 的构造器io.github.yedaxia.apidocs.exception.JavaFileNotFoundException
 
JavaFileNotFoundException(String) - 异常错误 的构造器io.github.yedaxia.apidocs.exception.JavaFileNotFoundException
 
JavaGetterBuilder - io.github.yedaxia.apidocs.codegenerator.java.builder中的类
Created by Darcy https://yedaxia.github.io/
JavaGetterBuilder(String, FieldModel) - 类 的构造器io.github.yedaxia.apidocs.codegenerator.java.builder.JavaGetterBuilder
 
JavaSetterBuilder - io.github.yedaxia.apidocs.codegenerator.java.builder中的类
Created by Darcy https://yedaxia.github.io/
JavaSetterBuilder(String, FieldModel) - 类 的构造器io.github.yedaxia.apidocs.codegenerator.java.builder.JavaSetterBuilder
 
JavaTemplateProvider - io.github.yedaxia.apidocs.codegenerator.java中的类
Created by Darcy https://yedaxia.github.io/
JavaTemplateProvider() - 类 的构造器io.github.yedaxia.apidocs.codegenerator.java.JavaTemplateProvider
 
JFinalControllerParser - io.github.yedaxia.apidocs.parser中的类
use for JFinal
JFinalControllerParser() - 类 的构造器io.github.yedaxia.apidocs.parser.JFinalControllerParser
 
JFinalRoutesParser - io.github.yedaxia.apidocs.parser中的类
JFinal routes parser
JFinalRoutesParser.RouteNode - io.github.yedaxia.apidocs.parser中的类
 
joinArrayString(String[], String) - 类 中的静态方法io.github.yedaxia.apidocs.Utils
join string array , ( e.g.
jsonBody - 类 中的变量io.github.yedaxia.apidocs.parser.ParamNode
 
jsonToObject(String, Class<T>) - 类 中的静态方法io.github.yedaxia.apidocs.Utils
json string to object

L

LogUtils - io.github.yedaxia.apidocs中的类
a simple logger
LogUtils() - 类 的构造器io.github.yedaxia.apidocs.LogUtils
 

M

main(String[]) - 类 中的静态方法io.github.yedaxia.apidocs.Docs
 
MarkdownDocPlugin - io.github.yedaxia.apidocs.plugin.markdown中的类
export doc as markdown plugin
MarkdownDocPlugin() - 类 的构造器io.github.yedaxia.apidocs.plugin.markdown.MarkdownDocPlugin
 
method - 类 中的变量io.github.yedaxia.apidocs.parser.PlayRoutesParser.RouteNode
 
mkdirsForFile(File) - 类 中的静态方法io.github.yedaxia.apidocs.Utils
create dirs for file
MockNode - io.github.yedaxia.apidocs.parser中的类
mock node
MockNode() - 类 的构造器io.github.yedaxia.apidocs.parser.MockNode
 
ModelBuilder - io.github.yedaxia.apidocs.codegenerator.ios.builder中的类
 
ModelBuilder(String, String, String) - 类 的构造器io.github.yedaxia.apidocs.codegenerator.ios.builder.ModelBuilder
 
ModelCodeGenerator - io.github.yedaxia.apidocs.codegenerator.ios中的类
 
ModelCodeGenerator(ResponseNode) - 类 的构造器io.github.yedaxia.apidocs.codegenerator.ios.ModelCodeGenerator
 
ModelFieldBuilder - io.github.yedaxia.apidocs.codegenerator.ios.builder中的类
 
ModelFieldBuilder(String, FieldModel) - 类 的构造器io.github.yedaxia.apidocs.codegenerator.ios.builder.ModelFieldBuilder
 
ModelTemplateProvider - io.github.yedaxia.apidocs.codegenerator.ios中的类
 
ModelTemplateProvider() - 类 的构造器io.github.yedaxia.apidocs.codegenerator.ios.ModelTemplateProvider
 
MODIFY - 接口 中的静态变量io.github.yedaxia.apidocs.consts.ChangeFlag
 

N

name - 类 中的变量io.github.yedaxia.apidocs.parser.ParamNode
 
NEW - 接口 中的静态变量io.github.yedaxia.apidocs.consts.ChangeFlag
 
Null() - 类 的构造器io.github.yedaxia.apidocs.ApiDoc.Null
 

P

ParamNode - io.github.yedaxia.apidocs.parser中的类
a param node corresponds to a request parameter
ParamNode() - 类 的构造器io.github.yedaxia.apidocs.parser.ParamNode
 
parse(File) - 类 中的方法io.github.yedaxia.apidocs.parser.AbsControllerParser
 
parseClassNode(File, ClassNode) - 类 中的静态方法io.github.yedaxia.apidocs.ParseUtils
parse class model java file
parseClassNodeByReflection(ClassNode) - 类 中的静态方法io.github.yedaxia.apidocs.ParseUtils
通过反射解析对象字段
parseClassNodeByType(File, ClassNode, Type) - 类 中的静态方法io.github.yedaxia.apidocs.ParseUtils
parse class model java file
parseGenericNodesInType(Class, Type, List<GenericNode>) - 类 中的静态方法io.github.yedaxia.apidocs.ParseUtils
解析泛型
ParseUtils - io.github.yedaxia.apidocs中的类
some util methods during parse
ParseUtils() - 类 的构造器io.github.yedaxia.apidocs.ParseUtils
 
PlayControllerParser - io.github.yedaxia.apidocs.parser中的类
user for play framework
PlayControllerParser() - 类 的构造器io.github.yedaxia.apidocs.parser.PlayControllerParser
 
PlayRoutesParser - io.github.yedaxia.apidocs.parser中的类
play framework routes parser
PlayRoutesParser.RouteNode - io.github.yedaxia.apidocs.parser中的类
 
ProjectType - io.github.yedaxia.apidocs中的枚举
 
provideFields(ClassNode) - 接口 中的方法io.github.yedaxia.apidocs.codegenerator.IFieldProvider
get response fields
provideFields(ClassNode) - 类 中的方法io.github.yedaxia.apidocs.codegenerator.provider.DocFieldProvider
 
ProviderFactory - io.github.yedaxia.apidocs.codegenerator.provider中的类
Created by user on 2016/12/25.
ProviderFactory() - 类 的构造器io.github.yedaxia.apidocs.codegenerator.provider.ProviderFactory
 
provideTemplateForName(String) - 类 中的方法io.github.yedaxia.apidocs.codegenerator.ios.ModelTemplateProvider
 
provideTemplateForName(String) - 类 中的方法io.github.yedaxia.apidocs.codegenerator.java.JavaTemplateProvider
 
provideTemplateForName(String) - 类 中的静态方法io.github.yedaxia.apidocs.codegenerator.TemplateProvider
 

R

RapMock - io.github.yedaxia.apidocs中的注释类型
rap mock support annotation
RapSupportPlugin - io.github.yedaxia.apidocs.plugin.rap中的类
post request to rap : http://rapapi.org/
RapSupportPlugin() - 类 的构造器io.github.yedaxia.apidocs.plugin.rap.RapSupportPlugin
 
removeQuotations(String) - 类 中的静态方法io.github.yedaxia.apidocs.Utils
some parse url may has double quotation, remove them
RequestMethod - io.github.yedaxia.apidocs.parser中的枚举
request methods
RequestNode - io.github.yedaxia.apidocs.parser中的类
a request node corresponds to a controller method
RequestNode() - 类 的构造器io.github.yedaxia.apidocs.parser.RequestNode
 
required - 类 中的变量io.github.yedaxia.apidocs.parser.ParamNode
 
reset() - 类 中的方法io.github.yedaxia.apidocs.parser.ClassNode
 
Resources - io.github.yedaxia.apidocs中的类
 
Resources() - 类 的构造器io.github.yedaxia.apidocs.Resources
 
ResponseNode - io.github.yedaxia.apidocs.parser中的类
response node
ResponseNode() - 类 的构造器io.github.yedaxia.apidocs.parser.ResponseNode
 
RouteNode(String, String) - 类 的构造器io.github.yedaxia.apidocs.parser.JFinalRoutesParser.RouteNode
 
RouteNode(String, String, String, String) - 类 的构造器io.github.yedaxia.apidocs.parser.PlayRoutesParser.RouteNode
 
routeUrl - 类 中的变量io.github.yedaxia.apidocs.parser.PlayRoutesParser.RouteNode
 

S

SAME - 接口 中的静态变量io.github.yedaxia.apidocs.consts.ChangeFlag
 
saveControllerNodes(List<ControllerNode>) - 类 中的静态方法io.github.yedaxia.apidocs.CacheUtils
save controller nodes of this version
searchJavaFile(File, String) - 类 中的静态方法io.github.yedaxia.apidocs.ParseUtils
search File of className in the java file
setAndroidCodePath(String) - 类 中的方法io.github.yedaxia.apidocs.parser.RequestNode
 
setApiVersion(String) - 类 中的方法io.github.yedaxia.apidocs.DocsConfig
 
setAuthor(String) - 类 中的方法io.github.yedaxia.apidocs.parser.ControllerNode
 
setAuthor(String) - 类 中的方法io.github.yedaxia.apidocs.parser.RequestNode
 
setAutoGenerate(Boolean) - 类 中的方法io.github.yedaxia.apidocs.DocsConfig
 
setAutoRedirect(boolean) - 类 中的方法io.github.yedaxia.apidocs.http.DHttpRequest
 
setBaseUrl(String) - 类 中的方法io.github.yedaxia.apidocs.parser.ControllerNode
 
setCaseFieldName(String) - 类 中的方法io.github.yedaxia.apidocs.codegenerator.model.FieldModel
 
setChangeFlag(Byte) - 类 中的方法io.github.yedaxia.apidocs.parser.RequestNode
 
setChildGenericNode(List<GenericNode>) - 类 中的方法io.github.yedaxia.apidocs.parser.GenericNode
 
setChildNode(ClassNode) - 类 中的方法io.github.yedaxia.apidocs.parser.FieldNode
 
setChildNodes(List<FieldNode>) - 类 中的方法io.github.yedaxia.apidocs.parser.ClassNode
 
setClassFileName(String) - 类 中的方法io.github.yedaxia.apidocs.parser.ClassNode
 
setClassName(String) - 类 中的方法io.github.yedaxia.apidocs.parser.ClassNode
 
setClassName(String) - 类 中的方法io.github.yedaxia.apidocs.parser.ControllerNode
 
setClassNode(ClassNode) - 类 中的方法io.github.yedaxia.apidocs.parser.FieldNode
 
setClassType(Type) - 类 中的方法io.github.yedaxia.apidocs.parser.GenericNode
 
setCodeFileUrl(String) - 类 中的方法io.github.yedaxia.apidocs.parser.RequestNode
 
setComment(String) - 类 中的方法io.github.yedaxia.apidocs.codegenerator.model.FieldModel
 
setControllerNode(ControllerNode) - 类 中的方法io.github.yedaxia.apidocs.parser.RequestNode
 
setDebug() - 类 中的静态方法io.github.yedaxia.apidocs.Resources
 
setDeprecated(Boolean) - 类 中的方法io.github.yedaxia.apidocs.parser.RequestNode
 
setDescription(String) - 类 中的方法io.github.yedaxia.apidocs.parser.ClassNode
 
setDescription(String) - 类 中的方法io.github.yedaxia.apidocs.parser.ControllerNode
 
setDescription(String) - 类 中的方法io.github.yedaxia.apidocs.parser.FieldNode
 
setDescription(String) - 类 中的方法io.github.yedaxia.apidocs.parser.ParamNode
 
setDescription(String) - 类 中的方法io.github.yedaxia.apidocs.parser.RequestNode
 
setDocFileName(String) - 类 中的方法io.github.yedaxia.apidocs.parser.ControllerNode
 
setDocsPath(String) - 类 中的方法io.github.yedaxia.apidocs.DocsConfig
 
setFieldName(String) - 类 中的方法io.github.yedaxia.apidocs.codegenerator.model.FieldModel
 
setFieldType(String) - 类 中的方法io.github.yedaxia.apidocs.codegenerator.model.FieldModel
 
setFromJavaFile(File) - 类 中的方法io.github.yedaxia.apidocs.parser.GenericNode
 
setGenerateDocs(Boolean) - 类 中的方法io.github.yedaxia.apidocs.parser.ControllerNode
 
setGenericNodes(List<GenericNode>) - 类 中的方法io.github.yedaxia.apidocs.parser.ClassNode
 
setHeader(List<HeaderNode>) - 类 中的方法io.github.yedaxia.apidocs.parser.RequestNode
 
setHeaders(Map<String, String>) - 类 中的方法io.github.yedaxia.apidocs.http.DHttpRequest
 
setIosCodePath(String) - 类 中的方法io.github.yedaxia.apidocs.parser.RequestNode
 
setJsonBody(boolean) - 类 中的方法io.github.yedaxia.apidocs.parser.ParamNode
 
setLastRequestNode(RequestNode) - 类 中的方法io.github.yedaxia.apidocs.parser.RequestNode
 
setLimit(String) - 类 中的方法io.github.yedaxia.apidocs.parser.MockNode
 
setList(Boolean) - 类 中的方法io.github.yedaxia.apidocs.parser.ClassNode
 
setLocale(Locale) - 类 中的方法io.github.yedaxia.apidocs.DocsConfig
 
setLoopNode(Boolean) - 类 中的方法io.github.yedaxia.apidocs.parser.FieldNode
 
setMethod(List<String>) - 类 中的方法io.github.yedaxia.apidocs.parser.RequestNode
 
setMethodName(String) - 类 中的方法io.github.yedaxia.apidocs.parser.RequestNode
 
setMockNode(MockNode) - 类 中的方法io.github.yedaxia.apidocs.parser.FieldNode
 
setModelClass(Class) - 类 中的方法io.github.yedaxia.apidocs.parser.ClassNode
 
setModelClass(Class) - 类 中的方法io.github.yedaxia.apidocs.parser.GenericNode
 
setMvcFramework(String) - 类 中的方法io.github.yedaxia.apidocs.DocsConfig
 
setName(String) - 类 中的方法io.github.yedaxia.apidocs.parser.FieldNode
 
setName(String) - 类 中的方法io.github.yedaxia.apidocs.parser.ParamNode
 
setNotNull(Boolean) - 类 中的方法io.github.yedaxia.apidocs.parser.FieldNode
 
setOpenReflection(Boolean) - 类 中的方法io.github.yedaxia.apidocs.DocsConfig
 
setPackageName(String) - 类 中的方法io.github.yedaxia.apidocs.parser.ControllerNode
 
setParamNodes(List<ParamNode>) - 类 中的方法io.github.yedaxia.apidocs.parser.RequestNode
 
setParams(Map<String, String>) - 类 中的方法io.github.yedaxia.apidocs.http.DHttpRequest
 
setParentNode(ClassNode) - 类 中的方法io.github.yedaxia.apidocs.parser.ClassNode
 
setPlaceholder(String) - 类 中的方法io.github.yedaxia.apidocs.parser.GenericNode
 
setProjectName(String) - 类 中的方法io.github.yedaxia.apidocs.DocsConfig
 
setProjectPath(String) - 类 中的方法io.github.yedaxia.apidocs.DocsConfig
 
setRemoteFieldName(String) - 类 中的方法io.github.yedaxia.apidocs.codegenerator.model.FieldModel
 
setRequestNode(RequestNode) - 类 中的方法io.github.yedaxia.apidocs.parser.ResponseNode
 
setRequestNodes(List<RequestNode>) - 类 中的方法io.github.yedaxia.apidocs.parser.ControllerNode
 
setRequired(boolean) - 类 中的方法io.github.yedaxia.apidocs.parser.ParamNode
 
setResourcePath(String) - 类 中的方法io.github.yedaxia.apidocs.DocsConfig
 
setResponseNode(ResponseNode) - 类 中的方法io.github.yedaxia.apidocs.parser.RequestNode
 
setResponseWrapper(IResponseWrapper) - 类 中的静态方法io.github.yedaxia.apidocs.Docs
wrap response into a common structure,don't forget to put responseNode into map.
setShowFieldNotNull(Boolean) - 类 中的方法io.github.yedaxia.apidocs.parser.ClassNode
 
setSrcFileName(String) - 类 中的方法io.github.yedaxia.apidocs.parser.ControllerNode
 
setType(String) - 类 中的方法io.github.yedaxia.apidocs.parser.FieldNode
 
setType(String) - 类 中的方法io.github.yedaxia.apidocs.parser.ParamNode
 
setUrl(String) - 类 中的方法io.github.yedaxia.apidocs.http.DHttpRequest
 
setUrl(String) - 类 中的方法io.github.yedaxia.apidocs.parser.RequestNode
 
setValue(String) - 类 中的方法io.github.yedaxia.apidocs.parser.MockNode
 
SpringControllerParser - io.github.yedaxia.apidocs.parser中的类
use for spring mvc
SpringControllerParser() - 类 的构造器io.github.yedaxia.apidocs.parser.SpringControllerParser
 
streamAsString() - 类 中的方法io.github.yedaxia.apidocs.http.DHttpResponse
 
streamToString(InputStream) - 类 中的静态方法io.github.yedaxia.apidocs.Utils
simple read stream to String

T

TemplateProvider - io.github.yedaxia.apidocs.codegenerator中的类
 
TemplateProvider() - 类 的构造器io.github.yedaxia.apidocs.codegenerator.TemplateProvider
 
toJson(Object) - 类 中的静态方法io.github.yedaxia.apidocs.Utils
object to simple json
toJsonApi() - 类 中的方法io.github.yedaxia.apidocs.parser.ClassNode
 
toPrettyJson(Object) - 类 中的静态方法io.github.yedaxia.apidocs.Utils
object to pretty json
type - 类 中的变量io.github.yedaxia.apidocs.parser.ParamNode
 

U

unifyType(String) - 类 中的静态方法io.github.yedaxia.apidocs.ParseUtils
unify the type show in docs
Utils - io.github.yedaxia.apidocs中的类
 
Utils() - 类 的构造器io.github.yedaxia.apidocs.Utils
 

V

valueOf(String) - 枚举 中的静态方法io.github.yedaxia.apidocs.BuildToolType
返回带有指定名称的该类型的枚举常量。
valueOf(String) - 枚举 中的静态方法io.github.yedaxia.apidocs.parser.RequestMethod
返回带有指定名称的该类型的枚举常量。
valueOf(String) - 枚举 中的静态方法io.github.yedaxia.apidocs.ProjectType
返回带有指定名称的该类型的枚举常量。
values() - 枚举 中的静态方法io.github.yedaxia.apidocs.BuildToolType
按照声明该枚举类型的常量的顺序, 返回 包含这些常量的数组。
values() - 枚举 中的静态方法io.github.yedaxia.apidocs.parser.RequestMethod
按照声明该枚举类型的常量的顺序, 返回 包含这些常量的数组。
values() - 枚举 中的静态方法io.github.yedaxia.apidocs.ProjectType
按照声明该枚举类型的常量的顺序, 返回 包含这些常量的数组。

W

warn(String, Object...) - 类 中的静态方法io.github.yedaxia.apidocs.LogUtils
 
wideSearchFile(File, FilenameFilter, List<File>, boolean) - 类 中的静态方法io.github.yedaxia.apidocs.Utils
search files match filter, store in result
wrapResponse(ResponseNode) - 接口 中的方法io.github.yedaxia.apidocs.IResponseWrapper
to wrap response , don't forget to put responseNode into map.
writeToDisk(File, String) - 类 中的静态方法io.github.yedaxia.apidocs.Utils
write content to file
A B C D E F G H I J L M N P R S T U V W 
跳过导航链接