Merge branch 'hs/branding-module-extension' into hs/branding-module-extension+favicon

Author: Half-Shot

src/lifecycles/BrandingExtensions.ts

@@ -1,14 +1,32 @@
 interface AppTitleBase {
+    /**
+     * The configured brand name.
+     * @example Element
+     */
     brand: string;
+    /**
+     * Is the client sync loop in an error state.
+     */
     syncError: boolean;
+    /**
+     * The current unread notification count.
+     */
+    unreadNotificationCount?: number;
+    /**
+     * Has the client muted notifications.
+     */
+    notificationsMuted?: boolean;
 }
 
 export interface AppTitleInRoom extends AppTitleBase {
-    brand: string;
+    /**
+     * The room name, may be undefined if the room has no name.
+     */
     roomName?: string;
+    /**
+     * The room ID of the room in view.
+     */
     roomId: string;
-    unreadNotificationCount: number;
-    notificationsMuted: boolean;
 }
 
 export interface GetFaviconParameters {
@@ -27,6 +45,11 @@ export interface GetFaviconParameters {
 export type AppTitleContext = AppTitleBase | AppTitleInRoom;
 
 export interface ProvideBrandingExtensions {
+    /**
+     * Called whenever the client would update the document title.
+     * @param context Current application context used to generate the title.
+     * @returns A string to be used for the full title, or null to use the default title.
+     */
     getAppTitle(context: AppTitleContext): string | null;
     /**
      * Called when the app needs to generate the basic app favicon.