cn.mapway.document.helper

类 DocHelper

java.lang.Object

cn.mapway.document.helper.DocHelper

public class DocHelper
extends Object

辅助类.

作者:

zhangjianshe

构造器概要

构造器

构造器和说明
DocHelper()

方法概要

限定符和类型	方法和说明
String	genDoc(ParseType pt, GenContext context, String... packages) 生成Word File.
String	genHTML(ApiDoc doc) 生成文档.
String	genHTML(ParseType pt, GenContext context, String... packages) 生成HTML文档.
static byte[]	getClearGifData() 获取透明 1X1 像素的GIF图片数据.
List<JarInfo>	jar(ApiDoc api, String path, String packageName, String className, String libPath) Jar.
void	setAntHome(String home) Sets the ant home.
ApiDoc	toDoc(ParseType pt, GenContext context, String... packages) 生成接口文档JSON格式.
void	toWord(ApiDoc api, String fileName) 生成WORD文档.

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

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

构造器详细资料

DocHelper

public DocHelper()

方法详细资料

setAntHome

public void setAntHome(String home)

Sets the ant home.

参数:

home - the new ant home

toWord

public void toWord(ApiDoc api,
                   String fileName)
            throws IOException

生成WORD文档.

参数:

api - the api

fileName - the file name

抛出:

IOException - Signals that an I/O exception has occurred.

toDoc

public ApiDoc toDoc(ParseType pt,
                    GenContext context,
                    String... packages)

生成接口文档JSON格式.

参数:

pt - the pt

context - the context

packages - the packages

返回:

the api doc

genHTML

public String genHTML(ParseType pt,
                      GenContext context,
                      String... packages)

生成HTML文档.

参数:

pt - the pt

context - the context

packages - the packages

返回:

the string

genHTML

public String genHTML(ApiDoc doc)

生成文档.

参数:

doc - the doc

返回:

the string

getClearGifData

public static byte[] getClearGifData()

获取透明 1X1 像素的GIF图片数据.

返回:

the clear gif data

genDoc

public String genDoc(ParseType pt,
                     GenContext context,
                     String... packages)

生成Word File.

参数:

pt - the pt

context - the context

packages - the packages

返回:

the string

jar

public List<JarInfo> jar(ApiDoc api,
                         String path,
                         String packageName,
                         String className,
                         String libPath)

Jar.

参数:

api - the api

path - the path

packageName - the package name

className - the class name

libPath - the lib path

返回:

the list