Author: adietish Date: 2012-09-28 16:38:00 -0400 (Fri, 28 Sep 2012) New Revision: 44125 Modified: trunk/usage/plugins/org.jboss.tools.usage/src/org/jboss/tools/usage/internal/preferences/UsageReportPreferences.java Log: corrected javadoc Modified: trunk/usage/plugins/org.jboss.tools.usage/src/org/jboss/tools/usage/internal/preferences/UsageReportPreferences.java =================================================================== --- trunk/usage/plugins/org.jboss.tools.usage/src/org/jboss/tools/usage/internal/preferences/UsageReportPreferences.java 2012-09-28 20:02:35 UTC (rev 44124) +++ trunk/usage/plugins/org.jboss.tools.usage/src/org/jboss/tools/usage/internal/preferences/UsageReportPreferences.java 2012-09-28 20:38:00 UTC (rev 44125) @@ -18,7 +18,6 @@ import org.jboss.tools.usage.tracker.internal.UsagePluginLogger; import org.osgi.service.prefs.BackingStoreException; -// TODO: Auto-generated Javadoc /** * The Class UsageReportPreferences. * @@ -65,9 +64,9 @@ } /** - * Checks if is ask user. + * Returns <code>true</code> if the user shall get asked if he agrees to report its usage. * - * @return true, if is ask user + * @return true, if the user shall get asked */ public static boolean isAskUser() { return UsageReportPreferencesUtils.getPreferences().getBoolean( @@ -76,9 +75,9 @@ } /** - * Get default value for isAskUser preference + * Returns the default value for {@link #isAskUser()} * - * @return default value set by UsageReportPreferenceInitializer + * @return */ static boolean getAskUserDefault() { return UsageReportPreferencesUtils.getDefaultPreferences().getBoolean( @@ -87,7 +86,7 @@ } /** - * Get default value for isEnabled preference + * Returns the default value for the enablement of usage reporting * * @return default value that is set in plugin_customization.ini file or * IUsageReportPreferenceConstants.USAGEREPORT_ENABLED_DEFAULTVALUE otherwise @@ -99,7 +98,7 @@ IUsageReportPreferenceConstants.USAGEREPORT_ENABLED_DEFAULTVALUE); } /** - * Sets the ask user. + * Sets the value for {@link #isAskUser()} * * @param askUser * the new ask user @@ -124,7 +123,7 @@ } /** - * Flush. + * Flushes the preferences. * * @throws BackingStoreException * the backing store exception @@ -136,7 +135,7 @@ /** * Creates the preference store. * - * @return the i preference store + * @return the preference store */ public static IPreferenceStore createPreferenceStore() { return UsageReportPreferencesUtils.getStore();