Skip to content

Commit 3a77957

Browse files
committed
docs: clarify "errorMessage" constructor parameter
1 parent e294cdc commit 3a77957

File tree

1 file changed

+8
-6
lines changed

1 file changed

+8
-6
lines changed

src/main/java/com/flowingcode/vaadin/addons/errorwindow/ErrorWindow.java

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -98,10 +98,11 @@ public ErrorWindow(final Throwable cause, final ErrorWindowI18n i18n) {
9898
}
9999

100100
/**
101-
* Constructs and initializes an ErrorWindow object with the supplied details and default and default production mode and i18n.
101+
* Constructs and initializes an ErrorWindow object with the supplied details and default
102+
* production mode and i18n.
102103
*
103104
* @param cause The cause of the error
104-
* @param errorMessage An optional error message
105+
* @param errorMessage An optional error message that is displayed when production mode is false
105106
*
106107
* @deprecated The error message specified with this constructor is only displayed when production
107108
* mode is false. Use {@link #ErrorWindow(Throwable, ErrorWindowI18n)} for specifying
@@ -113,10 +114,11 @@ public ErrorWindow(final Throwable cause, final String errorMessage) {
113114
}
114115

115116
/**
116-
* Constructs and initializes an ErrorWindow object with the supplied details and default production mode.
117+
* Constructs and initializes an ErrorWindow object with the supplied details and default
118+
* production mode.
117119
*
118120
* @param cause The cause of the error
119-
* @param errorMessage An optional error message
121+
* @param errorMessage An optional error message that is displayed when production mode is false
120122
* @param i18n The internationalization of the ErrorWindow
121123
*/
122124
public ErrorWindow(final Throwable cause, final String errorMessage, final ErrorWindowI18n i18n) {
@@ -127,7 +129,7 @@ public ErrorWindow(final Throwable cause, final String errorMessage, final Error
127129
* Constructs and initializes an ErrorWindow object with the supplied details and default i18n.
128130
*
129131
* @param cause The cause of the error
130-
* @param errorMessage An optional error message
132+
* @param errorMessage An optional error message that is displayed when production mode is false
131133
* @param productionMode The mode in which the Application is running. If true, a code is
132134
* displayed with error details, else debug information is shown
133135
*/
@@ -139,7 +141,7 @@ public ErrorWindow(final Throwable cause, final String errorMessage, boolean pro
139141
* Constructs and initializes an ErrorWindow object with the supplied details.
140142
*
141143
* @param cause The cause of the error
142-
* @param errorMessage An optional error message
144+
* @param errorMessage An optional error message that is displayed when production mode is false
143145
* @param productionMode The mode in which the Application is running. If true, a code is
144146
* displayed with error details, else debug information is shown
145147
* @param i18n The internationalization of the ErrorWindow

0 commit comments

Comments
 (0)