Skip to content

Commit a1017f9

Browse files
elPeirettijavier-godoy
authored andcommitted
docs: update javadoc to improve readability
1 parent 38dab16 commit a1017f9

File tree

2 files changed

+6
-6
lines changed

2 files changed

+6
-6
lines changed

src/main/java/com/flowingcode/vaadin/addons/localecombobox/LocaleComboBox.java

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,7 @@ public class LocaleComboBox extends ComboBox<Locale> {
4747
private static final String DEFAULT_FLAG_CODE = "un";
4848

4949
/**
50-
* Display mode representing the built-in display modes in LocaleComboBox
50+
* Display mode representing the built-in display modes in {@link LocaleComboBox}
5151
* <p>
5252
* These enums can be used in {@link #setDisplayMode(DisplayMode)} to easily switch between the
5353
* built-in display modes.
@@ -82,7 +82,7 @@ public enum DisplayMode {
8282
private Locale customDisplayLocale = Locale.getDefault();
8383

8484
/**
85-
* Creates a new instance of LocaleComboBox.
85+
* Creates a new instance of {@code LocaleComboBox}.
8686
*/
8787
public LocaleComboBox() {
8888
setItemLabelGenerator(item -> item.getDisplayName(getLocaleForDisplay()));
@@ -91,9 +91,9 @@ public LocaleComboBox() {
9191
}
9292

9393
/**
94-
* Creates a new instance of LocaleComboBox with the desired locales
94+
* Creates a new instance of {@code LocaleComboBox} with the desired locales
9595
*
96-
* @param locales the {@link Collection} of locales to include in the combobox
96+
* @param locales the {@code Collection} of {@code Locale} to include in the combobox
9797
*/
9898
public LocaleComboBox(Collection<Locale> items) {
9999
this();
@@ -119,7 +119,7 @@ public void setDisplayMode(DisplayMode displayMode) {
119119
* selected as the display mode. If the display mode is any other than {@link DisplayMode#CUSTOM},
120120
* this setting is ignored.
121121
*
122-
* @param displayLocale the locale to use for formatting.
122+
* @param displayLocale the {@code Locale} to use for formatting.
123123
*/
124124
public void setDisplayLocale(Locale displayLocale) {
125125
this.customDisplayLocale = displayLocale == null ? Locale.getDefault() : displayLocale;

src/main/java/com/flowingcode/vaadin/addons/localecombobox/LocaleCountryConverter.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -105,7 +105,7 @@ public class LocaleCountryConverter {
105105
* @param countryCode The country code to be converted. This can be in ISO 3166-1 alpha-2 format
106106
* (e.g., "AR"), ISO 3166-1 alpha-3 format (e.g., "ARG"), or numeric-3 format (e.g.,
107107
* "032").
108-
* @return An {@link Optional} containing the ISO 3166-1 alpha-2 code if the conversion is
108+
* @return An {@code Optional} containing the ISO 3166-1 alpha-2 code if the conversion is
109109
* successful.
110110
*/
111111
public static Optional<String> convertToISO3166Code(String countryCode) {

0 commit comments

Comments
 (0)