public class ExtClassDoc
extends java.lang.Object
| 限定符和类型 | 类和说明 |
|---|---|
static class |
ExtClassDoc.Action |
static class |
ExtClassDoc.AddColumn |
| 构造器和说明 |
|---|
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.lang.String |
getClassComment() |
com.sun.javadoc.ClassDoc |
getClassDoc() |
static java.lang.String |
getIndent() |
java.lang.String |
getMethodComment(java.lang.reflect.Method method) |
com.sun.javadoc.MethodDoc |
getMethodDoc(java.lang.reflect.Method method)
在
ClassDoc中查找与method匹配的com.sun.tools.javadoc.MethodDocImpl |
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.Method method)
在
ClassDoc中查找与method匹配的com.sun.tools.javadoc.MethodDocImpl对象的索引不采用注释掉的同名方法的原因是直接对签名进行字符串比较的方法不能适应独立运行环境, 因为MethodDocImpl返回的方法签名中类名并一定是全名 |
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 定义的顺序重新排序 |
public com.sun.javadoc.MethodDoc getMethodDoc(java.lang.reflect.Method method)
ClassDoc中查找与method匹配的com.sun.tools.javadoc.MethodDocImplmethod - methodnullindexOf(Method)public com.sun.javadoc.ParamTag paramTagOf(com.sun.javadoc.MethodDoc methodDoc,
java.lang.String name)
public int indexOf(java.lang.reflect.Method method)
ClassDoc中查找与method匹配的com.sun.tools.javadoc.MethodDocImpl对象的索引method - methodmethod定义方法在ClassDoc.methods()数组中的索引,没有找则返回 -1public 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)
public java.lang.String output()
public final java.lang.String formatComment(com.sun.javadoc.Doc doc,
boolean needIndent)
doc - com.sun.tools.javadoc.ClassDocImpl 或 com.sun.tools.javadoc.MethodDocImpl实例needIndent - 是否缩进public java.lang.String getClassComment()
public java.lang.String getMethodComment(java.lang.reflect.Method method)
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 © 2019. All Rights Reserved.