summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorpelder2006-05-24 16:53:44 (EDT)
committer pelder2006-05-24 16:53:44 (EDT)
commitb0c04acdeb111e6e2f37f779a8af13538faa448c (patch)
treef3b44ec1885bd276108363286e2fadaf1daf50e6
parent5097864833e1998fcfca4484fec648874be475c1 (diff)
downloadorg.eclipse.jet-b0c04acdeb111e6e2f37f779a8af13538faa448c.zip
org.eclipse.jet-b0c04acdeb111e6e2f37f779a8af13538faa448c.tar.gz
org.eclipse.jet-b0c04acdeb111e6e2f37f779a8af13538faa448c.tar.bz2
[143587] Fix Java doc warnings, and add missing Java doc.
-rw-r--r--plugins/org.eclipse.jet/src/org/eclipse/jet/compiler/JET2ASTElement.java19
-rw-r--r--plugins/org.eclipse.jet/src/org/eclipse/jet/taglib/java/JavaActionsUtil.java9
-rw-r--r--plugins/org.eclipse.jet/src/org/eclipse/jet/taglib/workspace/WorkspaceContextExtender.java4
-rw-r--r--plugins/org.eclipse.jet/src/org/eclipse/jet/transform/IJETBundleDescriptor.java2
-rw-r--r--plugins/org.eclipse.jet/src/org/eclipse/jet/transform/IJETBundleManager.java47
5 files changed, 55 insertions, 26 deletions
diff --git a/plugins/org.eclipse.jet/src/org/eclipse/jet/compiler/JET2ASTElement.java b/plugins/org.eclipse.jet/src/org/eclipse/jet/compiler/JET2ASTElement.java
index 710a399..8219928 100644
--- a/plugins/org.eclipse.jet/src/org/eclipse/jet/compiler/JET2ASTElement.java
+++ b/plugins/org.eclipse.jet/src/org/eclipse/jet/compiler/JET2ASTElement.java
@@ -115,25 +115,6 @@ public abstract class JET2ASTElement
}
/**
- *
- * @return
- * @deprecated
- */
- public final JET2ASTElement getNextSibling()
- {
- JET2ASTElement next = null;
- if (parent != null)
- {
- BodyElements bodyElements = getBodyElements(parent);
- if (bodyElements != null)
- {
- next = bodyElements.elementAfter(this);
- }
- }
- return next;
- }
-
- /**
* @param element The element for which body elements are sought
* @return the body elements object
*/
diff --git a/plugins/org.eclipse.jet/src/org/eclipse/jet/taglib/java/JavaActionsUtil.java b/plugins/org.eclipse.jet/src/org/eclipse/jet/taglib/java/JavaActionsUtil.java
index 254e41c..04ce139 100644
--- a/plugins/org.eclipse.jet/src/org/eclipse/jet/taglib/java/JavaActionsUtil.java
+++ b/plugins/org.eclipse.jet/src/org/eclipse/jet/taglib/java/JavaActionsUtil.java
@@ -57,10 +57,11 @@ public class JavaActionsUtil
}
/**
- * @param sourceFolder
- * @param packageName
- * @return
- * @throws JET2TagException
+ * Return the {@link IFolder} corresponding to the given Java package name.
+ * @param sourceFolder the source folder containing the package
+ * @param packageName the package name
+ * @return the folder corresponding to the package
+ * @throws JET2TagException if the source folder is not valid.
*/
public static IFolder getFolderForPackage(IPath sourceFolder, String packageName) throws JET2TagException
{
diff --git a/plugins/org.eclipse.jet/src/org/eclipse/jet/taglib/workspace/WorkspaceContextExtender.java b/plugins/org.eclipse.jet/src/org/eclipse/jet/taglib/workspace/WorkspaceContextExtender.java
index 1075d45..3103788 100644
--- a/plugins/org.eclipse.jet/src/org/eclipse/jet/taglib/workspace/WorkspaceContextExtender.java
+++ b/plugins/org.eclipse.jet/src/org/eclipse/jet/taglib/workspace/WorkspaceContextExtender.java
@@ -378,7 +378,7 @@ public class WorkspaceContextExtender extends AbstractContextExtender
* <li>org.eclipse.jet.resource.name - the name of the resource. See {@link #VAR_RESOURCE_NAME}.</li>
* <li>org.eclipse.jet.resource.type - the type of the resource. See {@link #VAR_RESOURCE_TYPE}.</li>
* <li>org.eclipse.jet.resource.location - the location of the resource. See {@link #VAR_RESOURCE_LOCATION}.</li>
- * <li>org.eclipse.jet.resource.rawLocation - the raw location of the resource. See {@link #VAR_RESOURCE_RAW_LOCATION}.</li>
+ * <li>org.eclipse.jet.resource.rawLocation - the raw location of the resource. See {@link #VAR_RAW_LOCATION}.</li>
* <li>org.eclipse.jet.resource.project.name - the project name of the resource. See {@link #VAR_RESOURCE_PROJECT_NAME}.</li>
* <li>org.eclipse.jet.resource.fullPath - the full path of the resource. See {@link #VAR_RESOURCE_FULL_PATH}.</li>
* <li>org.eclipse.jet.resource.projectRelativePath - the project relative path of the resource. See {@link #VAR_RESOURCE_PROJECT_RELATIVE_PATH}.</li>
@@ -391,7 +391,7 @@ public class WorkspaceContextExtender extends AbstractContextExtender
* <bl>
* <li>org.eclipse.jet.resource.parent.name - the name of the resource's parent. See {@link #VAR_RESOURCE_NAME}.</li>
* <li>org.eclipse.jet.resource.parent.location - the location of the resource's parent. See {@link #VAR_RESOURCE_LOCATION}.</li>
- * <li>org.eclipse.jet.resource.parent.rawLocation - the raw location of the resource's parent. See {@link #VAR_RESOURCE_RAW_LOCATION}.</li>
+ * <li>org.eclipse.jet.resource.parent.rawLocation - the raw location of the resource's parent. See {@link #VAR_RAW_LOCATION}.</li>
* <li>org.eclipse.jet.resource.parent.fullPath - the full path of the resource's parent. See {@link #VAR_RESOURCE_FULL_PATH}.</li>
* <li>org.eclipse.jet.resource.parent.projectRelativePath - the project relative path of the resource's parent. See {@link #VAR_RESOURCE_PROJECT_RELATIVE_PATH}.</li>
* </bl>
diff --git a/plugins/org.eclipse.jet/src/org/eclipse/jet/transform/IJETBundleDescriptor.java b/plugins/org.eclipse.jet/src/org/eclipse/jet/transform/IJETBundleDescriptor.java
index 6f67cb6..10c2912 100644
--- a/plugins/org.eclipse.jet/src/org/eclipse/jet/transform/IJETBundleDescriptor.java
+++ b/plugins/org.eclipse.jet/src/org/eclipse/jet/transform/IJETBundleDescriptor.java
@@ -76,7 +76,7 @@ public interface IJETBundleDescriptor
/**
* Return an array containing the tag libraries imported by the bundle.
- * @return
+ * @return an array references, or the empty array.
*/
public abstract TagLibraryReference[] getTagLibraryReferences();
diff --git a/plugins/org.eclipse.jet/src/org/eclipse/jet/transform/IJETBundleManager.java b/plugins/org.eclipse.jet/src/org/eclipse/jet/transform/IJETBundleManager.java
index 9d9e19b..26bec87 100644
--- a/plugins/org.eclipse.jet/src/org/eclipse/jet/transform/IJETBundleManager.java
+++ b/plugins/org.eclipse.jet/src/org/eclipse/jet/transform/IJETBundleManager.java
@@ -22,13 +22,30 @@ import org.eclipse.jet.CoreJETException;
import org.eclipse.jet.JET2TemplateLoader;
+/**
+ * Define the interface to the manager for loading/unloading and describing JET transform bundles.
+ */
public interface IJETBundleManager
{
+ /**
+ * Return descriptions of all available JET transforms.
+ * @return an possibily empty array.
+ */
public abstract IJETBundleDescriptor[] getAllJETBundleDescriptors();
+ /**
+ * Return the descriptor for a given JET transform.
+ * @param id the transform (plug-in) id.
+ * @return the descriptor or <code>null</code>.
+ */
public abstract IJETBundleDescriptor getDescriptor(String id);
+ /**
+ * Return the descriptor for the give JET project
+ * @param name the project name.
+ * @return the descriptor or <code>null</code>.
+ */
public abstract IJETBundleDescriptor getDescriptorForProject(String name);
/**
@@ -39,14 +56,44 @@ public interface IJETBundleManager
*/
public abstract String getProjectForId(String id);
+ /**
+ * Load the specified JET transform, execute an {@link IJETRunnable}, and then ensure the transform is unloaded again.
+ * @param id the transform id
+ * @param runnable a runnable
+ * @param monitor a progress monitor
+ * @throws CoreJETException if an error occurs loading the transform bundle.
+ */
public abstract void run(String id, IJETRunnable runnable, IProgressMonitor monitor) throws CoreJETException;
+ /**
+ * Record a connection to the specified JET transform bundle. If this is the first connection, the bundle is
+ * loaded.
+ * @param id the transform id
+ * @param monitor a progress monitor
+ * @throws CoreJETException if an error occurs loading the transform bundle.
+ */
public abstract void connect(String id, IProgressMonitor monitor) throws CoreJETException;
+ /**
+ * Record a disconnection fromt he specified JET transform bundle. If this is the last connection, the bundle
+ * is unloaded.
+ * @param id the transform id
+ */
public abstract void disconnect(String id);
+ /**
+ * Return the {@link JET2TemplateLoader} instance for the specified JET Transform. A call to this method
+ * must be bracketed by calls to {@link #connect(String, IProgressMonitor)} and {@link #disconnect(String)}.
+ * @param id the JET transform
+ * @return the template loader instance
+ * @throws CoreJETException if the loader could not be found or loaded.
+ */
public abstract JET2TemplateLoader getTemplateLoader(String id) throws CoreJETException;
+ /**
+ * Return an array of transform available ids.
+ * @return a possibly empty array of strings.
+ */
public abstract String[] getAllTransformIds();
} \ No newline at end of file