adds typedoc comments

Author: PawelZlakowski

src/app/statistics/matomo.factory.ts

@@ -2,6 +2,20 @@ import { createDefaultMatomoScriptElement } from 'ngx-matomo-client';
 
 import { MatomoService } from './matomo.service';
 
+/**
+ * Creates a custom script factory function that integrates with the `MatomoService`.
+ *
+ * @param matomoService - The instance of `MatomoService` used to track the loading state.
+ * @returns A function to initialize script to listen onload/onerror events by MatomoService
+ *
+ * @example
+ * // In your app config or module providers:
+ * {
+ * provide: MATOMO_SCRIPT_FACTORY,
+ * useFactory: customMatomoScriptFactory,
+ * deps: [MatomoService]
+ * }
+ */
 export function customMatomoScriptFactory(matomoService: MatomoService) {
   return (scriptUrl: string, document: Document): HTMLScriptElement => {
     const script = createDefaultMatomoScriptElement(scriptUrl, document);

src/app/statistics/matomo.service.ts

@@ -176,6 +176,10 @@ export class MatomoService {
       );
   }
 
+  /**
+   * Checks if Matomo script loaded correctly
+   * @returns An Observable that emits a boolean indicating whether Matomo script loaded correctly.
+   */
   isMatomoScriptLoaded$(): Observable<boolean> {
     return this.status$.pipe(
       map(status => status === 'loaded'),