org.nutz.boot.tools

类 PropDocReader

java.lang.Object

org.nutz.boot.tools.PropDocReader

public class PropDocReader
extends Object

默认的@ProcDoc读取器

作者:

wendal(wendal1985@gmail.com)

字段概要

字段

限定符和类型	字段和说明
protected AppContext	appContext 全局上下文
protected Map<String,PropDocBean>	docs 文档列表

构造器概要

构造器

构造器和说明
PropDocReader()

方法概要

限定符和类型	方法和说明
void	add(String klassName, String key, PropDocBean newdoc)
void	addClass(Class<?> klass) 逐个添加需要加载的类
Map<String,PropDocBean>	getDocs() 获取原始文档数据,通常用于生成Json文本
void	load(List<Class<?>> starterClasses)
String	toMarkdown()

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

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

字段详细资料

appContext

protected AppContext appContext

全局上下文

docs

protected Map<String,PropDocBean> docs

文档列表

构造器详细资料

PropDocReader

public PropDocReader()

方法详细资料

load

public void load(List<Class<?>> starterClasses)
          throws Exception

抛出:

Exception

addClass

public void addClass(Class<?> klass)
              throws Exception

逐个添加需要加载的类

参数:

klass - 需要加载的类

抛出:

Exception - 不太可能会抛出异常的异常

add

public void add(String klassName,
                String key,
                PropDocBean newdoc)

toMarkdown

public String toMarkdown()

getDocs

public Map<String,PropDocBean> getDocs()

获取原始文档数据,通常用于生成Json文本

返回:

原始文档数据