de.smartics.analysis.javadoc
Class JavadocLoader

java.lang.Object
  de.smartics.analysis.javadoc.JavadocLoader

public class JavadocLoader
     
     

      
      extends 
      
      Object
     
     

Loader for Javadoc information for a class.

Author:

Robert Reiner

Constructor Summary

JavadocLoader(Collection<String> sourceRootDirectoryNames)
Default constructor.

JavadocLoader(String programName, Collection<String> sourceRootDirectoryNames)
Default constructor.

Method Summary

com.sun.javadoc.ClassDoc

readClassDoc(Class<?> clazz)

Methods inherited from class java.lang.Object

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

Constructor Detail

JavadocLoader

public JavadocLoader(Collection<String> sourceRootDirectoryNames)

Default constructor.

Parameters:

sourceRootDirectoryNames - the root directories of source trees to search for Javadoc information.

JavadocLoader

public JavadocLoader(String programName,
                     Collection<String> sourceRootDirectoryNames)

Default constructor.

Parameters:

programName - the name of the program that loads the Javadoc information for logging.

sourceRootDirectoryNames - the root directories of source trees to search for Javadoc information.

Method Detail

readClassDoc

public com.sun.javadoc.ClassDoc readClassDoc(Class<?> clazz)
                                      throws JavadocException,
                                             IOException

Throws:

JavadocException

IOException