Skip to content

Commit 39c92bc

Browse files
author
Paul Gray
committed
Fixing javadoc errors
1 parent ebda516 commit 39c92bc

File tree

2 files changed

+95
-92
lines changed

2 files changed

+95
-92
lines changed

src/main/java/org/imsglobal/lti/BasicLTIConstants.java

Lines changed: 47 additions & 47 deletions
Original file line numberDiff line numberDiff line change
@@ -138,13 +138,13 @@ public class BasicLTIConstants {
138138
*/
139139
public static final String LAUNCH_PRESENTATION_WIDTH = "launch_presentation_width";
140140
/**
141-
* launch_presentation_css_url=http://www.toolconsumer.url/path/to/lti.css
141+
* launch_presentation_css_url=http://www.toolconsumer.url/path/to/lti.css
142142
* <p>
143143
* This points to a fully qualified URL for a CSS which can be used to style the tool.
144-
* There are no officially defined CSS classes for this file, but the Consumer can
145-
* apply styles to paragraphs, body, and the various HTML elements. It is up to the
144+
* There are no officially defined CSS classes for this file, but the Consumer can
145+
* apply styles to paragraphs, body, and the various HTML elements. It is up to the
146146
* tool as to whether this CSS is used or not, and in what order this is included relative
147-
* to the tool-specific CSS.
147+
* to the tool-specific CSS.
148148
*/
149149
public static final String LAUNCH_PRESENTATION_CSS_URL = "launch_presentation_css_url";
150150
/**
@@ -183,44 +183,44 @@ public class BasicLTIConstants {
183183
/**
184184
* lis_person_sourcedid=school.edu:user
185185
* <p>
186-
* This field contains the LIS identifier for the user account that is
187-
* performing this launch. The example syntax of "school:user"
186+
* This field contains the LIS identifier for the user account that is
187+
* performing this launch. The example syntax of "school:user"
188188
* is not the required format – lis_person_sourcedid is simply a
189-
* unique identifier (i.e., a normalized string). This field
190-
* is optional and its content and meaning are defined by LIS.
189+
* unique identifier (i.e., a normalized string). This field
190+
* is optional and its content and meaning are defined by LIS.
191191
*/
192192
public static final String LIS_PERSON_SOURCEDID = "lis_person_sourcedid";
193193

194194
/**
195-
* lis_course_offering_sourcedid=school.edu:SI182-F08 <br/>
195+
* lis_course_offering_sourcedid=school.edu:SI182-F08
196196
* lis_course_section_sourcedid=school.edu:SI182-001-F08
197197
* <p>
198-
* These fields contain LIS course identifiers associated with the
199-
* context of this launch. These fields are optional and their
200-
* content and meaning are defined by LIS.
198+
* These fields contain LIS course identifiers associated with the
199+
* context of this launch. These fields are optional and their
200+
* content and meaning are defined by LIS.
201201
*/
202202
public static final String LIS_COURSE_OFFERING_SOURCEDID = "lis_course_offering_sourcedid";
203203
public static final String LIS_COURSE_SECTION_SOURCEDID = "lis_course_section_sourcedid";
204204

205205
/**
206206
* lis_outcome_service_url=http://lmsng.school.edu/service/ltiout/
207207
* <p>
208-
* This field should be no more than 1023 characters long and the TP
209-
* should assume that the URL might change from launch to launch and
210-
* allow for the fact that a TC might change their service URL from
211-
* launch to launch and only use the most recent value for this
212-
* parameter. The service URL may support various operations / services.
213-
* The TC will respond with a response of 'unimplemented' for services
214-
* it does not support.
208+
* This field should be no more than 1023 characters long and the TP
209+
* should assume that the URL might change from launch to launch and
210+
* allow for the fact that a TC might change their service URL from
211+
* launch to launch and only use the most recent value for this
212+
* parameter. The service URL may support various operations / services.
213+
* The TC will respond with a response of 'unimplemented' for services
214+
* it does not support.
215215
*/
216216
public static final String LIS_OUTCOME_SERVICE_URL = "lis_outcome_service_url";
217217

218218
/**
219219
* lis_result_sourcedid=83873872987329873264783687634
220220
* <p>
221-
* This field contains an identifier that indicates the LIS Result
222-
* Identifier (if any) associated with this launch. This field is
223-
* optional and its content and meaning is defined by LIS.
221+
* This field contains an identifier that indicates the LIS Result
222+
* Identifier (if any) associated with this launch. This field is
223+
* optional and its content and meaning is defined by LIS.
224224
*/
225225
public static final String LIS_RESULT_SOURCEDID = "lis_result_sourcedid";
226226

@@ -245,15 +245,15 @@ public class BasicLTIConstants {
245245
public static final String LTI_VERSION_1 = "LTI-1p0";
246246
public static final String LTI_VERSION_2 = "LTI-2p0";
247247

248-
/**
248+
/**
249249
* tool_consumer_info_product_family_code=desire2learn
250250
* <p>
251-
* In order to better assist tools in using extensions and also making their user
252-
* interface fit into the TC's user interface that they are being called from,
253-
* each TC is encouraged to include the this parameter. Possible example values
251+
* In order to better assist tools in using extensions and also making their user
252+
* interface fit into the TC's user interface that they are being called from,
253+
* each TC is encouraged to include the this parameter. Possible example values
254254
* for this field might be:
255-
*
256-
* learn
255+
*
256+
* learn
257257
* desire2learn
258258
* sakai
259259
* eracer
@@ -263,12 +263,12 @@ public class BasicLTIConstants {
263263
*/
264264
public static final String TOOL_CONSUMER_INFO_PRODUCT_FAMILY_CODE = "tool_consumer_info_product_family_code";
265265

266-
/**
266+
/**
267267
* tool_consumer_info_version=9.2.4
268268
* <p>
269269
* This field should have a major release number followed by a period. The format of the minor release is flexible. Possible vaues for this field might be:
270-
*
271-
* 9.1.7081
270+
*
271+
* 9.1.7081
272272
* 2.8-01
273273
* 7.1
274274
* 8
@@ -292,16 +292,16 @@ public class BasicLTIConstants {
292292
/**
293293
* resource_link_title=My Weekly Wiki
294294
* <p>
295-
* A title for the resource. This is the clickable text that appears
295+
* A title for the resource. This is the clickable text that appears
296296
* in the link. This parameter is recommended.
297297
*/
298298
public static final String RESOURCE_LINK_TITLE = "resource_link_title";
299299

300300
/**
301301
* resource_link_description=…
302302
* <p>
303-
* A plain text description of the link’s destination, suitable for
304-
* display alongside the link. Typically no more than several lines
303+
* A plain text description of the link’s destination, suitable for
304+
* display alongside the link. Typically no more than several lines
305305
* long. This parameter is optional.
306306
*/
307307
public static final String RESOURCE_LINK_DESCRIPTION = "resource_link_description";
@@ -324,13 +324,13 @@ public class BasicLTIConstants {
324324
/**
325325
* tc_profile_url=http://...
326326
* <p>
327-
* This URL specifies the address where the Tool Provider can retrieve
328-
* the Tool Consumer Profile. This URL must be retrievable by a GET
329-
* request by the Tool Provider. If the URL is protected from retrieval
330-
* in general, the Tool Consumer must append the necessary parameters to
331-
* allow the Tool Provider to retrieve the URL with nothing more than
332-
* a GET request. It is legal for this URL to contain a security token
333-
* that is changed for each ToolProxyRegistrationRequest so the Tool
327+
* This URL specifies the address where the Tool Provider can retrieve
328+
* the Tool Consumer Profile. This URL must be retrievable by a GET
329+
* request by the Tool Provider. If the URL is protected from retrieval
330+
* in general, the Tool Consumer must append the necessary parameters to
331+
* allow the Tool Provider to retrieve the URL with nothing more than
332+
* a GET request. It is legal for this URL to contain a security token
333+
* that is changed for each ToolProxyRegistrationRequest so the Tool
334334
* Provider must retrieve the tc_profile_url on each request.
335335
*/
336336
public static final String TC_PROFILE_URL = "tc_profile_url";
@@ -400,7 +400,7 @@ public class BasicLTIConstants {
400400
* This parameter is optional and is unique to the Sakai Basic LTI provider.
401401
*/
402402
public static final String EXT_SAKAI_PROVIDER_EID = "ext_sakai_provider_eid";
403-
403+
404404
/**
405405
* ext_sakai_provider_displayid=john.smith
406406
* <p>
@@ -420,20 +420,20 @@ public class BasicLTIConstants {
420420
LAUNCH_PRESENTATION_DOCUMENT_TARGET, LAUNCH_PRESENTATION_HEIGHT,
421421
LAUNCH_PRESENTATION_LOCALE, LAUNCH_PRESENTATION_RETURN_URL,
422422
LAUNCH_PRESENTATION_WIDTH, LIS_PERSON_CONTACT_EMAIL_PRIMARY,
423-
LAUNCH_PRESENTATION_CSS_URL,
423+
LAUNCH_PRESENTATION_CSS_URL,
424424
TOOL_CONSUMER_INFO_PRODUCT_FAMILY_CODE,
425425
TOOL_CONSUMER_INFO_VERSION,
426426
LIS_PERSON_NAME_FAMILY, LIS_PERSON_NAME_FULL, LIS_PERSON_NAME_GIVEN,
427-
LIS_PERSON_SOURCEDID, LIS_COURSE_OFFERING_SOURCEDID,
428-
LIS_COURSE_SECTION_SOURCEDID,
427+
LIS_PERSON_SOURCEDID, LIS_COURSE_OFFERING_SOURCEDID,
428+
LIS_COURSE_SECTION_SOURCEDID,
429429
LIS_OUTCOME_SERVICE_URL, LIS_RESULT_SOURCEDID,
430-
LTI_MESSAGE_TYPE, LTI_VERSION, RESOURCE_LINK_ID,
430+
LTI_MESSAGE_TYPE, LTI_VERSION, RESOURCE_LINK_ID,
431431
RESOURCE_LINK_TITLE, RESOURCE_LINK_DESCRIPTION, ROLES,
432432
TC_PROFILE_URL,
433433
TOOL_CONSUMER_INSTANCE_CONTACT_EMAIL, TOOL_CONSUMER_INSTANCE_DESCRIPTION,
434434
TOOL_CONSUMER_INSTANCE_GUID, TOOL_CONSUMER_INSTANCE_NAME,
435435
TOOL_CONSUMER_INSTANCE_URL, USER_ID, USER_IMAGE };
436-
436+
437437
/**
438438
* The default site type to use if a site needs to be created. Can be overriden in sakai.properties or as part of the launch.
439439
* This contains a number of preconfigured roles, so that the IMS role vocabulary can be used.

0 commit comments

Comments
 (0)