gu.doc

类 ExtClassDoc

java.lang.Object

gu.doc.ExtClassDoc

public class ExtClassDoc
extends java.lang.Object

嵌套类概要

嵌套类

限定符和类型	类和说明
static class	ExtClassDoc.Action
static class	ExtClassDoc.AddColumn

字段概要

字段

限定符和类型	字段和说明
static java.lang.String	NEW_LINE

构造器概要

构造器

构造器和说明
ExtClassDoc(com.sun.javadoc.ClassDoc classDoc)

方法概要

限定符和类型	方法和说明
void	addExcludeTag(java.lang.String excludeTag)
void	addExcludeTag(java.lang.String excludeTag, java.util.Collection<gu.doc.ExtClassDoc.Type> type)
void	addExcludeTag(java.lang.String excludeTag, gu.doc.ExtClassDoc.Type type)
void	addExcludeTag(java.lang.String excludeTag, java.lang.Integer scope)
void	addExcludeTag(java.lang.String excludeTag, java.lang.String type)
void	addExcludeTags(java.util.Map<java.lang.String,java.lang.Integer> excludeTag)
void	addExcludeTagString(java.lang.String excludeTag, java.util.Collection<java.lang.String> type)
void	additionalText(java.lang.String text, ExtClassDoc.Action action, java.util.Collection<gu.doc.ExtClassDoc.Type> type)
void	additionalText(java.lang.String text, ExtClassDoc.Action action, gu.doc.ExtClassDoc.Type... type)
void	additionalText(java.lang.String text, ExtClassDoc.Action action, java.lang.Integer scope)
void	additionalText(java.lang.String text, java.lang.String action, java.util.Collection<java.lang.String> type)
void	additionalText(java.lang.String text, java.lang.String action, java.lang.String type)
java.lang.String	formatComment(com.sun.javadoc.Doc doc, boolean needIndent) 输出格式化的注释信息
java.util.List<java.lang.String>	formatCommentAsList(com.sun.javadoc.Doc doc, boolean needIndent, boolean withLinePrefix) 输出格式化的注释信息,返回以行为单位的字符串表
java.lang.String	getClassComment()
java.lang.String	getClassComment(boolean withBody, boolean withLinePrefix)
java.util.List<java.lang.String>	getClassCommentAsList()
java.util.List<java.lang.String>	getClassCommentAsList(boolean needIndent, boolean withLinePrefix)
com.sun.javadoc.ClassDoc	getClassDoc()
com.sun.javadoc.ExecutableMemberDoc	getExecutableMemberDoc(java.lang.reflect.Member member) 在ClassDoc中查找与method匹配的ExecutableMemberDoc
java.lang.String	getFieldComment(java.lang.String name)
java.lang.String	getFieldComment(java.lang.String name, boolean withBody, boolean withLinePrefix)
java.util.List<java.lang.String>	getFieldCommentAsList(java.lang.String name)
java.util.List<java.lang.String>	getFieldCommentAsList(java.lang.String name, boolean needIndent, boolean withLinePrefix)
com.sun.javadoc.FieldDoc	getFieldDoc(java.lang.String name) 在ClassDoc中查找与name匹配的FieldDoc
static java.lang.String	getIndent()
com.sun.javadoc.MemberDoc	getMemberDoc(java.lang.reflect.Member member) 在ClassDoc中查找与method匹配的MemberDoc
java.lang.String	getMethodComment(java.lang.reflect.Method method)
java.lang.String	getMethodComment(java.lang.reflect.Method method, boolean withBody, boolean withLinePrefix)
java.util.List<java.lang.String>	getMethodCommentAsList(java.lang.reflect.Method method)
java.util.List<java.lang.String>	getMethodCommentAsList(java.lang.reflect.Method method, boolean needIndent, boolean withLinePrefix)
com.sun.javadoc.MethodDoc	getMethodDoc(java.lang.reflect.Method method) 在ClassDoc中查找与method匹配的MethodDoc
java.lang.String[]	getParamerNames(java.lang.reflect.Member member) 在ClassDoc中查找指定方法或构造方法的参数名
java.util.Map<java.lang.reflect.Method,java.lang.Integer>	indexOf(java.util.List<java.lang.reflect.Method> methods) 返回methods在ClassDoc 定义顺序索引,methods为null时返回空map
int	indexOf(java.lang.reflect.Member member) 在ClassDoc中查找与method匹配的ExecutableMemberDoc对象的索引 不采用注释掉的同名方法的原因是直接对签名进行字符串比较的方法不能适应独立运行环境， 因为ExecutableMemberDoc返回的方法签名中类名并一定是全名
java.lang.String	output()
void	output(java.io.PrintStream out) 输出当前类的类及方法注释信息
com.sun.javadoc.ParamTag	paramTagOf(com.sun.javadoc.MethodDoc methodDoc, java.lang.String name)
void	removeExcludeTag(java.lang.String excludeTag)
void	setExcludeTags(java.util.Map<java.lang.String,java.lang.Integer> excludeTags)
static void	setIndent(java.lang.String indent)
java.util.List<java.lang.reflect.Method>	sortByDefined(java.util.List<java.lang.reflect.Method> methods) 将methods按ClassDoc 定义的顺序重新排序

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

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

