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 |
commentTextOf(java.lang.reflect.Method method)
在
ClassDoc中查找与method匹配的MethodDoc,返回注释信息字符串 |
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)
已过时。
unused
|
java.lang.String |
output() |
void |
output(java.io.PrintStream out)
输出当前类的类及方法注释信息
|
java.lang.String |
parameterCommentOf(java.lang.reflect.Method method,
java.lang.String name)
在
ClassDoc中查找方法的指定参数名称的注释信息字符串 |
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)
已过时。
unused
|
public com.sun.javadoc.MethodDoc getMethodDoc(java.lang.reflect.Method method)
ClassDoc中查找与method匹配的MethodDocmethod - methodnullindexOf(Member)public com.sun.javadoc.ExecutableMemberDoc getExecutableMemberDoc(java.lang.reflect.Member member)
ClassDoc中查找与method匹配的ExecutableMemberDocmember - membernullgetExecutableMemberDoc(ClassDoc, Member)public com.sun.javadoc.MemberDoc getMemberDoc(java.lang.reflect.Member member)
ClassDoc中查找与method匹配的MemberDocmember - membernullgetFieldDoc(String),
getExecutableMemberDoc(Member)public java.lang.String[] getParamerNames(java.lang.reflect.Member member)
ClassDoc中查找指定方法或构造方法的参数名member - Method or Constructorpublic com.sun.javadoc.FieldDoc getFieldDoc(java.lang.String name)
ClassDoc中查找与name匹配的FieldDocname - field namenullpublic com.sun.javadoc.ParamTag paramTagOf(com.sun.javadoc.MethodDoc methodDoc,
java.lang.String name)
public java.util.List<java.lang.reflect.Method> sortByDefined(java.util.List<java.lang.reflect.Method> methods)
methods按ClassDoc 定义的顺序重新排序methods - 方法列表methodspublic java.util.Map<java.lang.reflect.Method,java.lang.Integer> indexOf(java.util.List<java.lang.reflect.Method> methods)
methods在ClassDoc 定义顺序索引,methods为null时返回空mapmethods - public void output(java.io.PrintStream out)
out - 输出对象public java.lang.String output()
public final java.lang.String formatComment(com.sun.javadoc.Doc doc,
boolean needIndent)
doc - Doc 实例needIndent - 是否缩进public final java.util.List<java.lang.String> formatCommentAsList(com.sun.javadoc.Doc doc,
boolean needIndent,
boolean withLinePrefix)
doc - Doc 实例needIndent - 是否缩进withLinePrefix - 是否添行注释前缀public java.lang.String getClassComment(boolean withBody,
boolean withLinePrefix)
public java.lang.String getMethodComment(java.lang.reflect.Method method,
boolean withBody,
boolean withLinePrefix)
public java.lang.String getFieldComment(java.lang.String name,
boolean withBody,
boolean withLinePrefix)
public java.lang.String getClassComment()
public java.lang.String getMethodComment(java.lang.reflect.Method method)
public java.lang.String getFieldComment(java.lang.String name)
public java.util.List<java.lang.String> getClassCommentAsList(boolean needIndent,
boolean withLinePrefix)
public java.util.List<java.lang.String> getMethodCommentAsList(java.lang.reflect.Method method,
boolean needIndent,
boolean withLinePrefix)
public java.util.List<java.lang.String> getFieldCommentAsList(java.lang.String name,
boolean needIndent,
boolean withLinePrefix)
public java.util.List<java.lang.String> getClassCommentAsList()
public java.util.List<java.lang.String> getMethodCommentAsList(java.lang.reflect.Method method)
public java.util.List<java.lang.String> getFieldCommentAsList(java.lang.String name)
public java.lang.String commentTextOf(java.lang.reflect.Method method)
ClassDoc中查找与method匹配的MethodDoc,返回注释信息字符串method - methodgetMethodDoc(Method),
Doc.commentText()public java.lang.String parameterCommentOf(java.lang.reflect.Method method,
java.lang.String name)
ClassDoc中查找方法的指定参数名称的注释信息字符串method - methodname - 参数名称null或没有方法找或没有找到参数名则返回空字符串getMethodDoc(Method),
paramTagOf(MethodDoc, String),
Doc.commentText()public static java.lang.String getIndent()
public static void setIndent(java.lang.String indent)
indent - 要设置的 indentpublic void setExcludeTags(java.util.Map<java.lang.String,java.lang.Integer> excludeTags)
excludeTags - 要设置的 excludeTagspublic void addExcludeTag(java.lang.String excludeTag,
java.lang.Integer scope)
public void removeExcludeTag(java.lang.String excludeTag)
public void addExcludeTag(java.lang.String excludeTag,
gu.doc.ExtClassDoc.Type type)
public void addExcludeTag(java.lang.String excludeTag,
java.util.Collection<gu.doc.ExtClassDoc.Type> type)
public void addExcludeTag(java.lang.String excludeTag,
java.lang.String type)
public void addExcludeTagString(java.lang.String excludeTag,
java.util.Collection<java.lang.String> type)
public void addExcludeTag(java.lang.String excludeTag)
public void addExcludeTags(java.util.Map<java.lang.String,java.lang.Integer> excludeTag)
public void additionalText(java.lang.String text,
ExtClassDoc.Action action,
java.lang.Integer scope)
public void additionalText(java.lang.String text,
ExtClassDoc.Action action,
gu.doc.ExtClassDoc.Type... type)
public void additionalText(java.lang.String text,
java.lang.String action,
java.lang.String type)
public void additionalText(java.lang.String text,
ExtClassDoc.Action action,
java.util.Collection<gu.doc.ExtClassDoc.Type> type)
public void additionalText(java.lang.String text,
java.lang.String action,
java.util.Collection<java.lang.String> type)
public com.sun.javadoc.ClassDoc getClassDoc()
Copyright © 2022. All Rights Reserved.