| java.lang.Object
 edu.rice.cs.drjava.model.javadoc.DefaultJavadocModel
| DefaultJavadocModel | | public class DefaultJavadocModel implements JavadocModel(Code) | | Default implementation of JavadocModel interface; generates Javadoc HTML files for a set of documents.
version:
$Id: DefaultJavadocModel.java 4255 2007-08-28 19:17:37Z mgricken $ |
| DefaultJavadocModel | | public DefaultJavadocModel(GlobalModel model, File javaCommand, Iterable<File> toolsPath)(Code) | | Main constructor.
Parameters:
model - Source of documents for this JavadocModel
Parameters:
javaCommand - Location of the java command to use (if not the default in java.home )
Parameters:
toolsPath - Location of the tools library containing the javadoc code (if not on the javaCommand's boot class path) |
| addListener | | public void addListener(JavadocListener listener)(Code) | | Add a JavadocListener to the model.
Parameters:
listener - a listener that reacts to Javadoc events |
| getJavadocErrorModel | | public CompilerErrorModel getJavadocErrorModel()(Code) | | Accessor for the Javadoc error model.
the CompilerErrorModel managing Javadoc errors. |
| isAvailable | | public boolean isAvailable()(Code) | | |
| javadocAll | | public void javadocAll(DirectorySelector select, FileSaveSelector saver) throws IOException(Code) | | Javadocs all open documents, after ensuring that all are saved. The user provides a destination, and the global
model provides the package info. Must run in the event-handling thread.
Parameters:
select - a command object for selecting a directory and warning a user about bad input
Parameters:
saver - a command object for saving a document (if it moved/changed)
Parameters:
classPath - a collection of classpath elements to be used by Javadoc
throws:
IOException - if there is a problem manipulating files |
| javadocDocument | | public void javadocDocument(OpenDefinitionsDocument doc, FileSaveSelector saver) throws IOException(Code) | | Generates Javadoc for the given document only, after ensuring it is saved. Saves the output in a temp directory
which is passed to _javadocDocuemntWorker, which is passed to a subsequent javadocEnded event.
Parameters:
doc - Document to generate Javadoc for
Parameters:
saver - a command object for saving the document (if it moved/changed)
Parameters:
classPath - a collection of classpath elements to be used by Javadoc
throws:
IOException - if there is a problem manipulating files |
| removeAllListeners | | public void removeAllListeners()(Code) | | Removes all JavadocListeners from this model.
|
| removeListener | | public void removeListener(JavadocListener listener)(Code) | | Remove a JavadocListener from the model. If the listener is not currently
listening to this model, this method has no effect.
Parameters:
listener - a listener that reacts to Javadoc events |
| resetJavadocErrors | | public void resetJavadocErrors()(Code) | | Clears all current Javadoc errors.
|
| suggestJavadocDestination | | public File suggestJavadocDestination(OpenDefinitionsDocument doc)(Code) | | Suggests a default location for generating Javadoc, based on the given document's source root. (Appends
JavadocModel.SUGGESTED_DIR_NAME to the sourceroot.) Ensures that the document is saved first, or else no
reasonable suggestion will be found.
Parameters:
doc - Document with the source root to use as the default. Suggested destination directory, or null if none could be determined. |
|
|