字段详细资料

NEW_LINE

public static final java.lang.String NEW_LINE

构造器详细资料

ExtClassDoc

public ExtClassDoc(com.sun.javadoc.ClassDoc classDoc)

方法详细资料

getMethodDoc

public com.sun.javadoc.MethodDoc getMethodDoc(java.lang.reflect.Method method)

在ClassDoc中查找与method匹配的MethodDoc

参数:

method - method

返回:

没有找则返回null

另请参阅:

indexOf(Member)

getExecutableMemberDoc

public com.sun.javadoc.ExecutableMemberDoc getExecutableMemberDoc(java.lang.reflect.Member member)

在ClassDoc中查找与method匹配的ExecutableMemberDoc

参数:

member - member

返回:

没有找则返回null

另请参阅:

indexOf(Member)

getMemberDoc

public com.sun.javadoc.MemberDoc getMemberDoc(java.lang.reflect.Member member)

在ClassDoc中查找与method匹配的MemberDoc

参数:

member - member

返回:

没有找则返回null

另请参阅:

getFieldDoc(String), getExecutableMemberDoc(Member)

getParamerNames

public java.lang.String[] getParamerNames(java.lang.reflect.Member member)

在ClassDoc中查找指定方法或构造方法的参数名

参数:

member - Method or Constructor

返回:

参数名列表,找不到返回null

getFieldDoc

public com.sun.javadoc.FieldDoc getFieldDoc(java.lang.String name)

在ClassDoc中查找与name匹配的FieldDoc

参数:

name - field name

返回:

没有找则返回null

paramTagOf

public com.sun.javadoc.ParamTag paramTagOf(com.sun.javadoc.MethodDoc methodDoc,
                                           java.lang.String name)

indexOf

public int indexOf(java.lang.reflect.Member member)

在ClassDoc中查找与method匹配的ExecutableMemberDoc对象的索引
不采用注释掉的同名方法的原因是直接对签名进行字符串比较的方法不能适应独立运行环境， 因为ExecutableMemberDoc返回的方法签名中类名并一定是全名

参数:

member - Method OR Constructor

返回:

返回method定义方法在ClassDoc.methods()或ClassDoc.constructors()数组中的索引,没有找则返回 -1

sortByDefined

public java.util.List<java.lang.reflect.Method> sortByDefined(java.util.List<java.lang.reflect.Method> methods)

将methods按ClassDoc 定义的顺序重新排序

参数:

methods - 方法列表

返回:

methods

indexOf

public java.util.Map<java.lang.reflect.Method,java.lang.Integer> indexOf(java.util.List<java.lang.reflect.Method> methods)

返回methods在ClassDoc 定义顺序索引,methods为null时返回空map

参数:

methods -

返回:

方法--索引 映射

output

public void output(java.io.PrintStream out)

输出当前类的类及方法注释信息

参数:

out - 输出对象

output

public java.lang.String output()

formatComment

public final java.lang.String formatComment(com.sun.javadoc.Doc doc,
                                            boolean needIndent)

