Bug 545330 - Problems in javadoc for platform
Fix javadoc warnings in equinox.bundles.
Change-Id: If6df0f01881b2142d9d4b1c8f7dc0730cda26728
Signed-off-by: Alexander Kurtakov <akurtako@redhat.com>
diff --git a/bundles/org.eclipse.equinox.preferences/META-INF/MANIFEST.MF b/bundles/org.eclipse.equinox.preferences/META-INF/MANIFEST.MF
index 96d840a..a04bfb5 100644
--- a/bundles/org.eclipse.equinox.preferences/META-INF/MANIFEST.MF
+++ b/bundles/org.eclipse.equinox.preferences/META-INF/MANIFEST.MF
@@ -2,7 +2,7 @@
Bundle-ManifestVersion: 2
Bundle-Name: %pluginName
Bundle-SymbolicName: org.eclipse.equinox.preferences; singleton:=true
-Bundle-Version: 3.7.300.qualifier
+Bundle-Version: 3.7.400.qualifier
Bundle-Activator: org.eclipse.core.internal.preferences.Activator
Bundle-Vendor: %providerName
Bundle-Localization: plugin
diff --git a/bundles/org.eclipse.equinox.preferences/pom.xml b/bundles/org.eclipse.equinox.preferences/pom.xml
index 185cf31..02af956 100644
--- a/bundles/org.eclipse.equinox.preferences/pom.xml
+++ b/bundles/org.eclipse.equinox.preferences/pom.xml
@@ -19,6 +19,6 @@
</parent>
<groupId>org.eclipse.equinox</groupId>
<artifactId>org.eclipse.equinox.preferences</artifactId>
- <version>3.7.300-SNAPSHOT</version>
+ <version>3.7.400-SNAPSHOT</version>
<packaging>eclipse-plugin</packaging>
</project>
diff --git a/bundles/org.eclipse.equinox.preferences/src/org/eclipse/core/runtime/preferences/IEclipsePreferences.java b/bundles/org.eclipse.equinox.preferences/src/org/eclipse/core/runtime/preferences/IEclipsePreferences.java
index 1cd6418..a3a3fe4 100644
--- a/bundles/org.eclipse.equinox.preferences/src/org/eclipse/core/runtime/preferences/IEclipsePreferences.java
+++ b/bundles/org.eclipse.equinox.preferences/src/org/eclipse/core/runtime/preferences/IEclipsePreferences.java
@@ -315,7 +315,9 @@
*
* @param visitor the visitor
* @see IPreferenceNodeVisitor#visit(IEclipsePreferences)
- * @throws BackingStoreException
+ * @throws BackingStoreException if this operation cannot be completed due
+ * to a failure in the backing store, or inability to communicate
+ * with it.
*/
public void accept(IPreferenceNodeVisitor visitor) throws BackingStoreException;
}
diff --git a/bundles/org.eclipse.equinox.preferences/src/org/eclipse/core/runtime/preferences/IPreferenceNodeVisitor.java b/bundles/org.eclipse.equinox.preferences/src/org/eclipse/core/runtime/preferences/IPreferenceNodeVisitor.java
index 0326eb7..0dbaabb 100644
--- a/bundles/org.eclipse.equinox.preferences/src/org/eclipse/core/runtime/preferences/IPreferenceNodeVisitor.java
+++ b/bundles/org.eclipse.equinox.preferences/src/org/eclipse/core/runtime/preferences/IPreferenceNodeVisitor.java
@@ -45,7 +45,9 @@
* @param node the node to visit
* @return <code>true</code> if the node's children should
* be visited; <code>false</code> if they should be skipped
- * @throws BackingStoreException
+ * @throws BackingStoreException if this operation cannot be completed due
+ * to a failure in the backing store, or inability to communicate
+ * with it.
*/
public boolean visit(IEclipsePreferences node) throws BackingStoreException;
}
diff --git a/bundles/org.eclipse.equinox.preferences/src/org/eclipse/core/runtime/preferences/IPreferencesService.java b/bundles/org.eclipse.equinox.preferences/src/org/eclipse/core/runtime/preferences/IPreferencesService.java
index 23f4539..c2311e4 100644
--- a/bundles/org.eclipse.equinox.preferences/src/org/eclipse/core/runtime/preferences/IPreferencesService.java
+++ b/bundles/org.eclipse.equinox.preferences/src/org/eclipse/core/runtime/preferences/IPreferencesService.java
@@ -611,7 +611,7 @@
* @param node the tree to export
* @param filters the list of filters to export
* @param output the stream to export to
- * @throws CoreException
+ * @throws CoreException if there was a problem exporting the preferences
* @see #exportPreferences(IEclipsePreferences, OutputStream, String[])
* @see #readPreferences(InputStream)
* @see #applyPreferences(IEclipsePreferences, IPreferenceFilter[])
@@ -629,7 +629,7 @@
* @param node the tree to match against
* @param filters the list of filters to match against
* @return the array of matching transfers
- * @throws CoreException
+ * @throws CoreException if there are problems during matching
* @see IPreferenceFilter
* @since 3.1
*/
@@ -650,7 +650,7 @@
*
* @param node the tree to consider applying
* @param filters the filters to use
- * @throws CoreException
+ * @throws CoreException if there are problems applying the preferences
* @see #applyPreferences(IExportedPreferences)
* @see #readPreferences(InputStream)
* @see IPreferenceFilter
diff --git a/bundles/org.eclipse.equinox.security/META-INF/MANIFEST.MF b/bundles/org.eclipse.equinox.security/META-INF/MANIFEST.MF
index 4ca6438..6c57f9e 100644
--- a/bundles/org.eclipse.equinox.security/META-INF/MANIFEST.MF
+++ b/bundles/org.eclipse.equinox.security/META-INF/MANIFEST.MF
@@ -2,7 +2,7 @@
Bundle-ManifestVersion: 2
Bundle-Name: %pluginName
Bundle-SymbolicName: org.eclipse.equinox.security;singleton:=true
-Bundle-Version: 1.3.100.qualifier
+Bundle-Version: 1.3.200.qualifier
Bundle-Vendor: %providerName
Bundle-Localization: plugin
Bundle-Activator: org.eclipse.equinox.internal.security.auth.AuthPlugin
diff --git a/bundles/org.eclipse.equinox.security/pom.xml b/bundles/org.eclipse.equinox.security/pom.xml
index fae53ad..b1b4acf 100644
--- a/bundles/org.eclipse.equinox.security/pom.xml
+++ b/bundles/org.eclipse.equinox.security/pom.xml
@@ -19,7 +19,7 @@
</parent>
<groupId>org.eclipse.equinox</groupId>
<artifactId>org.eclipse.equinox.security</artifactId>
- <version>1.3.100-SNAPSHOT</version>
+ <version>1.3.200-SNAPSHOT</version>
<packaging>eclipse-plugin</packaging>
<build>
diff --git a/bundles/org.eclipse.equinox.security/src/org/eclipse/equinox/security/auth/ILoginContext.java b/bundles/org.eclipse.equinox.security/src/org/eclipse/equinox/security/auth/ILoginContext.java
index b245f68..d729856 100644
--- a/bundles/org.eclipse.equinox.security/src/org/eclipse/equinox/security/auth/ILoginContext.java
+++ b/bundles/org.eclipse.equinox.security/src/org/eclipse/equinox/security/auth/ILoginContext.java
@@ -31,14 +31,14 @@
/**
* Call this method to perform a login.
* @see LoginContext#login()
- * @throws LoginException
+ * @throws LoginException if the authentication fails.
*/
public void login() throws LoginException;
/**
* Call this method to perform a logout.
* @see LoginContext#logout()
- * @throws LoginException
+ * @throws LoginException if the logout fails.
*/
public void logout() throws LoginException;
