docs: update javadoc to improve readability

FlowingCode · Aug 22, 2024 · a1017f9 · a1017f9
1 parent 38dab16
commit a1017f9
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 6 deletions.
diff --git a/src/main/java/com/flowingcode/vaadin/addons/localecombobox/LocaleComboBox.java b/src/main/java/com/flowingcode/vaadin/addons/localecombobox/LocaleComboBox.java
@@ -47,7 +47,7 @@ public class LocaleComboBox extends ComboBox<Locale> {
   private static final String DEFAULT_FLAG_CODE = "un";
 
   /**
-   * Display mode representing the built-in display modes in LocaleComboBox
+   * Display mode representing the built-in display modes in {@link LocaleComboBox}
    * <p>
    * These enums can be used in {@link #setDisplayMode(DisplayMode)} to easily switch between the
    * built-in display modes.
@@ -82,7 +82,7 @@ public enum DisplayMode {
   private Locale customDisplayLocale = Locale.getDefault();
 
   /**
-   * Creates a new instance of LocaleComboBox.
+   * Creates a new instance of {@code LocaleComboBox}.
    */
   public LocaleComboBox() {
     setItemLabelGenerator(item -> item.getDisplayName(getLocaleForDisplay()));
@@ -91,9 +91,9 @@ public LocaleComboBox() {
   }
 
   /**
-   * Creates a new instance of LocaleComboBox with the desired locales
+   * Creates a new instance of {@code LocaleComboBox} with the desired locales
    * 
-   * @param locales the {@link Collection} of locales to include in the combobox
+   * @param locales the {@code Collection} of {@code Locale} to include in the combobox
    */
   public LocaleComboBox(Collection<Locale> items) {
     this();
@@ -119,7 +119,7 @@ public void setDisplayMode(DisplayMode displayMode) {
    * selected as the display mode. If the display mode is any other than {@link DisplayMode#CUSTOM},
    * this setting is ignored.
    * 
-   * @param displayLocale the locale to use for formatting.
+   * @param displayLocale the {@code Locale} to use for formatting.
    */
   public void setDisplayLocale(Locale displayLocale) {
     this.customDisplayLocale = displayLocale == null ? Locale.getDefault() : displayLocale;

diff --git a/src/main/java/com/flowingcode/vaadin/addons/localecombobox/LocaleCountryConverter.java b/src/main/java/com/flowingcode/vaadin/addons/localecombobox/LocaleCountryConverter.java
@@ -105,7 +105,7 @@ public class LocaleCountryConverter {
    * @param countryCode The country code to be converted. This can be in ISO 3166-1 alpha-2 format
    *        (e.g., "AR"), ISO 3166-1 alpha-3 format (e.g., "ARG"), or numeric-3 format (e.g.,
    *        "032").
-   * @return An {@link Optional} containing the ISO 3166-1 alpha-2 code if the conversion is
+   * @return An {@code Optional} containing the ISO 3166-1 alpha-2 code if the conversion is
    *         successful.
    */
   public static Optional<String> convertToISO3166Code(String countryCode) {