From 19a9fe11be29ee02682de6950b52fe07d65d2810 Mon Sep 17 00:00:00 2001 From: Noel De Martin Date: Thu, 27 Jun 2024 16:35:12 +0200 Subject: [PATCH] MOBILE-4616: Document routing modules --- src/addons/mod/forum/forum.module.ts | 1 + src/app/app-routing.module.ts | 3 +++ .../course/course-contents-routing.module.ts | 4 ++++ .../features/course/course-routing.module.ts | 10 ++++++++++ .../mainmenu/mainmenu-home-routing.module.ts | 9 +++++++++ .../features/mainmenu/mainmenu-routing.module.ts | 10 ++++++++++ .../mainmenu/mainmenu-tab-routing.module.ts | 16 ++++++++++------ .../settings/settings-site-routing.module.ts | 10 ++++++++++ 8 files changed, 57 insertions(+), 6 deletions(-) diff --git a/src/addons/mod/forum/forum.module.ts b/src/addons/mod/forum/forum.module.ts index 6c7d4479a..bdc2095cc 100644 --- a/src/addons/mod/forum/forum.module.ts +++ b/src/addons/mod/forum/forum.module.ts @@ -73,6 +73,7 @@ const mainMenuRoutes: Routes = [ ), ]; +// Single Activity format navigation. const courseContentsRoutes: Routes = conditionalRoutes( [ { diff --git a/src/app/app-routing.module.ts b/src/app/app-routing.module.ts index 0b7abbfa2..d4b603e63 100644 --- a/src/app/app-routing.module.ts +++ b/src/app/app-routing.module.ts @@ -219,6 +219,9 @@ export function resolveModuleRoutes(injector: Injector, token: InjectionToken { return { ngModule: CoreMainMenuTabRoutingModule, diff --git a/src/core/features/settings/settings-site-routing.module.ts b/src/core/features/settings/settings-site-routing.module.ts index a19a7a4bd..a7cf18719 100644 --- a/src/core/features/settings/settings-site-routing.module.ts +++ b/src/core/features/settings/settings-site-routing.module.ts @@ -28,6 +28,16 @@ export function resolveSiteRoutes(injector: Injector): ModuleRoutes { return resolveModuleRoutes(injector, SITE_PREFERENCES_ROUTES); } +/** + * Module used to register routes in the site preferences page. These are routes that must also be declared in a + * CoreSettingsHandler or in plugins using the CoreSettingsDelegate. + * + * Some examples of routes registered in this module are: + * - /main/{tab}/preferences/storage + * - /main/{tab}/preferences/messages + * - /main/{tab}/preferences/notifications + * - ... + */ @NgModule() export class CoreSitePreferencesRoutingModule {