de.smartics.analysis.javadoc
Interface JavadocCollector

Package class diagram package JavadocCollector
All Known Implementing Classes:
DefaultJavadocCollector

public interface JavadocCollector

Defines the interface to collect specific information from a Java source tree.

Author:
Robert Reiner

Method Summary
 List<com.sun.javadoc.Doc> collect()
          Runs the collector.
 

Method Detail

collect

List<com.sun.javadoc.Doc> collect()
                                  throws JavadocException
Runs the collector.

Returns:
the list of Javadoc information collected from the Java source tree.
Throws:
JavadocException - if the Javadoc tool reports an return code that is not zero ( 0).


Copyright © 2008-2011 Kronseder & Reiner GmbH - smartics. All Rights Reserved.