115491: Add doc comments & apply minor fixes

Author: AAwouters

src/app/bitstream-page/edit-bitstream-page/edit-bitstream-page.component.ts

@@ -527,7 +527,7 @@ export class EditBitstreamPageComponent implements OnInit, OnDestroy {
     this.updateFormatModel();
 
     if (this.isIIIF) {
-      this.appendFormWIthIiifFields();
+      this.appendFormWithIiifFields();
     }
   }
 
@@ -543,7 +543,6 @@ export class EditBitstreamPageComponent implements OnInit, OnDestroy {
    */
   updateForm() {
     const bitstream = this.bitstream;
-    const format = this.bitstreamFormat;
 
     this.formGroup.patchValue({
       fileNamePrimaryContainer: {
@@ -574,7 +573,7 @@ export class EditBitstreamPageComponent implements OnInit, OnDestroy {
       });
     }
 
-    this.bitstreamFormat = format;
+    const format = this.bitstreamFormat;
     this.formGroup.patchValue({
       formatContainer: {
         selectedFormat: format.id
@@ -661,6 +660,9 @@ export class EditBitstreamPageComponent implements OnInit, OnDestroy {
     );
   }
 
+  /**
+   * Collects all observables that update the different parts of the bitstream.
+   */
   getUpdateObservables(updatedValues: any): ObservablesDictionary<UpdateResult> {
     return {
       metadataUpdateRD: this.updateBitstreamMetadataRD$(updatedValues),
@@ -669,6 +671,9 @@ export class EditBitstreamPageComponent implements OnInit, OnDestroy {
     };
   }
 
+  /**
+   * Creates and returns an observable that updates the bitstream metadata according to the data in the form.
+   */
   updateBitstreamMetadataRD$(updatedValues: any): Observable<RemoteData<Bitstream>> {
     const updatedBitstream = this.formToBitstream(updatedValues);
 
@@ -776,6 +781,11 @@ export class EditBitstreamPageComponent implements OnInit, OnDestroy {
     return updatedBitstream;
   }
 
+  /**
+   * Handle the update result by checking for errors.
+   * When there are no errors, the user is redirected to the edit-bitstreams page.
+   * When there are errors, a notification is shown.
+   */
   handleUpdateResult(updateResult: UpdateResult) {
     let errorWhileSaving = false;
 
@@ -846,7 +856,10 @@ export class EditBitstreamPageComponent implements OnInit, OnDestroy {
     return isImage && isIIIFBundle && isEnabled;
   }
 
-  appendFormWIthIiifFields(): void {
+  /**
+   * Extend the form with IIIF fields
+   */
+  appendFormWithIiifFields(): void {
     this.inputModels.push(this.iiifLabelModel);
     this.formModel.push(this.iiifLabelContainer);
     this.inputModels.push(this.iiifTocModel);

src/app/shared/utils/observables-dictionary.ts

@@ -29,7 +29,7 @@ export type ObservablesDictionary<T extends { [key: string]: any }> = {
   }
 
   Now the input for the 'combineLatest' should be of type ObservablesDictionary<MyData>.
-  In essence ObservablesDictionary<T> creates a copy of the defined interface T, while making observables of all T's
+  In essence ObservablesDictionary<T> creates a copy of the defined interface T, while making observables of all of T's
   fields. ObservablesDictionary<T> also applies the additional constraint that all the keys of T must be strings, which
   is required for objects used in 'combineLatest'.
 
@@ -55,7 +55,7 @@ export type ObservablesDictionary<T extends { [key: string]: any }> = {
 
 
   An example of this type in action can be found in the edit-bitstream-page component (as of writing this explainer).
-  The edit-bitstream-page has the following interface with that contains the required data:
+  The edit-bitstream-page has the following interface that contains the required data:
 
   interface DataObjects {
     bitstream: Bitstream,