gu.doc

类 JavadocReader

java.lang.Object

gu.doc.JavadocReader

public class JavadocReader
extends java.lang.Object

读取指定java源文件的javadoc信息

作者:

guyadong

嵌套类概要

嵌套类

限定符和类型	类和说明
static class	JavadocReader.Doclet

构造器概要

构造器

构造器和说明
JavadocReader()

方法概要

限定符和类型	方法和说明
static java.lang.String	getClasspath()
static java.lang.String	getSourceFile(java.lang.Class<?> clazz)
static java.lang.String	getSourceFile(java.lang.String prefix, java.lang.Class<?> clazz) 返回类的源文件位置
static java.lang.String	getSourcepath()
static ExtClassDoc	read(java.lang.Class<?> clazz)
static ExtClassDoc	read(java.lang.String source)
static ExtClassDoc	read(java.lang.String prefix, java.lang.Class<?> clazz)
static ExtClassDoc	read(java.lang.String source, java.util.List<java.lang.String> classpath)
static ExtClassDoc	read(java.lang.String source, java.util.List<java.lang.String> classpath, java.util.List<java.lang.String> sourcepath)
static ExtClassDoc	read(java.lang.String source, java.lang.String classpath)
static ExtClassDoc	read(java.lang.String source, java.lang.String[] classpath)
static ExtClassDoc	read(java.lang.String source, java.lang.String[] classpath, java.lang.String[] sourcepath)
static ExtClassDoc	read(java.lang.String source, java.lang.String classpath, java.lang.String sourcepath) 读取source指定源文件的注释
static com.sun.javadoc.RootDoc	readDocs(java.lang.String source, java.lang.String classpath, java.lang.String sourcepath) 解析指定的java源文件返回javadoc对象 RootDoc 参见 Running the Standard Doclet Programmatically
static void	setClasspath(java.lang.String classpath)
static void	setSourcepath(java.lang.String sourcepath)
static void	show()

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

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

构造器详细资料

JavadocReader

public JavadocReader()

方法详细资料

show

public static void show()

readDocs

public static com.sun.javadoc.RootDoc readDocs(java.lang.String source,
                                               java.lang.String classpath,
                                               java.lang.String sourcepath)

解析指定的java源文件返回javadoc对象 RootDoc
参见 Running the Standard Doclet Programmatically

参数:

source - a java source file or package name

classpath - value for '-classpath',source的class位置,可为null,如果不提供,无法获取到完整的注释信息(比如annotation)

sourcepath - value for '-sourcepath'

返回:

RootDoc对象

read

public static ExtClassDoc read(java.lang.String source,
                               java.lang.String classpath,
                               java.lang.String sourcepath)

读取source指定源文件的注释

参数:

source -

classpath -

sourcepath -

返回:

读取失败返回null

read

public static ExtClassDoc read(java.lang.String source)

另请参阅:

read(String, String)

read

public static ExtClassDoc read(java.lang.String prefix,
                               java.lang.Class<?> clazz)

read

public static ExtClassDoc read(java.lang.Class<?> clazz)

read

public static ExtClassDoc read(java.lang.String source,
                               java.util.List<java.lang.String> classpath)

read

public static ExtClassDoc read(java.lang.String source,
                               java.lang.String[] classpath)

read

public static ExtClassDoc read(java.lang.String source,
                               java.lang.String classpath)

read

public static ExtClassDoc read(java.lang.String source,
                               java.util.List<java.lang.String> classpath,
                               java.util.List<java.lang.String> sourcepath)

read

public static ExtClassDoc read(java.lang.String source,
                               java.lang.String[] classpath,
                               java.lang.String[] sourcepath)

getSourceFile

public static java.lang.String getSourceFile(java.lang.String prefix,
                                             java.lang.Class<?> clazz)

返回类的源文件位置

参数:

prefix - 源文件夹,可为null

clazz - 为null则返回null

返回:

返回'/'分隔'.java'结尾的路径名,for example, '/home/src/java/awt/Graphics*java‘

getSourceFile

public static java.lang.String getSourceFile(java.lang.Class<?> clazz)

参数:

clazz -

返回:

file path

另请参阅:

getSourceFile(String, Class)

getSourcepath

public static java.lang.String getSourcepath()

返回:

sourcepath

setSourcepath

public static void setSourcepath(java.lang.String sourcepath)

参数:

sourcepath - 要设置的 sourcepath

getClasspath

public static java.lang.String getClasspath()

返回:

classpath

setClasspath

public static void setClasspath(java.lang.String classpath)

参数:

classpath - 要设置的 classpath