Skip to content

Commit b6f8ad3

Browse files
committed
Reformat all overloadings javadoc for consistency
1 parent a777cde commit b6f8ad3

File tree

2 files changed

+343
-314
lines changed

2 files changed

+343
-314
lines changed

core/src/main/java/com/onelogin/saml2/logout/LogoutRequest.java

Lines changed: 27 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -80,17 +80,19 @@ public class LogoutRequest {
8080
* @param settings
8181
* OneLogin_Saml2_Settings
8282
* @param request
83-
* the HttpRequest object to be processed (Contains GET and POST parameters, request URL, ...).
83+
* the HttpRequest object to be processed (Contains GET and POST
84+
* parameters, request URL, ...).
8485
* @param nameId
8586
* The NameID that will be set in the LogoutRequest.
8687
* @param sessionIndex
87-
* The SessionIndex (taken from the SAML Response in the SSO process).
88+
* The SessionIndex (taken from the SAML Response in the SSO
89+
* process).
8890
* @param nameIdFormat
8991
* The nameIdFormat that will be set in the LogoutRequest.
9092
* @param nameIdNameQualifier
91-
* The NameID NameQualifier that will be set in the LogoutRequest.
93+
* The NameID NameQualifier that will be set in the LogoutRequest.
9294
* @param nameIdSPNameQualifier
93-
* The SP Name Qualifier that will be set in the LogoutRequest.
95+
* The SP Name Qualifier that will be set in the LogoutRequest.
9496
*
9597
* @deprecated use {@link #LogoutRequest(Saml2Settings, HttpRequest)} to build a
9698
* received request from the HTTP request, or
@@ -131,15 +133,17 @@ public LogoutRequest(Saml2Settings settings, HttpRequest request, String nameId,
131133
* @param settings
132134
* OneLogin_Saml2_Settings
133135
* @param request
134-
* the HttpRequest object to be processed (Contains GET and POST parameters, request URL, ...).
136+
* the HttpRequest object to be processed (Contains GET and POST
137+
* parameters, request URL, ...).
135138
* @param nameId
136139
* The NameID that will be set in the LogoutRequest.
137140
* @param sessionIndex
138-
* The SessionIndex (taken from the SAML Response in the SSO process).
141+
* The SessionIndex (taken from the SAML Response in the SSO
142+
* process).
139143
* @param nameIdFormat
140144
* The nameIdFormat that will be set in the LogoutRequest.
141145
* @param nameIdNameQualifier
142-
* The NameID NameQualifier will be set in the LogoutRequest.
146+
* The NameID NameQualifier will be set in the LogoutRequest.
143147
*
144148
* @deprecated use {@link #LogoutRequest(Saml2Settings, HttpRequest)} to build a
145149
* received request from the HTTP request, or
@@ -158,11 +162,13 @@ public LogoutRequest(Saml2Settings settings, HttpRequest request, String nameId,
158162
* @param settings
159163
* OneLogin_Saml2_Settings
160164
* @param request
161-
* the HttpRequest object to be processed (Contains GET and POST parameters, request URL, ...).
165+
* the HttpRequest object to be processed (Contains GET and POST
166+
* parameters, request URL, ...).
162167
* @param nameId
163168
* The NameID that will be set in the LogoutRequest.
164169
* @param sessionIndex
165-
* The SessionIndex (taken from the SAML Response in the SSO process).
170+
* The SessionIndex (taken from the SAML Response in the SSO
171+
* process).
166172
* @param nameIdFormat
167173
* The nameIdFormat that will be set in the LogoutRequest.
168174
*
@@ -183,11 +189,13 @@ public LogoutRequest(Saml2Settings settings, HttpRequest request, String nameId,
183189
* @param settings
184190
* OneLogin_Saml2_Settings
185191
* @param request
186-
* the HttpRequest object to be processed (Contains GET and POST parameters, request URL, ...).
192+
* the HttpRequest object to be processed (Contains GET and POST
193+
* parameters, request URL, ...).
187194
* @param nameId
188195
* The NameID that will be set in the LogoutRequest.
189196
* @param sessionIndex
190-
* The SessionIndex (taken from the SAML Response in the SSO process).
197+
* The SessionIndex (taken from the SAML Response in the SSO
198+
* process).
191199
*
192200
* @deprecated use {@link #LogoutRequest(Saml2Settings, HttpRequest)} to build a
193201
* received request from the HTTP request, or
@@ -201,11 +209,11 @@ public LogoutRequest(Saml2Settings settings, HttpRequest request, String nameId,
201209
}
202210

203211
/**
204-
* Constructs a LogoutRequest object when a new request should be generated
205-
* and sent.
212+
* Constructs a LogoutRequest object when a new request should be generated and
213+
* sent.
206214
*
207215
* @param settings
208-
* OneLogin_Saml2_Settings
216+
* OneLogin_Saml2_Settings
209217
*
210218
* @see #LogoutRequest(Saml2Settings, LogoutRequestParams)
211219
*/
@@ -214,13 +222,14 @@ public LogoutRequest(Saml2Settings settings) {
214222
}
215223

216224
/**
217-
* Constructs the LogoutRequest object when a received request should be extracted
218-
* from the HTTP request and parsed.
225+
* Constructs the LogoutRequest object when a received request should be
226+
* extracted from the HTTP request and parsed.
219227
*
220228
* @param settings
221-
* OneLogin_Saml2_Settings
229+
* OneLogin_Saml2_Settings
222230
* @param request
223-
* the HttpRequest object to be processed (Contains GET and POST parameters, request URL, ...).
231+
* the HttpRequest object to be processed (Contains GET and POST
232+
* parameters, request URL, ...).
224233
*/
225234
public LogoutRequest(Saml2Settings settings, HttpRequest request) {
226235
this(settings, request, null, null);

0 commit comments

Comments
 (0)