Edited comments.

michael-rapp · May 27, 2018 · 6af80da · 6af80da
1 parent dec4e04
commit 6af80da
Show file tree

Hide file tree

Showing 8 changed files with 37 additions and 39 deletions.
diff --git a/library/src/main/java/de/mrapp/android/preference/activity/PreferenceActivity.java b/library/src/main/java/de/mrapp/android/preference/activity/PreferenceActivity.java
@@ -1055,8 +1055,8 @@ private void showPreferenceFragment(@NonNull final NavigationPreference navigati
      *         as an instance of the class {@link NavigationPreference}. The navigation preference
      *         may not be null
      * @param fragment
-     *         The fragment, which should be shown, as an instance of the class {@link Fragment}.
-     *         The fragment may not be null
+     *         The fragment, which should be shown, as an instance of the class Fragment. The
+     *         fragment may not be null
      */
     private void showPreferenceFragment(@NonNull final NavigationPreference navigationPreference,
                                         @NonNull final Fragment fragment) {
@@ -1728,7 +1728,7 @@ public void onClick(final View v) {
      *         an instance of the class {@link NavigationPreference}. The navigation preference may
      *         not be null
      * @param fragment
-     *         The fragment, which has been shown, as an instance of the class {@link Fragment}. The
+     *         The fragment, which has been shown, as an instance of the class Fragment. The
      *         fragment may not be null
      */
     private void notifyOnPreferenceFragmentShown(
@@ -1743,8 +1743,8 @@ private void notifyOnPreferenceFragmentShown(
      * Notifies all registered listeners that a preference fragment has been hidden.
      *
      * @param fragment
-     *         The fragment, which has been hidden, as an instance of the class {@link Fragment}.
-     *         The fragment may not be null
+     *         The fragment, which has been hidden, as an instance of the class Fragment. The
+     *         fragment may not be null
      */
     private void notifyOnPreferenceFragmentHidden(@NonNull final Fragment fragment) {
         for (PreferenceFragmentListener listener : preferenceFragmentListeners) {
@@ -1979,8 +1979,7 @@ public final boolean isSplitScreen() {
      * Returns the preference fragment, which contains the activity's navigation.
      *
      * @return The preference fragment, which contains the activity's navigation, as an instance of
-     * the class {@link PreferenceFragmentCompat} or null, if the navigation has not been created
-     * yet
+     * the class PreferenceFragmentCompat or null, if the navigation has not been created yet
      */
     public final PreferenceFragmentCompat getNavigationFragment() {
         return navigationFragment;
@@ -1989,8 +1988,8 @@ public final PreferenceFragmentCompat getNavigationFragment() {
     /**
      * Returns the currently shown preference fragment.
      *
-     * @return The currently shown preference fragment as an instance of the class {@link Fragment}
-     * or null, if no preference fragment is currently shown
+     * @return The currently shown preference fragment as an instance of the class Fragment or null,
+     * if no preference fragment is currently shown
      */
     public final Fragment getPreferenceFragment() {
         return preferenceFragment;
@@ -2787,8 +2786,7 @@ public final void unselectNavigationPreference() {
      *
      * @param fragment
      *         The preference fragment, which contains the navigation's preferences, as an instance
-     *         of the class {@link PreferenceFragmentCompat}. The preference fragment may not be
-     *         null
+     *         of the class PreferenceFragmentCompat. The preference fragment may not be null
      */
     protected void onCreateNavigation(@NonNull final PreferenceFragmentCompat fragment) {
 

diff --git a/library/src/main/java/de/mrapp/android/preference/activity/PreferenceFragmentListener.java b/library/src/main/java/de/mrapp/android/preference/activity/PreferenceFragmentListener.java
@@ -33,7 +33,7 @@ public interface PreferenceFragmentListener {
      *         an instance of the class {@link NavigationPreference}. The navigation preference may
      *         not be null
      * @param fragment
-     *         The fragment, which has been shown, as an instance of the class {@link Fragment}. The
+     *         The fragment, which has been shown, as an instance of the class Fragment. The
      *         fragment may not be null
      */
     void onPreferenceFragmentShown(@NonNull NavigationPreference navigationPreference,
@@ -43,8 +43,8 @@ void onPreferenceFragmentShown(@NonNull NavigationPreference navigationPreferenc
      * The method, which is invoked, when a previously shown preference fragment has been hidden.
      *
      * @param fragment
-     *         The fragment, which has been hidden, as an instance of the class {@link Fragment}.
-     *         The fragment may not be null
+     *         The fragment, which has been hidden, as an instance of the class Fragment. The
+     *         fragment may not be null
      */
     void onPreferenceFragmentHidden(@NonNull Fragment fragment);
 

diff --git a/library/src/main/java/de/mrapp/android/preference/activity/RestoreDefaultsListener.java b/library/src/main/java/de/mrapp/android/preference/activity/RestoreDefaultsListener.java
@@ -46,7 +46,7 @@ public interface RestoreDefaultsListener {
      *         an instance of the class {@link PreferenceFragment}
      * @param preference
      *         The preference, whose default value should be restored, as an instance of the class
-     *         {@link Preference}
+     *         Preference
      * @param currentValue
      *         The current value of the preference, whose default value should be restored, as an
      *         instance of the class {@link Object}
@@ -65,7 +65,7 @@ boolean onRestoreDefaultValueRequested(@NonNull PreferenceFragment fragment,
      *         an instance of the class {@link PreferenceFragment}
      * @param preference
      *         The preference, whose default value has been restored, as an instance of the class
-     *         {@link Preference}
+     *         Preference
      * @param oldValue
      *         The old value of the preference, whose default value has been restored, as an
      *         instance of the class {@link Object}

diff --git a/library/src/main/java/de/mrapp/android/preference/activity/WizardListener.java b/library/src/main/java/de/mrapp/android/preference/activity/WizardListener.java
@@ -37,8 +37,8 @@ public interface WizardListener {
      *         The currently selected navigation preference as an instance of the class {@link
      *         NavigationPreference}. The navigation preference may not be null
      * @param fragment
-     *         The currently shown preference fragment as an instance of the class {@link Fragment}.
-     *         The fragment may not be null
+     *         The currently shown preference fragment as an instance of the class Fragment. The
+     *         fragment may not be null
      * @param bundle
      *         A bundle, which contains the parameters, which have been passed to the currently
      *         shown preference fragment, as an instance of the class {@link Bundle} or null, if no
@@ -57,8 +57,8 @@ Bundle onNextStep(@NonNull NavigationPreference navigationPreference,
      *         The currently selected navigation preference as an instance of the class {@link
      *         NavigationPreference}. The navigation preference may not be null
      * @param fragment
-     *         The currently shown preference fragment as an instance of the class {@link Fragment}.
-     *         The fragment may not be null
+     *         The currently shown preference fragment as an instance of the class Fragment. The
+     *         fragment may not be null
      * @param bundle
      *         A bundle, which contains the parameters, which have been passed to the currently
      *         shown preference fragment, as an instance of the class {@link Bundle} or null, if no
@@ -77,8 +77,8 @@ Bundle onPreviousStep(@NonNull NavigationPreference navigationPreference,
      *         The currently selected navigation preference as an instance of the class {@link
      *         NavigationPreference}. The navigation preference may not be null
      * @param fragment
-     *         The currently shown preference fragment as an instance of the class {@link Fragment}.
-     *         The fragment may not be null
+     *         The currently shown preference fragment as an instance of the class Fragment. The
+     *         fragment may not be null
      * @param bundle
      *         A bundle, which contains the parameters, which have been passed to the currently
      *         shown preference fragment, as an instance of the class {@link Bundle} or null, if no
@@ -95,8 +95,8 @@ boolean onFinish(@NonNull NavigationPreference navigationPreference, @NonNull Fr
      *         The currently selected navigation preference as an instance of the class {@link
      *         NavigationPreference}. The navigation preference may not be null
      * @param fragment
-     *         The currently shown preference fragment as an instance of the class {@link Fragment}.
-     *         The fragment may not be null
+     *         The currently shown preference fragment as an instance of the class Fragment. The
+     *         fragment may not be null
      * @param bundle
      *         A bundle, which contains the parameters, which have been passed to the currently
      *         shown preference fragment, as an instance of the class {@link Bundle} or null, if no

diff --git a/...c/main/java/de/mrapp/android/preference/activity/adapter/NavigationPreferenceAdapter.java b/...c/main/java/de/mrapp/android/preference/activity/adapter/NavigationPreferenceAdapter.java
@@ -303,8 +303,8 @@ public void onItemRangeMoved(final int fromPosition, final int toPosition,
      *
      * @param preferenceScreen
      *         The preference screen, which contains the preferences, which should be managed by the
-     *         adapter, as an instance of the class {@link PreferenceScreen}. The preference screen
-     *         may not be null
+     *         adapter, as an instance of the class PreferenceScreen. The preference screen may not
+     *         be null
      * @param callback
      *         The callback, which should be notified about the adapter's events, as an instance of
      *         the type {@link Callback} or null, if no callback should be notified

diff --git a/library/src/main/java/de/mrapp/android/preference/activity/adapter/PreferenceAdapter.java b/library/src/main/java/de/mrapp/android/preference/activity/adapter/PreferenceAdapter.java
@@ -25,8 +25,8 @@
 import android.text.TextUtils;
 
 /**
- * A recycler view adapter, which extends the class {@link PreferenceGroupAdapter} in order to
- * modify the appearance of preferences.
+ * A recycler view adapter, which extends the class PreferenceGroupAdapter in order to modify the
+ * appearance of preferences.
  *
  * @author Michael Rapp
  * @since 6.0.0
@@ -39,11 +39,11 @@ public class PreferenceAdapter extends PreferenceGroupAdapter {
      * overridden by subclasses in order to modify the appearance of the preference.
      *
      * @param preference
-     *         The preference, which is visualized, as an instance of the class {@link Preference}.
-     *         The preference may not be null
+     *         The preference, which is visualized, as an instance of the class Preference. The
+     *         preference may not be null
      * @param viewHolder
      *         The view holder, which corresponds to the preference, as an instance of the class
-     *         {@link PreferenceViewHolder}. The view holder may not be null
+     *         PreferenceViewHolder. The view holder may not be null
      */
     @CallSuper
     protected void onVisualizePreference(@NonNull final Preference preference,
@@ -57,13 +57,13 @@ protected void onVisualizePreference(@NonNull final Preference preference,
     }
 
     /**
-     * Creates a new recycler view adapter, which extends the class {@link PreferenceGroupAdapter}
-     * in order to modify the appearance of preferences.
+     * Creates a new recycler view adapter, which extends the class PreferenceGroupAdapter in order
+     * to modify the appearance of preferences.
      *
      * @param preferenceScreen
      *         The preference screen, which contains the preferences, which should be managed by the
-     *         adapter, as an instance of the class {@link PreferenceScreen}. The preference screen
-     *         may not be null
+     *         adapter, as an instance of the class PreferenceScreen. The preference screen may not
+     *         be null
      */
     public PreferenceAdapter(@NonNull final PreferenceScreen preferenceScreen) {
         super(preferenceScreen);

diff --git a/...c/main/java/de/mrapp/android/preference/activity/fragment/AbstractPreferenceFragment.java b/...c/main/java/de/mrapp/android/preference/activity/fragment/AbstractPreferenceFragment.java
@@ -228,8 +228,8 @@ public final void setDividerColor(@ColorInt final int color) {
      *
      * @param preferenceScreen
      *         The preference screen, which contains the preferences, which should be managed by the
-     *         adapter, as an instance of the class {@link PreferenceScreen}. The preference screen
-     *         may not be null
+     *         adapter, as an instance of the class PreferenceScreen. The preference screen may not
+     *         be null
      * @return The adapter, which has been created, as an instance of the class {@link
      * PreferenceAdapter}. The adapter may not be null
      */

diff --git a/library/src/main/java/de/mrapp/android/preference/activity/fragment/NavigationFragment.java b/library/src/main/java/de/mrapp/android/preference/activity/fragment/NavigationFragment.java
@@ -53,8 +53,8 @@ public interface Callback {
          * activity.
          *
          * @param fragment
-         *         The navigation fragment as an instance of the class {@link
-         *         PreferenceFragmentCompat}. The fragment may not be null
+         *         The navigation fragment as an instance of the class PreferenceFragmentCompat. The
+         *         fragment may not be null
          */
         void onNavigationFragmentCreated(@NonNull PreferenceFragmentCompat fragment);