bug 294302 - [Filters] Adjust Filters API javadoc to the recent changes

4 files changed, 12 insertions, 19 deletions

diff --git a/bundles/org.eclipse.core.resources/src/org/eclipse/core/internal/resources/Resource.java b/bundles/org.eclipse.core.resources/src/org/eclipse/core/internal/resources/Resource.java
index 107ade903..c6c202c18 100644
--- a/bundles/org.eclipse.core.resources/src/org/eclipse/core/internal/resources/Resource.java
+++ b/bundles/org.eclipse.core.resources/src/org/eclipse/core/internal/resources/Resource.java
@@ -712,6 +712,9 @@ public abstract class Resource extends PlatformObject implements IResource, ICor
 		}
 	}
 
+	/**
+	 * @see IContainer#createFilter(int, IFileInfoMatcherDescription, int, IProgressMonitor)
+	 */
 	public IResourceFilterDescription createFilter(int type, IFileInfoMatcherDescription matcherDescription, int updateFlags, IProgressMonitor monitor) throws CoreException {
 		Assert.isNotNull(getProject());
 		monitor = Policy.monitorFor(monitor);
diff --git a/bundles/org.eclipse.core.resources/src/org/eclipse/core/resources/IContainer.java b/bundles/org.eclipse.core.resources/src/org/eclipse/core/resources/IContainer.java
index d80be09a4..5999a8122 100644
--- a/bundles/org.eclipse.core.resources/src/org/eclipse/core/resources/IContainer.java
+++ b/bundles/org.eclipse.core.resources/src/org/eclipse/core/resources/IContainer.java
@@ -468,7 +468,7 @@ public interface IContainer extends IResource, IAdaptable {
 	public void setDefaultCharset(String charset, IProgressMonitor monitor) throws CoreException;
 
 	/**
-	 * Adds a new filter matching the arguments to this folder's filter list  
+	 * Adds a new filter matching the arguments to this container's filter list  
 	 * 
 	 * @param type (IResourceFilter.INCLUDE_ONLY or IResourceFilter.EXCLUDE_ALL) and/or IResourceFilter.INHERITABLE
 	 * @param updateFlags bit-wise or of update flag constants
@@ -489,7 +489,7 @@ public interface IContainer extends IResource, IAdaptable {
 	public IResourceFilterDescription createFilter(int type, IFileInfoMatcherDescription matcherDescription, int updateFlags, IProgressMonitor monitor) throws CoreException;
 
 	/**
-	 * Remove the filter matching the arguments from this folder's filter list  
+	 * Remove the filter matching the arguments from this container's filter list  
 	 * 
 	 * @param updateFlags bit-wise or of update flag constants
 	 *   ({@link IResource#BACKGROUND_REFRESH})
@@ -509,10 +509,10 @@ public interface IContainer extends IResource, IAdaptable {
 	public void removeFilter(IResourceFilterDescription filterDescription, int updateFlags, IProgressMonitor monitor) throws CoreException;
 
 	/**
-	 * Retrieve the filters for this folder.
+	 * Retrieve the filters for this container.
 	 * If no filters exist for this resource, an empty array is returned.
 	 * 
-	 * @return this folder resources, or IResourceFilter[0] if no filters exist
+	 * @return an array of filters
 	 * @exception CoreException if this resource's filters could not be retrieved. Reasons include:
 	 * <ul>
 	 * <li> This resource is not a folder.</li>
diff --git a/bundles/org.eclipse.core.resources/src/org/eclipse/core/resources/IFileInfoMatcherDescription.java b/bundles/org.eclipse.core.resources/src/org/eclipse/core/resources/IFileInfoMatcherDescription.java
index 8181c07b6..062c69db1 100644
--- a/bundles/org.eclipse.core.resources/src/org/eclipse/core/resources/IFileInfoMatcherDescription.java
+++ b/bundles/org.eclipse.core.resources/src/org/eclipse/core/resources/IFileInfoMatcherDescription.java
@@ -12,30 +12,23 @@
 package org.eclipse.core.resources;
 
 /**
- * Interface for resource filters.  A filter determines which file system
- * objects will be visible when a local refresh is performed for an IContainer.
- * 
- * @see IFolder#getFilters()
+ * @see IContainer#createFilter(int, IFileInfoMatcherDescription, int, org.eclipse.core.runtime.IProgressMonitor)
  * @noimplement This interface is not intended to be implemented by clients.
  * @since 3.6
  */
 public interface IFileInfoMatcherDescription {
 
-	/*====================================================================
-	 * Constants defining which members are wanted:
-	 *====================================================================*/
-
 	/**
-	 * Return the filter id, which matches the resource filter provider ID.
+	 * Return the matcher id.
 	 * 
-	 * @return the resource filter provider id.
+	 * @return the file info matcher id.
 	 */
 	public String getId();
 
 	public void setId(String id);
 
 	/**
-	 * Return the filter arguments, or null if no arguments exist.
+	 * Return the matcher arguments, or null if no arguments exist.
 	 * 
 	 * @return the argument string, or null
 	 */
diff --git a/bundles/org.eclipse.core.resources/src/org/eclipse/core/resources/IResourceFilterDescription.java b/bundles/org.eclipse.core.resources/src/org/eclipse/core/resources/IResourceFilterDescription.java
index de9c075f2..11374ba4a 100644
--- a/bundles/org.eclipse.core.resources/src/org/eclipse/core/resources/IResourceFilterDescription.java
+++ b/bundles/org.eclipse.core.resources/src/org/eclipse/core/resources/IResourceFilterDescription.java
@@ -15,7 +15,7 @@ package org.eclipse.core.resources;
  * Interface for resource filters.  A filter determines which file system
  * objects will be visible when a local refresh is performed for an IContainer.
  *
- * @see IFolder#getFilters()
+ * @see IContainer#getFilters()
  * @noimplement This interface is not intended to be implemented by clients.
  * @noextend This interface is not intended to be extended by clients.
  * @since 3.6
@@ -37,7 +37,6 @@ public interface IResourceFilterDescription {
 	 * Flag for resource filters indicating that the filter list excludes all
 	 * the files matching the filters.  All EXCLUDE_ALL filters are applied to
 	 * the resource list with an logical AND operation.
-	 * 
 	 */
 	public static final int EXCLUDE_ALL = 2;
 
@@ -48,14 +47,12 @@ public interface IResourceFilterDescription {
 
 	/**
 	 * Flag for resource filters indicating that this filter applies to folders.
-	 * 
 	 */
 	public static final int FOLDERS = 8;
 
 	/**
 	 * Flag for resource filters indicating that the container children of the
 	 * path inherit from this filter as well.
-	 * 
 	 */
 	public static final int INHERITABLE = 16;