cn.mapway.document.module

类 ApiDoc

java.lang.Object

cn.mapway.document.module.ApiDoc

所有已实现的接口:

Serializable

public class ApiDoc
extends Object
implements Serializable

ApiDoc V2.

作者:

zhangjianshe

另请参阅:

序列化表格

字段概要

字段

限定符和类型	字段和说明
String	apiVersion API版本号
String	author 作者.
String	basePath 接口访问的基地址.
String	copyright API 的整体说明文档.
String	cssStyle 自定义样式.
String	description API 的整体说明文档.
String	domain API 的整体说明文档.
String	homeUrl 首页链接
String	link API关联网址.
String	logo LOGO BASE64编码数据
Group	root API分组的根节点.
String	summary API简介.
String	title 标题.
String	version API版本.
String	wordUrl 用户设置导出WordURL地址.

构造器概要

构造器

构造器和说明
ApiDoc() Instantiates a new api doc.

方法概要

限定符和类型	方法和说明
Group	findGroup(String path) 根据路径查找Group,如果不存在这个路径的对象，就在树中创建这个路径.
List<JarInfo>	getDownloads() Gets the downloads.
void	processFullName() Process full name.
void	sort() Sort.

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

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

字段详细资料

wordUrl

public String wordUrl

用户设置导出WordURL地址.

author

public String author

作者.

title

public String title

标题.

version

public String version

API版本.

link

public String link

API关联网址.

summary

public String summary

API简介.

description

public String description

API 的整体说明文档.

copyright

public String copyright

API 的整体说明文档.

domain

public String domain

API 的整体说明文档.

basePath

public String basePath

接口访问的基地址.

logo

public String logo

LOGO BASE64编码数据

apiVersion

public String apiVersion

API版本号

root

public Group root

API分组的根节点.

homeUrl

public String homeUrl

首页链接

cssStyle

public String cssStyle

自定义样式.

构造器详细资料

ApiDoc

public ApiDoc()

Instantiates a new api doc.

方法详细资料

findGroup

public Group findGroup(String path)

根据路径查找Group,如果不存在这个路径的对象，就在树中创建这个路径.

参数:

path - the path

返回:

the group

sort

public void sort()

Sort.

processFullName

public void processFullName()

Process full name.

getDownloads

public List<JarInfo> getDownloads()

Gets the downloads.

返回:

the downloads