Skip to content

Commit c38352e

Browse files
committed
119602: Update doc comments
1 parent deb4a63 commit c38352e

2 files changed

Lines changed: 15 additions & 2 deletions

File tree

src/app/accessibility/accessibility-settings.service.ts

Lines changed: 12 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -23,16 +23,22 @@ export const ACCESSIBILITY_SETTINGS_METADATA_KEY = 'dspace.accessibility.setting
2323

2424
/**
2525
* Enum containing all possible accessibility settings.
26-
* When adding new settings, the {@link AccessibilitySettingsService#getInputType} method and the i18n keys for the
27-
* accessibility settings page should be updated.
26+
* When adding new settings, make sure to add the new setting to the accessibility-settings component.
27+
* The converter methods to convert from stored format to form format (and vice-versa) need to be updated as well.
2828
*/
2929
export enum AccessibilitySetting {
3030
NotificationTimeOut = 'notificationTimeOut',
3131
LiveRegionTimeOut = 'liveRegionTimeOut',
3232
}
3333

34+
/**
35+
* Type representing an object that contains accessibility settings values.
36+
*/
3437
export type AccessibilitySettings = { [key in AccessibilitySetting]?: string };
3538

39+
/**
40+
* The accessibility settings object format used by the accessibility-settings component form.
41+
*/
3642
export interface AccessibilitySettingsFormValues {
3743
disableNotificationTimeOut: boolean,
3844
notificationTimeOut: string,
@@ -226,6 +232,10 @@ export class AccessibilitySettingsService {
226232
return this.setSettingsInAuthenticatedUserMetadata({});
227233
}
228234

235+
/**
236+
* Retrieve the placeholder to be used for the provided AccessibilitySetting.
237+
* Returns an empty string when no placeholder is specified for the provided setting.
238+
*/
229239
getPlaceholder(setting: AccessibilitySetting): string {
230240
switch (setting) {
231241
case AccessibilitySetting.NotificationTimeOut:

src/app/info/accessibility-settings/accessibility-settings.component.ts

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,9 @@ import { take } from 'rxjs';
99
import { NotificationsService } from '../../shared/notifications/notifications.service';
1010
import { TranslateService } from '@ngx-translate/core';
1111

12+
/**
13+
* Component providing the form where users can update accessibility settings.
14+
*/
1215
@Component({
1316
selector: 'ds-accessibility-settings',
1417
templateUrl: './accessibility-settings.component.html'

0 commit comments

Comments
 (0)