86016: Add typedocs

src/app/correlation-id/correlation-id.actions.ts

@@ -5,6 +5,9 @@ export const CorrelationIDActionTypes = {
   SET: type('dspace/core/correlationId/SET')
 };
 
+/**
+ * Action for setting a new correlation ID
+ */
 export class SetCorrelationIdAction implements Action {
   type = CorrelationIDActionTypes.SET;
 
@@ -12,4 +15,7 @@ export class SetCorrelationIdAction implements Action {
   }
 }
 
+/**
+ * Type alias for all correlation ID actions
+ */
 export type CorrelationIdAction = SetCorrelationIdAction;

src/app/correlation-id/correlation-id.reducer.ts

@@ -9,6 +9,12 @@ const initialState = null;
 
 export const correlationIdSelector = (state: AppState) => state.correlationId;
 
+/**
+ * Reducer that handles actions to update the correlation ID
+ * @param {string} state                the previous correlation ID (null if unset)
+ * @param {CorrelationIdAction} action  the action to perform
+ * @return {string}                     the new correlation ID
+ */
 export const correlationIdReducer = (state = initialState, action: CorrelationIdAction): string => {
   switch (action.type) {
     case CorrelationIDActionTypes.SET: {