Bug 304425 - [sfs] fix javadoc for options parameter
diff --git a/bundles/org.eclipse.core.resources.semantic/src/org/eclipse/core/resources/semantic/ISemanticFile.java b/bundles/org.eclipse.core.resources.semantic/src/org/eclipse/core/resources/semantic/ISemanticFile.java index a634ecd..848a744 100644 --- a/bundles/org.eclipse.core.resources.semantic/src/org/eclipse/core/resources/semantic/ISemanticFile.java +++ b/bundles/org.eclipse.core.resources.semantic/src/org/eclipse/core/resources/semantic/ISemanticFile.java
@@ -123,7 +123,7 @@ * options, this resource will be refreshed locally. * * @param options - * the options as specified in {@link ISemanticResource} + * only {@link ISemanticFileSystem#SUPPRESS_REFRESH} is supported * * @param monitor * a progress monitor, or <code>null</code> if progress reporting
diff --git a/bundles/org.eclipse.core.resources.semantic/src/org/eclipse/core/resources/semantic/ISemanticFolder.java b/bundles/org.eclipse.core.resources.semantic/src/org/eclipse/core/resources/semantic/ISemanticFolder.java index 734d511..22201da 100644 --- a/bundles/org.eclipse.core.resources.semantic/src/org/eclipse/core/resources/semantic/ISemanticFolder.java +++ b/bundles/org.eclipse.core.resources.semantic/src/org/eclipse/core/resources/semantic/ISemanticFolder.java
@@ -109,7 +109,7 @@ * a progress monitor or <code>null</code> if progress reporting * is not desired * @param options - * the options as specified in {@link ISemanticResource} + * only {@link ISemanticFileSystem#SUPPRESS_REFRESH} is supported * @return the new resource * @throws CoreException * in case of failure, e.g. when a resource with the same name @@ -143,7 +143,7 @@ * an arbitrary context object to be passed to content provider, * may be <code>null</code> * @param options - * the options as specified in {@link ISemanticResource} + * only {@link ISemanticFileSystem#SUPPRESS_REFRESH} is supported * @param monitor * a progress monitor or <code>null</code> if progress reporting * is not desired @@ -177,7 +177,7 @@ * the name of the member; note that this does not perform the * checks referred to in this interface javadoc * @param options - * the options as specified in {@link ISemanticResource} + * only {@link ISemanticFileSystem#SUPPRESS_REFRESH} is supported * @param monitor * a progress monitor or <code>null</code> if progress reporting * is not desired @@ -206,7 +206,7 @@ * the name of the member file; please refer to this interface * javadoc about restrictions for names * @param options - * the options as specified in {@link ISemanticResource} + * only {@link ISemanticFileSystem#SUPPRESS_REFRESH} is supported * @param monitor * a progress monitor, or <code>null</code> if progress reporting * is not desired @@ -235,7 +235,7 @@ * the name of the member folder; please refer to this interface * javadoc about restrictions for names * @param options - * the options as specified in {@link ISemanticResource} + * only {@link ISemanticFileSystem#SUPPRESS_REFRESH} is supported * @param monitor * a progress monitor or <code>null</code> if progress reporting * is not desired @@ -281,7 +281,7 @@ * under which resource content can be accessed * (retrieved/persisted) * @param options - * the options as specified in {@link ISemanticResource} + * only {@link ISemanticFileSystem#SUPPRESS_REFRESH} is supported * @param monitor * may be null * @return the member file @@ -322,7 +322,7 @@ * under which resource content can be accessed * (retrieved/persisted) * @param options - * the options as specified in {@link ISemanticResource} + * only {@link ISemanticFileSystem#SUPPRESS_REFRESH} is supported * @param monitor * may be null * @return the member folder @@ -360,7 +360,7 @@ * provider registered under contentProviderID; may be * <code>null</code> if no such properties are required * @param options - * the options as specified in {@link ISemanticResource} + * only {@link ISemanticFileSystem#SUPPRESS_REFRESH} is supported * @param monitor * may be <code>null</code> * @return the member folder @@ -397,7 +397,7 @@ * provider registered under contentProviderID; may be * <code>null</code> if no such properties are required * @param options - * the options as specified in {@link ISemanticResource} + * only {@link ISemanticFileSystem#SUPPRESS_REFRESH} is supported * @param monitor * may be <code>null</code> * @return the member folder
diff --git a/bundles/org.eclipse.core.resources.semantic/src/org/eclipse/core/resources/semantic/ISemanticResource.java b/bundles/org.eclipse.core.resources.semantic/src/org/eclipse/core/resources/semantic/ISemanticResource.java index 3416cea..59f4ad5 100644 --- a/bundles/org.eclipse.core.resources.semantic/src/org/eclipse/core/resources/semantic/ISemanticResource.java +++ b/bundles/org.eclipse.core.resources.semantic/src/org/eclipse/core/resources/semantic/ISemanticResource.java
@@ -137,8 +137,8 @@ * not direct or indirect children of this resource. In addition, the checks * for data loss described above should be performed. * <p> - * {@link ISemanticFileSystem#VALIDATE_REMOVE_IGNORE_RESOURCE_STATE} - * should only be specified together with + * {@link ISemanticFileSystem#VALIDATE_REMOVE_IGNORE_RESOURCE_STATE} should + * only be specified together with * {@link ISemanticFileSystem#VALIDATE_REMOVE_RAISE_ERROR_ON_SCOPE_EXTENSION} * . In this case, the checks for data loss should be skipped. * @@ -174,7 +174,7 @@ * options, the parent of this resource will be refreshed locally. * * @param options - * the options as specified in {@link ISemanticResource} + * only {@link ISemanticFileSystem#SUPPRESS_REFRESH} is supported * @param monitor * a progress monitor, or <code>null</code> if progress reporting * is not desired @@ -201,7 +201,7 @@ * read only flag, lock state...). * * @param options - * the options as specified in {@link ISemanticResource} + * only {@link ISemanticFileSystem#SUPPRESS_REFRESH} is supported * @param monitor * a progress monitor, or <code>null</code> if progress reporting * is not desired @@ -251,7 +251,7 @@ * {@link SyncDirection#BOTH}, {@link SyncDirection#INCOMING}, * {@link SyncDirection#OUTGOING} * @param options - * the options as specified in {@link ISemanticResource} + * only {@link ISemanticFileSystem#SUPPRESS_REFRESH} is supported * @param monitor * a progress monitor, or <code>null</code> if progress reporting * is not desired @@ -319,7 +319,7 @@ * returns an {@link IStatus#OK} status. * * @param options - * the options as specified in {@link ISemanticResource} + * only {@link ISemanticFileSystem#SUPPRESS_REFRESH} is supported * @param monitor * a progress monitor, or <code>null</code> if progress reporting * is not desired @@ -355,7 +355,7 @@ * returns an {@link IStatus#OK} status. * * @param options - * the options as specified in {@link ISemanticResource} + * only {@link ISemanticFileSystem#SUPPRESS_REFRESH} is supported * @param monitor * a progress monitor, or <code>null</code> if progress reporting * is not desired @@ -384,7 +384,7 @@ * @param uri * new URI or <code>null</code> if the URI should be unset * @param options - * the options as specified in {@link ISemanticResource} + * only {@link ISemanticFileSystem#SUPPRESS_REFRESH} is supported * @param monitor * a progress monitor, or <code>null</code> if progress reporting * is not desired
diff --git a/bundles/org.eclipse.core.resources.semantic/src/org/eclipse/core/resources/semantic/spi/ISemanticContentProvider.java b/bundles/org.eclipse.core.resources.semantic/src/org/eclipse/core/resources/semantic/spi/ISemanticContentProvider.java index 924c2ec..4ea55a9 100644 --- a/bundles/org.eclipse.core.resources.semantic/src/org/eclipse/core/resources/semantic/spi/ISemanticContentProvider.java +++ b/bundles/org.eclipse.core.resources.semantic/src/org/eclipse/core/resources/semantic/spi/ISemanticContentProvider.java
@@ -365,9 +365,20 @@ * @param semanticFileStore * the resource handle * @param options - * see the constants in {@link ISemanticFileSystem} for possible - * values; multiple values can be specified using bitwise OR - * (i.e. the <code>int</code> "|" operator); + * possible value are: + * <ul> + * <li>{@link ISemanticFileSystem#RESOURCE_INFO_CONTENT_TYPE} + * </li> <li> + * {@link ISemanticFileSystem#RESOURCE_INFO_EXISTS_REMOTELY}</li> + * <li>{@link ISemanticFileSystem#RESOURCE_INFO_LOCAL_ONLY}</li> + * <li>{@link ISemanticFileSystem#RESOURCE_INFO_LOCKED}</li> <li> + * {@link ISemanticFileSystem#RESOURCE_INFO_LOCKING_SUPPORTED} + * </li> <li>{@link ISemanticFileSystem#RESOURCE_INFO_READ_ONLY} + * </li> <li>{@link ISemanticFileSystem#RESOURCE_INFO_URI_STRING} + * </li> + * </ul> + * Multiple values can be specified using bitwise OR (i.e. the + * <code>int</code> "|" operator); * {@link ISemanticFileSystem#NONE} corresponds to <em>all</em> * attributes * @param monitor