A massive organize imports and formatting of the sources using default Eclipse code...
[phpeclipse.git] / net.sourceforge.phpeclipse / src / net / sourceforge / phpdt / internal / ui / text / spelling / engine / ISpellCheckEngine.java
index 1720efa..b857bd7 100644 (file)
@@ -27,11 +27,11 @@ public interface ISpellCheckEngine {
         * appropriate dictionaries.
         * 
         * @param locale
-        *                   The locale to get the spell checker for
+        *            The locale to get the spell checker for
         * @param store
-        *                   The preference store for the spell-checker
+        *            The preference store for the spell-checker
         * @return A configured instance of a spell checker, or <code>null</code>
-        *               iff no dictionary could be found for that locale
+        *         iff no dictionary could be found for that locale
         */
        ISpellChecker createSpellChecker(Locale locale, IPreferenceStore store);
 
@@ -45,12 +45,13 @@ public interface ISpellCheckEngine {
        /**
         * Registers a dictionary for all locales available on the platform.
         * <p>
-        * This call is equivalent to calling <code>registerDictionary(Locale,ISpellDictionary)</code>
-        * for each of the locales returned by <code>Locale.getAvailableLocales()</code>.
+        * This call is equivalent to calling
+        * <code>registerDictionary(Locale,ISpellDictionary)</code> for each of
+        * the locales returned by <code>Locale.getAvailableLocales()</code>.
         * </p>
         * 
         * @param dictionary
-        *                   The dictionary to register
+        *            The dictionary to register
         */
        void registerDictionary(ISpellDictionary dictionary);
 
@@ -58,9 +59,9 @@ public interface ISpellCheckEngine {
         * Registers a dictionary tuned for the specified locale with this engine.
         * 
         * @param locale
-        *                   The locale to register the dictionary with
+        *            The locale to register the dictionary with
         * @param dictionary
-        *                   The dictionary to register
+        *            The dictionary to register
         */
        void registerDictionary(Locale locale, ISpellDictionary dictionary);
 
@@ -68,20 +69,21 @@ public interface ISpellCheckEngine {
         * Unloads the spell check engine and its associated components.
         * <p>
         * All registered dictionaries are unloaded and the engine unregisters for
-        * preference changes. After a new call to <code>getSpellChecker(Locale)</code>,
-        * it registers again for preference changes. The dictionaries perform lazy
-        * loading, that is to say on the next query they reload their associated
-        * word lists.
+        * preference changes. After a new call to
+        * <code>getSpellChecker(Locale)</code>, it registers again for
+        * preference changes. The dictionaries perform lazy loading, that is to say
+        * on the next query they reload their associated word lists.
         */
        void unload();
 
        /**
         * Unregisters a dictionary previously registered either by a call to
-        * <code>registerDictionary(Locale,ISpellDictionary)</code> or <code>registerDictionary(ISpellDictionary)</code>.
-        * If the dictionary was not registered before, nothing happens.
+        * <code>registerDictionary(Locale,ISpellDictionary)</code> or
+        * <code>registerDictionary(ISpellDictionary)</code>. If the dictionary
+        * was not registered before, nothing happens.
         * 
         * @param dictionary
-        *                   The dictionary to unregister
+        *            The dictionary to unregister
         */
        void unregisterDictionary(ISpellDictionary dictionary);
 }