程序包 io.github.yedaxia.apidocs

类 DocContext

  • public class DocContext
extends java.lang.Object
    to judge project which framework is using and make some initialization

    • 构造器详细资料

      • 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.
        返回:

      • 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()