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	author 作者
String	basePath 接口访问的基地址
String	description API 的整体说明文档
String	link API关联网址
Group	root API分组的根节点
String	summary API简介
String	title 标题
String	version API版本

构造器概要

构造器

构造器和说明
ApiDoc()

方法概要

限定符和类型	方法和说明
Group	findGroup(String path) 根据路径查找Group,如果不存在这个路径的对象，就在树中创建这个路径.
void	processFullName()
void	sort()

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

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

字段详细资料

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 的整体说明文档

basePath

public String basePath

接口访问的基地址

root

public Group root

API分组的根节点

构造器详细资料

ApiDoc

public ApiDoc()

方法详细资料

findGroup

public Group findGroup(String path)

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

参数:

path -

返回:

sort

public void sort()

processFullName

public void processFullName()