cn.mapway.document.meta.module

类 ApiDocument

java.lang.Object

cn.mapway.document.meta.module.ApiDocument

public class ApiDocument
extends Object

Api文档结构.

作者:

zhangjianshe@navinfo.com

字段概要

字段

限定符和类型	字段和说明
String	author 文档作者.
String	basePath 控制器入口路径.
String	clsName 类名称.
ApiGroup	root API根节点.
String	title API标题.

构造器概要

构造器

构造器和说明
ApiDocument() Instantiates a new api document.

方法概要

限定符和类型	方法和说明
ApiGroup	findGroup(String path) 根据路径查找ApiGroup,如果不存在这个路径的对象，就在树中创建这个路径.
static void	main(String[] args) The main method.
void	sort() 按照字典规则排序 Group和Entry.

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

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

字段详细资料

clsName

public String clsName

类名称.

title

public String title

API标题.

author

public String author

文档作者.

basePath

public String basePath

控制器入口路径.

root

public ApiGroup root

API根节点.

构造器详细资料

ApiDocument

public ApiDocument()

Instantiates a new api document.

方法详细资料

sort

public void sort()

按照字典规则排序 Group和Entry.

findGroup

public ApiGroup findGroup(String path)

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

参数:

path - the path

返回:

the api group

main

public static void main(String[] args)

The main method.

参数:

args - the arguments