输出格式化的注释信息

参数:

doc - Doc 实例

needIndent - 是否缩进

返回:

格式的注释信息字符串

formatCommentAsList

public final java.util.List<java.lang.String> formatCommentAsList(com.sun.javadoc.Doc doc,
                                                                  boolean needIndent,
                                                                  boolean withLinePrefix)

输出格式化的注释信息,返回以行为单位的字符串表

参数:

doc - Doc 实例

needIndent - 是否缩进

withLinePrefix - 是否添行注释前缀

返回:

以行为单位的格式的注释信息字符串

getClassComment

public java.lang.String getClassComment(boolean withBody,
                                        boolean withLinePrefix)

getMethodComment

public java.lang.String getMethodComment(java.lang.reflect.Method method,
                                         boolean withBody,
                                         boolean withLinePrefix)

getFieldComment

public java.lang.String getFieldComment(java.lang.String name,
                                        boolean withBody,
                                        boolean withLinePrefix)

getClassComment

public java.lang.String getClassComment()

getMethodComment

public java.lang.String getMethodComment(java.lang.reflect.Method method)

getFieldComment

public java.lang.String getFieldComment(java.lang.String name)

getClassCommentAsList

public java.util.List<java.lang.String> getClassCommentAsList(boolean needIndent,
                                                              boolean withLinePrefix)

getMethodCommentAsList

public java.util.List<java.lang.String> getMethodCommentAsList(java.lang.reflect.Method method,
                                                               boolean needIndent,
                                                               boolean withLinePrefix)

getFieldCommentAsList

public java.util.List<java.lang.String> getFieldCommentAsList(java.lang.String name,
                                                              boolean needIndent,
                                                              boolean withLinePrefix)

getClassCommentAsList

public java.util.List<java.lang.String> getClassCommentAsList()

getMethodCommentAsList

public java.util.List<java.lang.String> getMethodCommentAsList(java.lang.reflect.Method method)

getFieldCommentAsList

public java.util.List<java.lang.String> getFieldCommentAsList(java.lang.String name)

getIndent

public static java.lang.String getIndent()

返回:

indent

setIndent

public static void setIndent(java.lang.String indent)

参数:

indent - 要设置的 indent

setExcludeTags

public void setExcludeTags(java.util.Map<java.lang.String,java.lang.Integer> excludeTags)

参数:

excludeTags - 要设置的 excludeTags

addExcludeTag

public void addExcludeTag(java.lang.String excludeTag,
                          java.lang.Integer scope)

removeExcludeTag

public void removeExcludeTag(java.lang.String excludeTag)

addExcludeTag

public void addExcludeTag(java.lang.String excludeTag,
                          gu.doc.ExtClassDoc.Type type)

addExcludeTag

public void addExcludeTag(java.lang.String excludeTag,
                          java.util.Collection<gu.doc.ExtClassDoc.Type> type)

addExcludeTag

public void addExcludeTag(java.lang.String excludeTag,
                          java.lang.String type)

addExcludeTagString

public void addExcludeTagString(java.lang.String excludeTag,
                                java.util.Collection<java.lang.String> type)

addExcludeTag

public void addExcludeTag(java.lang.String excludeTag)

addExcludeTags

public void addExcludeTags(java.util.Map<java.lang.String,java.lang.Integer> excludeTag)

additionalText

public void additionalText(java.lang.String text,
                           ExtClassDoc.Action action,
                           java.lang.Integer scope)

additionalText

public void additionalText(java.lang.String text,
                           ExtClassDoc.Action action,
                           gu.doc.ExtClassDoc.Type... type)

additionalText

public void additionalText(java.lang.String text,
                           java.lang.String action,
                           java.lang.String type)

additionalText

public void additionalText(java.lang.String text,
                           ExtClassDoc.Action action,
                           java.util.Collection<gu.doc.ExtClassDoc.Type> type)

additionalText

public void additionalText(java.lang.String text,
                           java.lang.String action,
                           java.util.Collection<java.lang.String> type)

getClassDoc

public com.sun.javadoc.ClassDoc getClassDoc()

返回:

classDoc