类的使用
cn.mapway.document.module.ApiDoc

使用ApiDoc的程序包

程序包	说明
cn.mapway.document.helper
cn.mapway.document.parser
cn.mapway.document.word

cn.mapway.document.helper中ApiDoc的使用

返回ApiDoc的cn.mapway.document.helper中的方法

限定符和类型	方法和说明
ApiDoc	DocHelper.toDoc(ParseType pt, GenContext context, String... packages) 生成接口文档JSON格式.

参数类型为ApiDoc的cn.mapway.document.helper中的方法

限定符和类型	方法和说明
String	JavaConnextorExport.export(ApiDoc api, String packageName, String className) 输出API 对应的 Java Connector public resp doSomthing(Req req) { }.
String	GwtConnextorExport.export(ApiDoc api, String packageName, String className) 输出API 对应的 Java Connector public resp doSomthing(Req req) { }.
String	DocHelper.genHTML(ApiDoc doc) 生成文档.
List<JarInfo>	JarHelper.jar(ApiDoc api, String path, String packageName, String className, String libPath) 输出Jar包到指定的目录.
List<JarInfo>	DocHelper.jar(ApiDoc api, String path, String packageName, String className, String libPath) Jar.
void	DocHelper.toWord(ApiDoc api, String fileName) 生成WORD文档.

cn.mapway.document.parser中ApiDoc的使用

返回ApiDoc的cn.mapway.document.parser中的方法

限定符和类型	方法和说明
ApiDoc	SpringParser.parse(GenContext context, String... packageNames) 解析包中的类.

cn.mapway.document.word中ApiDoc的使用

参数类型为ApiDoc的cn.mapway.document.word中的方法

限定符和类型	方法和说明
void	WordExport.toWord(ApiDoc api, String fileName) 转成WORD文件格式.