diff --git a/lib/content-services/src/lib/agent/services/agent.service.ts b/lib/content-services/src/lib/agent/services/agent.service.ts index 64225cd5ed6..739997ee936 100644 --- a/lib/content-services/src/lib/agent/services/agent.service.ts +++ b/lib/content-services/src/lib/agent/services/agent.service.ts @@ -39,6 +39,7 @@ export class AgentService { /** * Gets all agents from cache. If cache is empty, fetches agents from backend. + * * @returns Agent[] list containing agents. */ getAgents(): Observable { diff --git a/lib/content-services/src/lib/api-factories/alfresco-api-v2-loader.service.ts b/lib/content-services/src/lib/api-factories/alfresco-api-v2-loader.service.ts index dc7426f1278..2fd4e06cdb8 100644 --- a/lib/content-services/src/lib/api-factories/alfresco-api-v2-loader.service.ts +++ b/lib/content-services/src/lib/api-factories/alfresco-api-v2-loader.service.ts @@ -22,6 +22,7 @@ import { AlfrescoApiService } from '../services/alfresco-api.service'; /** * Create a factory to resolve an api service instance + * * @param angularAlfrescoApiService loader service * @returns factory function */ diff --git a/lib/content-services/src/lib/auth-loader/content-auth-loader-factory.ts b/lib/content-services/src/lib/auth-loader/content-auth-loader-factory.ts index 7879e7b5e70..2c38e49b4cf 100644 --- a/lib/content-services/src/lib/auth-loader/content-auth-loader-factory.ts +++ b/lib/content-services/src/lib/auth-loader/content-auth-loader-factory.ts @@ -19,6 +19,7 @@ import { ContentAuthLoaderService } from './content-auth-loader.service'; /** * Create a content auth factory + * * @param authLoaderService service dependency * @returns factory function */ diff --git a/lib/content-services/src/lib/breadcrumb/dropdown-breadcrumb.component.ts b/lib/content-services/src/lib/breadcrumb/dropdown-breadcrumb.component.ts index c3d8015836b..0db1584e806 100644 --- a/lib/content-services/src/lib/breadcrumb/dropdown-breadcrumb.component.ts +++ b/lib/content-services/src/lib/breadcrumb/dropdown-breadcrumb.component.ts @@ -62,6 +62,7 @@ export class DropdownBreadcrumbComponent extends BreadcrumbComponent implements /** * Check if route has more than one element (means: we are not in the root directory) + * * @returns `true` if there are previous nodes, otherwise `false` */ hasPreviousNodes(): boolean { diff --git a/lib/content-services/src/lib/category/categories-management/categories-management.component.spec.ts b/lib/content-services/src/lib/category/categories-management/categories-management.component.spec.ts index 01040b65fee..7eaa01655d5 100644 --- a/lib/content-services/src/lib/category/categories-management/categories-management.component.spec.ts +++ b/lib/content-services/src/lib/category/categories-management/categories-management.component.spec.ts @@ -68,6 +68,7 @@ describe('CategoriesManagementComponent', () => { /** * Get no categories message + * * @returns message text */ function getNoCategoriesMessage(): string { @@ -76,6 +77,7 @@ describe('CategoriesManagementComponent', () => { /** * Get assigned categories list + * * @returns list of native elements */ function getAssignedCategoriesList(): HTMLSpanElement[] { @@ -84,6 +86,7 @@ describe('CategoriesManagementComponent', () => { /** * Get the exiting categories list + * * @returns list of material option element */ function getExistingCategoriesList(): HTMLElement[] { @@ -92,6 +95,7 @@ describe('CategoriesManagementComponent', () => { /** * Create new category + * * @param name name of the category * @param addUsingEnter use Enter key * @param typingTimeout typing timeout in milliseconds (default 300) @@ -111,6 +115,7 @@ describe('CategoriesManagementComponent', () => { /** * Get first error + * * @returns error text */ function getFirstError(): string { @@ -119,6 +124,7 @@ describe('CategoriesManagementComponent', () => { /** * Get selection list + * * @returns material selection list */ function getSelectionList(): MatList { @@ -127,6 +133,7 @@ describe('CategoriesManagementComponent', () => { /** * Get remove category buttons + * * @returns list of native elements */ function getRemoveCategoryButtons(): HTMLButtonElement[] { @@ -137,6 +144,7 @@ describe('CategoriesManagementComponent', () => { /** * Get category control input + * * @returns native input element */ function getCategoryControlInput(): HTMLInputElement { @@ -145,6 +153,7 @@ describe('CategoriesManagementComponent', () => { /** * Get create category label + * * @returns native element */ function getCreateCategoryLabel(): HTMLSpanElement { @@ -153,6 +162,7 @@ describe('CategoriesManagementComponent', () => { /** * Type new category + * * @param name name of the category * @param timeout typing timeout in milliseconds (default 300) */ diff --git a/lib/content-services/src/lib/category/categories-management/categories-management.component.ts b/lib/content-services/src/lib/category/categories-management/categories-management.component.ts index 83b7f579f31..9cfd421dbe2 100644 --- a/lib/content-services/src/lib/category/categories-management/categories-management.component.ts +++ b/lib/content-services/src/lib/category/categories-management/categories-management.component.ts @@ -103,6 +103,7 @@ export class CategoriesManagementComponent implements OnInit, OnDestroy { /** * Decides if categoryNameControl should be visible. Sets also existing categories panel visibility * and scrolls control into view when visible. + * * @param categoryNameControlVisible control visibility. */ @Input() @@ -179,7 +180,9 @@ export class CategoriesManagementComponent implements OnInit, OnDestroy { ) .subscribe((name: string) => this.onNameControlValueChange(name)); - this.categoryNameControl.statusChanges.pipe(takeUntilDestroyed(this.destroyRef)).subscribe(() => this.setCategoryNameControlErrorMessageKey()); + this.categoryNameControl.statusChanges + .pipe(takeUntilDestroyed(this.destroyRef)) + .subscribe(() => this.setCategoryNameControlErrorMessageKey()); this.setCategoryNameControlErrorMessageKey(); @@ -256,6 +259,7 @@ export class CategoriesManagementComponent implements OnInit, OnDestroy { /** * Adds existing category to categories list and removes it from existing categories list. + * * @param category - selection list change containing selected category */ addCategoryToAssign(category: Category) { @@ -270,6 +274,7 @@ export class CategoriesManagementComponent implements OnInit, OnDestroy { /** * Removes the category from categories list and adds it to existing categories list in ASSIGN mode. + * * @param category - category to remove */ removeCategory(category: Category) { diff --git a/lib/content-services/src/lib/category/services/category.service.ts b/lib/content-services/src/lib/category/services/category.service.ts index 8d1ad336456..9471daa8a46 100644 --- a/lib/content-services/src/lib/category/services/category.service.ts +++ b/lib/content-services/src/lib/category/services/category.service.ts @@ -53,6 +53,7 @@ export class CategoryService { /** * Get subcategories of a given parent category + * * @param parentCategoryId The identifier of a parent category. * @param skipCount Number of top categories to skip. * @param maxItems Maximum number of subcategories returned from Observable. @@ -64,6 +65,7 @@ export class CategoryService { /** * Get a category by ID + * * @param categoryId The identifier of a category. * @param opts Optional parameters. * @param opts.fields A list of field names. @@ -78,6 +80,7 @@ export class CategoryService { /** * Creates subcategories under category with provided categoryId + * * @param parentCategoryId The identifier of a parent category. * @param payload List of categories to be created. * @returns Observable @@ -88,6 +91,7 @@ export class CategoryService { /** * Updates category + * * @param categoryId The identifier of a category. * @param payload Updated category body * @returns Observable @@ -98,6 +102,7 @@ export class CategoryService { /** * Deletes category + * * @param categoryId The identifier of a category. * @returns Observable */ @@ -107,6 +112,7 @@ export class CategoryService { /** * Searches categories by their name. + * * @param name Value for name which should be used during searching categories. * @param skipCount Specify how many first results should be skipped. Default 0. * @param maxItems Specify max number of returned categories. Default is specified by UserPreferencesService. @@ -131,6 +137,7 @@ export class CategoryService { /** * List of categories that node is assigned to + * * @param nodeId The identifier of a node. * @returns Observable Categories that node is assigned to */ @@ -140,6 +147,7 @@ export class CategoryService { /** * Unlink category from a node + * * @param nodeId The identifier of a node. * @param categoryId The identifier of a category. * @returns Observable @@ -150,6 +158,7 @@ export class CategoryService { /** * Link node to a category + * * @param nodeId The identifier of a node. * @param categoryLinkBodyCreate Array of a categories that node will be linked to. * @returns Observable @@ -160,6 +169,7 @@ export class CategoryService { /** * Checks if categories plugin is enabled. + * * @returns boolean true if categories plugin is enabled, false otherwise. */ areCategoriesEnabled(): boolean { diff --git a/lib/content-services/src/lib/common/interfaces/search-configuration.interface.ts b/lib/content-services/src/lib/common/interfaces/search-configuration.interface.ts index 6a4a5f2d6b7..91fb3d1da04 100644 --- a/lib/content-services/src/lib/common/interfaces/search-configuration.interface.ts +++ b/lib/content-services/src/lib/common/interfaces/search-configuration.interface.ts @@ -20,6 +20,7 @@ import { SearchRequest } from '@alfresco/js-api'; export interface SearchConfigurationInterface { /** * Generates a query object with custom search parameters. + * * @param searchTerm Term text to search for * @param maxResults Maximum number of search results to show in a page * @param skipCount The offset of the start of the page within the results list diff --git a/lib/content-services/src/lib/common/services/content.service.ts b/lib/content-services/src/lib/common/services/content.service.ts index 692d14ce497..29b3ce278cd 100644 --- a/lib/content-services/src/lib/common/services/content.service.ts +++ b/lib/content-services/src/lib/common/services/content.service.ts @@ -48,6 +48,7 @@ export class ContentService { /** * Gets a content URL for the given node. + * * @param node Node or Node ID to get URL for. * @param attachment Toggles whether to retrieve content as an attachment for download * @param ticket Custom ticket to use for authentication @@ -75,6 +76,7 @@ export class ContentService { /** * Checks if the user has permission on that node + * * @param node Node to check permissions * @param permission Required permission type * @param userId Optional current user id will be taken by default @@ -108,6 +110,7 @@ export class ContentService { /** * Checks if the user has permissions on that node + * * @param node Node to check allowableOperations * @param allowableOperation Create, delete, update, updatePermissions, !create, !delete, !update, !updatePermissions * @returns True if the user has the required permissions, false otherwise diff --git a/lib/content-services/src/lib/common/services/discovery-api.service.ts b/lib/content-services/src/lib/common/services/discovery-api.service.ts index f3ae479642f..3a8ab25974c 100644 --- a/lib/content-services/src/lib/common/services/discovery-api.service.ts +++ b/lib/content-services/src/lib/common/services/discovery-api.service.ts @@ -52,6 +52,7 @@ export class DiscoveryApiService { /** * Gets product information for Content Services. + * * @returns ProductVersionModel containing product details */ getEcmProductInfo(): Observable { @@ -63,6 +64,7 @@ export class DiscoveryApiService { /** * Gets product information for Process Services. + * * @returns ProductVersionModel containing product details */ getBpmProductInfo(): Observable { diff --git a/lib/content-services/src/lib/common/services/favorites-api.service.ts b/lib/content-services/src/lib/common/services/favorites-api.service.ts index 35b3779fb92..cf6dcc351a3 100644 --- a/lib/content-services/src/lib/common/services/favorites-api.service.ts +++ b/lib/content-services/src/lib/common/services/favorites-api.service.ts @@ -63,6 +63,7 @@ export class FavoritesApiService { /** * Gets the favorites for a user. + * * @param personId ID of the user * @param options Options supported by JS-API * @returns List of favorites diff --git a/lib/content-services/src/lib/common/services/nodes-api.service.ts b/lib/content-services/src/lib/common/services/nodes-api.service.ts index a163e5dcb7b..01a896fbcf0 100644 --- a/lib/content-services/src/lib/common/services/nodes-api.service.ts +++ b/lib/content-services/src/lib/common/services/nodes-api.service.ts @@ -63,6 +63,7 @@ export class NodesApiService { /** * Gets the stored information about a node. + * * @param nodeId ID of the target node * @param options Optional parameters supported by JS-API * @returns Node information @@ -81,6 +82,7 @@ export class NodesApiService { /** * Gets the items contained in a folder node. + * * @param nodeId ID of the target node * @param options Optional parameters supported by JS-API * @returns List of child items from the folder @@ -98,6 +100,7 @@ export class NodesApiService { /** * Creates a new document node inside a folder. + * * @param parentNodeId ID of the parent folder node * @param nodeBody Data for the new node * @param options Optional parameters supported by JS-API @@ -112,6 +115,7 @@ export class NodesApiService { /** * Creates a new folder node inside a parent folder. + * * @param parentNodeId ID of the parent folder node * @param nodeBody Data for the new folder * @param options Optional parameters supported by JS-API @@ -124,6 +128,7 @@ export class NodesApiService { /** * Updates the information about a node. + * * @param nodeId ID of the target node * @param nodeBody New data for the node * @param options Optional parameters supported by JS-API @@ -143,6 +148,7 @@ export class NodesApiService { /** * Moves a node to the trashcan. + * * @param nodeId ID of the target node * @param options Optional parameters supported by JS-API * @returns Empty result that notifies when the deletion is complete @@ -153,6 +159,7 @@ export class NodesApiService { /** * Restores a node previously moved to the trashcan. + * * @param nodeId ID of the node to restore * @returns Details of the restored node */ @@ -165,6 +172,7 @@ export class NodesApiService { /** * Get the metadata and the nodeType for a nodeId cleaned by the prefix. + * * @param nodeId ID of the target node * @returns Node metadata */ @@ -174,6 +182,7 @@ export class NodesApiService { /** * Gets the list of holds assigned to the node. + * * @param nodeId ID of the target node * @param options Optional parameters supported by JS-API * @param options.includeSource Also include **source** (in addition to **entries**) with folder information on **nodeId** @@ -200,6 +209,7 @@ export class NodesApiService { /** * Gets content for the given node. + * * @param nodeId ID of the target node * @returns Content data */ @@ -209,6 +219,7 @@ export class NodesApiService { /** * Create a new Node inside `-root-` folder + * * @param name Node name * @param nodeType Node type * @param properties Node body properties @@ -227,6 +238,7 @@ export class NodesApiService { /** * Create a new Node from form metadata. + * * @param nodeType Node type * @param nameSpace Namespace for properties * @param data Property data to store in the node under namespace diff --git a/lib/content-services/src/lib/common/services/people-content.service.ts b/lib/content-services/src/lib/common/services/people-content.service.ts index 3bd79958fb3..95a89294fc0 100644 --- a/lib/content-services/src/lib/common/services/people-content.service.ts +++ b/lib/content-services/src/lib/common/services/people-content.service.ts @@ -60,6 +60,7 @@ export class PeopleContentService { /** * Gets information about a user identified by their username. + * * @param personId ID of the target user * @returns User information */ @@ -73,6 +74,7 @@ export class PeopleContentService { /** * Gets information about the current user alias -me- + * * @returns User information */ getCurrentUserInfo(): Observable { @@ -84,6 +86,7 @@ export class PeopleContentService { /** * Used to know if the current user has the admin capability + * * @returns true or false */ isCurrentUserAdmin(): boolean { @@ -99,6 +102,7 @@ export class PeopleContentService { /** * Gets a list of people. + * * @param requestQuery maxItems and skipCount parameters supported by JS-API * @returns Response containing pagination and list of entries */ @@ -120,6 +124,7 @@ export class PeopleContentService { /** * Creates new person. + * * @param newPerson Object containing the new person details. * @param opts Optional parameters * @returns Created new person @@ -130,6 +135,7 @@ export class PeopleContentService { /** * Updates the person details + * * @param personId The identifier of a person * @param details The person details * @param opts Optional parameters @@ -141,6 +147,7 @@ export class PeopleContentService { /** * Returns a profile image as a URL. + * * @param avatarId Target avatar * @returns Image URL */ diff --git a/lib/content-services/src/lib/common/services/rendition.service.ts b/lib/content-services/src/lib/common/services/rendition.service.ts index 7de50ca0398..53465e5dc83 100644 --- a/lib/content-services/src/lib/common/services/rendition.service.ts +++ b/lib/content-services/src/lib/common/services/rendition.service.ts @@ -253,6 +253,7 @@ export class RenditionService { * This method takes a url to trigger the print dialog against, and the type of artifact that it * is. * This URL should be one that can be rendered in the browser, for example PDF, Image, or Text + * * @param url url to print * @param type type of the rendition */ @@ -277,6 +278,7 @@ export class RenditionService { * These are: images, PDF files, or PDF rendition of files. * We also force PDF rendition for TEXT type objects, otherwise the default URL is to download. * TODO there are different TEXT type objects, (HTML, plaintext, xml, etc. we should determine how these are handled) + * * @param objectId object it * @param mimeType mime type */ diff --git a/lib/content-services/src/lib/common/services/saved-searches.service.spec.ts b/lib/content-services/src/lib/common/services/saved-searches.service.spec.ts index 9eb2d40e0e8..7f46da31fa7 100644 --- a/lib/content-services/src/lib/common/services/saved-searches.service.spec.ts +++ b/lib/content-services/src/lib/common/services/saved-searches.service.spec.ts @@ -39,6 +39,7 @@ describe('SavedSearchesService', () => { /** * Creates a stub with Promise returning a Blob + * * @returns Promise with Blob */ function createBlob() { diff --git a/lib/content-services/src/lib/common/services/saved-searches.service.ts b/lib/content-services/src/lib/common/services/saved-searches.service.ts index 086d11a9f7d..d1f3b88b8ef 100644 --- a/lib/content-services/src/lib/common/services/saved-searches.service.ts +++ b/lib/content-services/src/lib/common/services/saved-searches.service.ts @@ -47,6 +47,7 @@ export class SavedSearchesService { /** * Gets a list of saved searches by user. + * * @returns SavedSearch list containing user saved searches */ getSavedSearches(): Observable { @@ -69,6 +70,7 @@ export class SavedSearchesService { /** * Saves a new search into state and updates state. If there are less than 5 searches, * it will be pushed on first place, if more it will be pushed to 6th place. + * * @param newSaveSearch object { name: string, description: string, encodedUrl: string } * @returns NodeEntry */ @@ -105,6 +107,7 @@ export class SavedSearchesService { /** * Replace Save Search with new one and also updates the state. + * * @param updatedSavedSearch - updated Save Search * @returns NodeEntry */ @@ -131,6 +134,7 @@ export class SavedSearchesService { /** * Deletes Save Search and update state. + * * @param deletedSavedSearch - Save Search to delete * @returns NodeEntry */ @@ -161,6 +165,7 @@ export class SavedSearchesService { /** * Reorders saved search place + * * @param previousIndex - previous index of saved search * @param currentIndex - new index of saved search */ diff --git a/lib/content-services/src/lib/common/services/sites.service.ts b/lib/content-services/src/lib/common/services/sites.service.ts index af61036474d..058e24c993b 100644 --- a/lib/content-services/src/lib/common/services/sites.service.ts +++ b/lib/content-services/src/lib/common/services/sites.service.ts @@ -47,6 +47,7 @@ export class SitesService { /** * Create a site + * * @param siteBody SiteBodyCreate to create site * @returns site SiteEntry */ @@ -56,6 +57,7 @@ export class SitesService { /** * Gets a list of all sites in the repository. + * * @param opts Options supported by JS-API * @returns List of sites */ @@ -70,6 +72,7 @@ export class SitesService { /** * Gets the details for a site. + * * @param siteId ID of the target site * @param opts Options supported by JS-API * @returns Information about the site @@ -80,6 +83,7 @@ export class SitesService { /** * Deletes a site. + * * @param siteId Site to delete * @param permanentFlag True: deletion is permanent; False: site is moved to the trash * @returns Null response notifying when the operation is complete @@ -92,6 +96,7 @@ export class SitesService { /** * Gets a site's content. + * * @param siteId ID of the target site * @returns Site content */ @@ -101,6 +106,7 @@ export class SitesService { /** * Gets a list of all a site's members. + * * @param siteId ID of the target site * @returns Site members */ @@ -110,6 +116,7 @@ export class SitesService { /** * Gets a list of all a site's members. + * * @param siteId ID of the target site * @param opts Optional parameters supported by JS-API * @returns Observable @@ -121,6 +128,7 @@ export class SitesService { /** * Looks for a site inside the path of a Node and returns its guid if it finds one. * (return an empty string if no site is found) + * * @param node Node to look for parent site * @returns Site guid */ @@ -135,6 +143,7 @@ export class SitesService { /** * Gets a list of site membership requests. + * * @param opts Options supported by JS-API * @returns Site membership requests */ @@ -144,6 +153,7 @@ export class SitesService { /** * Creates a site membership for person **personId** on site **siteId**. + * * @param siteId The identifier of a site * @param siteMembershipBodyCreate The person to add and their role * @param opts Optional parameters @@ -155,6 +165,7 @@ export class SitesService { /** * Update a site membership + * * @param siteId The identifier of a site. * @param personId The identifier of a person. * @param siteMembershipBodyUpdate The persons new role @@ -172,6 +183,7 @@ export class SitesService { /** * Delete a site membership + * * @param siteId The identifier of a site. * @param personId The identifier of a person. * @returns Null response notifying when the operation is complete @@ -182,6 +194,7 @@ export class SitesService { /** * Accept site membership requests. + * * @param siteId The identifier of a site. * @param inviteeId The invitee user name. * @param opts Options supported by JS-API @@ -193,6 +206,7 @@ export class SitesService { /** * Reject site membership requests. + * * @param siteId The identifier of a site. * @param inviteeId The invitee user name. * @param opts Options supported by JS-API @@ -204,6 +218,7 @@ export class SitesService { /** * List group membership for site + * * @param siteId The identifier of a site. * @param opts Options supported by JS-API * @returns Observable @@ -214,6 +229,7 @@ export class SitesService { /** * Create a site membership for group + * * @param siteId The identifier of a site. * @param siteMembershipBodyCreate The Group to add and its role * @returns Observable @@ -224,6 +240,7 @@ export class SitesService { /** * Get information about site membership of group + * * @param siteId The identifier of a site. * @param groupId The authorityId of a group. * @returns Observable @@ -234,6 +251,7 @@ export class SitesService { /** * Update site membership of group + * * @param siteId The identifier of a site. * @param groupId The authorityId of a group. * @param siteMembershipBodyUpdate The group new role @@ -245,6 +263,7 @@ export class SitesService { /** * Delete a group membership for site + * * @param siteId The identifier of a site. * @param groupId The authorityId of a group. * @returns Observable diff --git a/lib/content-services/src/lib/common/services/upload.service.ts b/lib/content-services/src/lib/common/services/upload.service.ts index b86cd2aeaac..600beac1026 100644 --- a/lib/content-services/src/lib/common/services/upload.service.ts +++ b/lib/content-services/src/lib/common/services/upload.service.ts @@ -90,6 +90,7 @@ export class UploadService { /** * Returns the number of concurrent threads for uploading. + * * @returns Number of concurrent threads (default 1) */ getThreadsCount(): number { @@ -98,6 +99,7 @@ export class UploadService { /** * Checks whether the service still has files uploading or awaiting upload. + * * @returns True if files in the queue are still uploading, false otherwise */ isUploading(): boolean { @@ -116,6 +118,7 @@ export class UploadService { /** * Gets the file Queue + * * @returns Array of files that form the queue */ getQueue(): FileModel[] { @@ -124,6 +127,7 @@ export class UploadService { /** * Adds files to the uploading queue to be uploaded + * * @param files One or more separate parameters or an array of files to queue * @returns Array of files that were not blocked from upload by the ignore list */ @@ -136,6 +140,7 @@ export class UploadService { /** * Finds all the files in the queue that are not yet uploaded and uploads them into the directory folder. + * * @param successEmitter Emitter to invoke on file success status change * @param errorEmitter Emitter to invoke on file error status change */ @@ -167,6 +172,7 @@ export class UploadService { * Cancels uploading of files. * If the file is smaller than 1 MB the file will be uploaded and then the node deleted * to prevent having files that were aborted but still uploaded. + * * @param files One or more separate parameters or an array of files specifying uploads to cancel */ cancelUpload(...files: FileModel[]) { @@ -200,6 +206,7 @@ export class UploadService { /** * Gets an upload promise for a file. + * * @param file The target file * @returns Promise that is resolved if the upload is successful or error otherwise */ diff --git a/lib/content-services/src/lib/content-metadata/components/content-metadata/content-metadata.component.spec.ts b/lib/content-services/src/lib/content-metadata/components/content-metadata/content-metadata.component.spec.ts index c44f19fd655..fe504f2257e 100644 --- a/lib/content-services/src/lib/content-metadata/components/content-metadata/content-metadata.component.spec.ts +++ b/lib/content-services/src/lib/content-metadata/components/content-metadata/content-metadata.component.spec.ts @@ -155,6 +155,7 @@ describe('ContentMetadataComponent', () => { /** * Get metadata categories + * * @returns list of native elements */ function getCategories(): HTMLParagraphElement[] { @@ -163,6 +164,7 @@ describe('ContentMetadataComponent', () => { /** * Get a categories management component + * * @returns angular component */ function getCategoriesManagementComponent(): CategoriesManagementComponent { diff --git a/lib/content-services/src/lib/content-metadata/components/content-metadata/content-metadata.component.ts b/lib/content-services/src/lib/content-metadata/components/content-metadata/content-metadata.component.ts index fe6625abfed..c3acb82a0b7 100644 --- a/lib/content-services/src/lib/content-metadata/components/content-metadata/content-metadata.component.ts +++ b/lib/content-services/src/lib/content-metadata/components/content-metadata/content-metadata.component.ts @@ -314,6 +314,7 @@ export class ContentMetadataComponent implements OnChanges, OnInit { /** * Register all tags which should be assigned to node. Please note that they are just in "register" state and are not yet saved * until button for saving data is clicked. Calling that function causes that save button is enabled. + * * @param tags array of tags to register, they are not saved yet until we click save button. */ storeTagsToAssign(tags: string[]) { @@ -325,6 +326,7 @@ export class ContentMetadataComponent implements OnChanges, OnInit { /** * Store all categories that node should be assigned to. Please note that they are just in "stored" state and are not yet saved * until button for saving data is clicked. Calling that function causes that save button is enabled. + * * @param categoriesToAssign array of categories to store. */ storeCategoriesToAssign(categoriesToAssign: Category[]) { diff --git a/lib/content-services/src/lib/content-node-selector/content-node-dialog.service.ts b/lib/content-services/src/lib/content-node-selector/content-node-dialog.service.ts index 76691e5865b..22bfe1758e6 100644 --- a/lib/content-services/src/lib/content-node-selector/content-node-dialog.service.ts +++ b/lib/content-services/src/lib/content-node-selector/content-node-dialog.service.ts @@ -54,6 +54,7 @@ export class ContentNodeDialogService { /** * Opens a file browser at a chosen folder location. * shows files and folders in the dialog search result. + * * @param folderNodeId ID of the folder to use * @returns Information about the selected file(s) */ @@ -65,6 +66,7 @@ export class ContentNodeDialogService { /** * Opens a lock node dialog. + * * @param contentEntry Node to lock * @returns Error/status message (if any) */ @@ -92,6 +94,7 @@ export class ContentNodeDialogService { /** * Opens a file browser at a chosen site location. * shows files and folders in the dialog search result. + * * @returns Information about the selected file(s) */ openFileBrowseDialogBySite(): Observable { @@ -103,6 +106,7 @@ export class ContentNodeDialogService { /** * Opens a file browser at a default myFile location. * shows files and folders in the dialog search result. + * * @returns Information about the selected file(s) */ openFileBrowseDialogByDefaultLocation(): Observable { @@ -111,6 +115,7 @@ export class ContentNodeDialogService { /** * Opens a folder browser at a chosen site location. + * * @returns Information about the selected folder(s) */ openFolderBrowseDialogBySite(): Observable { @@ -119,6 +124,7 @@ export class ContentNodeDialogService { /** * Opens a folder browser at a chosen folder location. + * * @param folderNodeId ID of the folder to use * @returns Information about the selected folder(s) */ @@ -130,6 +136,7 @@ export class ContentNodeDialogService { /** * Opens a dialog to copy or move an item to a new location. + * * @param action Name of the action (eg, "Copy" or "Move") to show in the title * @param contentEntry Item to be copied or moved * @param permission Permission for the operation @@ -164,6 +171,7 @@ export class ContentNodeDialogService { /** * Gets the translation of the dialog title. + * * @param action Name of the action to display in the dialog title * @param name Name of the item on which the action is being performed * @returns Translated version of the title @@ -174,6 +182,7 @@ export class ContentNodeDialogService { /** * Opens a dialog to choose folders to upload. + * * @param action Name of the action to show in the title * @param contentEntry Item to upload * @returns Information about the chosen folder(s) @@ -200,6 +209,7 @@ export class ContentNodeDialogService { /** * Opens a dialog to choose a file to upload. + * * @param action Name of the action to show in the title * @param contentEntry Item to upload * @param showFilesInResult Show files in dialog search result diff --git a/lib/content-services/src/lib/content-node-selector/content-node-selector-panel/content-node-selector-panel.component.ts b/lib/content-services/src/lib/content-node-selector/content-node-selector-panel/content-node-selector-panel.component.ts index 6d693dadbb3..c515c77b323 100644 --- a/lib/content-services/src/lib/content-node-selector/content-node-selector-panel/content-node-selector-panel.component.ts +++ b/lib/content-services/src/lib/content-node-selector/content-node-selector-panel/content-node-selector-panel.component.ts @@ -449,6 +449,7 @@ export class ContentNodeSelectorPanelComponent implements OnInit { /** * Updates the site attribute and starts a new search + * * @param chosenSite SiteEntry to search within */ siteChanged(chosenSite: SiteEntry): void { @@ -460,6 +461,7 @@ export class ContentNodeSelectorPanelComponent implements OnInit { /** * Get current breadcrumb folder node + * * @returns the actually selected|entered folder node or null in case of searching for the breadcrumb */ get breadcrumbFolderNode(): Node | null { @@ -476,6 +478,7 @@ export class ContentNodeSelectorPanelComponent implements OnInit { /** * Prepares the dialog for a new search + * * @param searchRequest request options */ prepareDialogForNewSearch(searchRequest: SearchRequest): void { @@ -548,6 +551,7 @@ export class ContentNodeSelectorPanelComponent implements OnInit { /** * Show the results of the search + * * @param results Search results */ private showSearchResults(results: NodePaging): void { @@ -560,6 +564,7 @@ export class ContentNodeSelectorPanelComponent implements OnInit { /** * Sets showingSearchResults state to be able to differentiate between search results or folder results + * * @param $event node event */ onFolderChange($event: NodeEntryEvent): void { @@ -574,6 +579,7 @@ export class ContentNodeSelectorPanelComponent implements OnInit { /** * Attempts to set the currently loaded node + * * @param nodePaging pagination model */ onFolderLoaded(nodePaging: NodePaging): void { @@ -589,6 +595,7 @@ export class ContentNodeSelectorPanelComponent implements OnInit { /** * Updates pagination.hasMoreItems to false after filtering only folders during 'COPY' and 'MOVE' action + * * @param nodePaging pagination model */ updatePaginationAfterRowFilter(nodePaging: NodePaging): void { @@ -599,6 +606,7 @@ export class ContentNodeSelectorPanelComponent implements OnInit { /** * Returns whether breadcrumb has to be shown or not + * * @returns `true` if needs to show the breadcrumb, otherwise `false` */ showBreadcrumbs() { @@ -607,6 +615,7 @@ export class ContentNodeSelectorPanelComponent implements OnInit { /** * Loads the next batch of search results + * * @param pagination Pagination object */ getNextPageOfSearch(pagination: Pagination): void { @@ -621,6 +630,7 @@ export class ContentNodeSelectorPanelComponent implements OnInit { /** * Selects node as chosen if it has the right permission, clears the selection otherwise + * * @param entry node entry */ private attemptNodeSelection(entry: Node): void { @@ -642,6 +652,7 @@ export class ContentNodeSelectorPanelComponent implements OnInit { /** * It filters and emit the selection coming from the document list + * * @param nodesEntries selected nodes */ onCurrentSelection(nodesEntries: NodeEntry[]): void { diff --git a/lib/content-services/src/lib/content-node-share/services/shared-links-api.service.ts b/lib/content-services/src/lib/content-node-share/services/shared-links-api.service.ts index 646bbf7124b..ed2089d771a 100644 --- a/lib/content-services/src/lib/content-node-share/services/shared-links-api.service.ts +++ b/lib/content-services/src/lib/content-node-share/services/shared-links-api.service.ts @@ -38,6 +38,7 @@ export class SharedLinksApiService { /** * Gets shared links available to the current user. + * * @param options Options supported by JS-API * @returns List of shared links */ @@ -55,6 +56,7 @@ export class SharedLinksApiService { /** * Creates a shared link available to the current user. + * * @param nodeId ID of the node to link to * @param sharedLinkWithExpirySettings shared link with nodeId and expiryDate * @param options Options supported by JS-API @@ -68,6 +70,7 @@ export class SharedLinksApiService { /** * Deletes a shared link. + * * @param sharedId ID of the link to delete * @returns Null response notifying when the operation is complete */ diff --git a/lib/content-services/src/lib/dialogs/download-zip/services/download-zip.service.ts b/lib/content-services/src/lib/dialogs/download-zip/services/download-zip.service.ts index c72821d0381..b5c8961e344 100755 --- a/lib/content-services/src/lib/dialogs/download-zip/services/download-zip.service.ts +++ b/lib/content-services/src/lib/dialogs/download-zip/services/download-zip.service.ts @@ -34,6 +34,7 @@ export class DownloadZipService { /** * Creates a new download. + * * @param payload Object containing the node IDs of the items to add to the ZIP file * @returns Status object for the download */ @@ -43,6 +44,7 @@ export class DownloadZipService { /** * Gets status information for a download node. + * * @param downloadId ID of the download node * @returns Status object for the download */ @@ -52,6 +54,7 @@ export class DownloadZipService { /** * Cancels a download. + * * @param downloadId ID of the target download node */ cancelDownload(downloadId: string) { diff --git a/lib/content-services/src/lib/directives/node-download.directive.ts b/lib/content-services/src/lib/directives/node-download.directive.ts index 33cdc1df166..e083e5d7151 100755 --- a/lib/content-services/src/lib/directives/node-download.directive.ts +++ b/lib/content-services/src/lib/directives/node-download.directive.ts @@ -55,6 +55,7 @@ export class NodeDownloadDirective { /** * Downloads multiple selected nodes. * Packs result into a .ZIP archive if there is more than one node selected. + * * @param selection Multiple selected nodes to download */ downloadNodes(selection: NodeEntry | Array) { @@ -75,6 +76,7 @@ export class NodeDownloadDirective { /** * Downloads a single node. * Packs result into a .ZIP archive is the node is a Folder. + * * @param node Node to download */ downloadNode(node: NodeEntry) { diff --git a/lib/content-services/src/lib/document-list/components/content-action/content-action-list.component.ts b/lib/content-services/src/lib/document-list/components/content-action/content-action-list.component.ts index ca27a742ef7..fd0f94fbf16 100644 --- a/lib/content-services/src/lib/document-list/components/content-action/content-action-list.component.ts +++ b/lib/content-services/src/lib/document-list/components/content-action/content-action-list.component.ts @@ -31,6 +31,7 @@ export class ContentActionListComponent { /** * Registers action handler within the parent document list component. + * * @param action Action model to register. * @returns `true` if actions was registered, otherwise `false` */ diff --git a/lib/content-services/src/lib/document-list/components/document-list.component.ts b/lib/content-services/src/lib/document-list/components/document-list.component.ts index cc759575de1..5a9708c5a76 100644 --- a/lib/content-services/src/lib/document-list/components/document-list.component.ts +++ b/lib/content-services/src/lib/document-list/components/document-list.component.ts @@ -744,6 +744,7 @@ export class DocumentListComponent extends DataTableSchema implements OnInit, On /** * Invoked when executing content action for a document or folder. + * * @param node Node to be the context of the execution. * @param action Action to be executed against the context. */ diff --git a/lib/content-services/src/lib/document-list/data/share-datatable-adapter.ts b/lib/content-services/src/lib/document-list/data/share-datatable-adapter.ts index 6ec752de6fc..5041055f23b 100644 --- a/lib/content-services/src/lib/document-list/data/share-datatable-adapter.ts +++ b/lib/content-services/src/lib/document-list/data/share-datatable-adapter.ts @@ -145,6 +145,7 @@ export class ShareDataTableAdapter implements DataTableAdapter { /** * Gets a thumbnail URL for the given document node. + * * @param node Node or Node ID to get URL for. * @param attachment Toggles whether to retrieve content as an attachment for download * @param ticket Custom ticket to use for authentication diff --git a/lib/content-services/src/lib/document-list/services/custom-resources.service.ts b/lib/content-services/src/lib/document-list/services/custom-resources.service.ts index 85580cec1b6..6f46e8e5daa 100644 --- a/lib/content-services/src/lib/document-list/services/custom-resources.service.ts +++ b/lib/content-services/src/lib/document-list/services/custom-resources.service.ts @@ -89,6 +89,7 @@ export class CustomResourcesService { /** * Gets files recently accessed by a user. + * * @param personId ID of the user * @param pagination Specifies how to paginate the results * @param filters Specifies additional filters to apply (joined with **AND**) @@ -175,6 +176,7 @@ export class CustomResourcesService { /** * Gets favorite files for the current user. + * * @param pagination Specifies how to paginate the results * @param includeFields List of data field names to include in the results * @param where A string to restrict the returned objects by using a predicate @@ -229,6 +231,7 @@ export class CustomResourcesService { /** * Gets sites that the current user is a member of. + * * @param pagination Specifies how to paginate the results * @param where A string to restrict the returned objects by using a predicate * @returns List of sites @@ -270,6 +273,7 @@ export class CustomResourcesService { /** * Gets all sites in the repository. + * * @param pagination Specifies how to paginate the results * @param where A string to restrict the returned objects by using a predicate * @returns List of sites @@ -302,6 +306,7 @@ export class CustomResourcesService { /** * Gets all items currently in the trash. + * * @param pagination Specifies how to paginate the results * @param includeFields List of data field names to include in the results * @returns List of deleted items @@ -320,6 +325,7 @@ export class CustomResourcesService { /** * Gets shared links for the current user. + * * @param pagination Specifies how to paginate the results * @param includeFields List of data field names to include in the results * @param where A string to restrict the returned objects by using a predicate @@ -340,6 +346,7 @@ export class CustomResourcesService { /** * Is the folder ID one of the well-known aliases? + * * @param folderId Folder ID name to check * @returns True if the ID is a well-known name, false otherwise */ @@ -356,6 +363,7 @@ export class CustomResourcesService { /** * Is the folder ID a "-my", "-root-", or "-shared-" alias? + * * @param folderId Folder ID name to check * @returns True if the ID is one of the supported sources, false otherwise */ @@ -372,6 +380,7 @@ export class CustomResourcesService { /** * Gets a folder's contents. + * * @param nodeId ID of the target folder node * @param pagination Specifies how to paginate the results * @param includeFields List of data field names to include in the results @@ -398,6 +407,7 @@ export class CustomResourcesService { /** * Gets the contents of one of the well-known aliases in the form of node ID strings. + * * @param nodeId ID of the target folder node * @param pagination Specifies how to paginate the results * @returns List of node IDs @@ -417,6 +427,7 @@ export class CustomResourcesService { /** * Chooses the correct ID for a node entry. + * * @param node Node object * @param nodeId ID of the node object * @returns ID value @@ -435,6 +446,7 @@ export class CustomResourcesService { /** * Does the well-known alias have a corresponding node ID? + * * @param nodeId Node to check * @returns True if the alias has a corresponding node ID, false otherwise */ diff --git a/lib/content-services/src/lib/document-list/services/document-actions.service.ts b/lib/content-services/src/lib/document-list/services/document-actions.service.ts index b502dfe334c..cf9d30a8194 100644 --- a/lib/content-services/src/lib/document-list/services/document-actions.service.ts +++ b/lib/content-services/src/lib/document-list/services/document-actions.service.ts @@ -48,6 +48,7 @@ export class DocumentActionsService { /** * Gets the handler for an action. + * * @param key Identifier of the action * @returns The handler for the action */ @@ -61,6 +62,7 @@ export class DocumentActionsService { /** * Sets a new handler for an action. + * * @param key Identifier of the action * @param handler Handler for the action * @returns False if the key was an empty/null string, true otherwise @@ -76,6 +78,7 @@ export class DocumentActionsService { /** * Checks if actions can be executed for an item. + * * @param nodeEntry Item to receive an action * @returns True if the action can be executed on this item, false otherwise */ diff --git a/lib/content-services/src/lib/document-list/services/document-list.service.ts b/lib/content-services/src/lib/document-list/services/document-list.service.ts index c7e40c7bd0e..ca6ea46f418 100644 --- a/lib/content-services/src/lib/document-list/services/document-list.service.ts +++ b/lib/content-services/src/lib/document-list/services/document-list.service.ts @@ -63,6 +63,7 @@ export class DocumentListService implements DocumentListLoader { /** * Deletes a node. + * * @param nodeId ID of the node to delete * @returns Empty response when the operation is complete */ @@ -72,6 +73,7 @@ export class DocumentListService implements DocumentListLoader { /** * Copy a node to destination node + * * @param nodeId The id of the node to be copied * @param targetParentId The id of the folder where the node will be copied * @returns NodeEntry for the copied node @@ -82,6 +84,7 @@ export class DocumentListService implements DocumentListLoader { /** * Moves a node to destination node. + * * @param nodeId The id of the node to be moved * @param targetParentId The id of the folder where the node will be moved * @returns NodeEntry for the moved node @@ -92,6 +95,7 @@ export class DocumentListService implements DocumentListLoader { /** * Gets the folder node with the specified relative name path below the root node. + * * @param folder Path to folder. * @param opts Options. * @param includeFields Extra information to include (available options are "aspectNames", "isLink" and "association") @@ -136,6 +140,7 @@ export class DocumentListService implements DocumentListLoader { /** * Gets a node via its node ID. + * * @param nodeId ID of the target node * @param includeFields Extra information to include (available options are "aspectNames", "isLink" and "association") * @returns Details of the folder @@ -155,6 +160,7 @@ export class DocumentListService implements DocumentListLoader { /** * Gets a folder node via its node ID. + * * @param nodeId ID of the folder node * @param includeFields Extra information to include (available options are "aspectNames", "isLink" and "association") * @returns Details of the folder @@ -178,6 +184,7 @@ export class DocumentListService implements DocumentListLoader { /** * Load a folder by Node Id. + * * @param nodeId ID of the folder node * @param pagination pagination model * @param includeFields List of data field names to include in the results diff --git a/lib/content-services/src/lib/document-list/services/folder-actions.service.ts b/lib/content-services/src/lib/document-list/services/folder-actions.service.ts index 65f48e88109..d488ded9760 100644 --- a/lib/content-services/src/lib/document-list/services/folder-actions.service.ts +++ b/lib/content-services/src/lib/document-list/services/folder-actions.service.ts @@ -46,6 +46,7 @@ export class FolderActionsService { /** * Gets the handler function for an action. + * * @param key Identifier for the action * @returns The handler function */ @@ -59,6 +60,7 @@ export class FolderActionsService { /** * Sets a new handler function for an action. + * * @param key Identifier for the action * @param handler The new handler function * @returns True if the key was a valid action identifier, false otherwise @@ -74,6 +76,7 @@ export class FolderActionsService { /** * Checks if an action is available for a particular item. + * * @param nodeEntry Item to check * @returns True if the action is available, false otherwise */ diff --git a/lib/content-services/src/lib/document-list/services/node-actions.service.ts b/lib/content-services/src/lib/document-list/services/node-actions.service.ts index f9261457be7..4e0ceb6b1f5 100644 --- a/lib/content-services/src/lib/document-list/services/node-actions.service.ts +++ b/lib/content-services/src/lib/document-list/services/node-actions.service.ts @@ -52,6 +52,7 @@ export class NodeActionsService { /** * Copy content node + * * @param contentEntry node to copy * @param permission permission which is needed to apply the action * @returns operation result @@ -62,6 +63,7 @@ export class NodeActionsService { /** * Copy folder node + * * @param contentEntry node to copy * @param permission permission which is needed to apply the action * @returns operation result @@ -72,6 +74,7 @@ export class NodeActionsService { /** * Move content node + * * @param contentEntry node to move * @param permission permission which is needed to apply the action * @returns operation result @@ -82,6 +85,7 @@ export class NodeActionsService { /** * Move folder node + * * @param contentEntry node to move * @param permission permission which is needed to apply the action * @returns operation result @@ -92,6 +96,7 @@ export class NodeActionsService { /** * General method for performing the given operation (copy|move) + * * @param action the action to perform (copy|move) * @param type type of the content (content|folder) * @param contentEntry the contentEntry which has to have the action performed on diff --git a/lib/content-services/src/lib/group/services/group.service.ts b/lib/content-services/src/lib/group/services/group.service.ts index d712943155a..00ca95e0fd6 100644 --- a/lib/content-services/src/lib/group/services/group.service.ts +++ b/lib/content-services/src/lib/group/services/group.service.ts @@ -53,6 +53,7 @@ export class GroupService { /** * Returns group for specified id. + * * @param id id of group to return. * @param opts additional query parameters * @returns Observable group for specified id. @@ -68,6 +69,7 @@ export class GroupService { /** * Updates specified group. + * * @param group group to update. * @param opts additional query parameters * @returns Observable updated group. diff --git a/lib/content-services/src/lib/legal-hold/services/legal-hold.service.ts b/lib/content-services/src/lib/legal-hold/services/legal-hold.service.ts index be7a92b3119..9b877a3485f 100644 --- a/lib/content-services/src/lib/legal-hold/services/legal-hold.service.ts +++ b/lib/content-services/src/lib/legal-hold/services/legal-hold.service.ts @@ -45,6 +45,7 @@ export class LegalHoldService { /** * Gets the list of holds available in the file plan. + * * @param filePlanId The identifier of a file plan. You can also use the -filePlan- alias. * @param options Optional parameters supported by JS-API * @returns List of holds Observable @@ -55,6 +56,7 @@ export class LegalHoldService { /** * Assign a node to a hold. + * * @param nodeId The Id of the node which will be assigned to a hold * @param holdId The Id of the hold to which nodes will be assigned * @returns Observable @@ -65,6 +67,7 @@ export class LegalHoldService { /** * Assign multiple nodes to a hold. + * * @param nodeIds The list of managed node Ids * @param holdId The Id of the hold to which nodes will be assigned * @returns Observable @@ -75,6 +78,7 @@ export class LegalHoldService { /** * Unassign the relationship between a child with id nodeId and a parent hold with id holdId. + * * @param holdId The hold Id * @param nodeId The Id of the node which is unassigned * @returns Empty response @@ -85,6 +89,7 @@ export class LegalHoldService { /** * Create hold. + * * @param filePlanId The identifier of a file plan. You can also use the -filePlan- alias. * @param hold Hold to create * @returns List of created holds Observable @@ -95,6 +100,7 @@ export class LegalHoldService { /** * Create list of holds. + * * @param filePlanId The identifier of a file plan. You can also use the -filePlan- alias. * @param holds Array of holds to create * @returns List of created holds Observable @@ -105,6 +111,7 @@ export class LegalHoldService { /** * Start the asynchronous bulk process for a hold with id holdId based on search query results. + * * @param holdId The identifier of a hold * @param query Search query * @returns Observable @@ -115,6 +122,7 @@ export class LegalHoldService { /** * Assign a folder to a hold. + * * @param holdId The identifier of a hold * @param folderId The identifier of a folder * @param language Language code @@ -131,6 +139,7 @@ export class LegalHoldService { /** * Get status of bulk operation with **bulkStatusId** for **holdId**. + * * @param bulkStatusId The identifier of a bulk status * @param holdId The identifier of a hold * @returns Promise diff --git a/lib/content-services/src/lib/new-version-uploader/new-version-uploader.service.ts b/lib/content-services/src/lib/new-version-uploader/new-version-uploader.service.ts index 454f50b0d7d..ba80d18eab7 100644 --- a/lib/content-services/src/lib/new-version-uploader/new-version-uploader.service.ts +++ b/lib/content-services/src/lib/new-version-uploader/new-version-uploader.service.ts @@ -42,6 +42,7 @@ export class NewVersionUploaderService { * - a side by side comparison between the current target node (type, name, icon) and the new file that should update it's version * - the new version's minor/major changes and the optional comment of a node and the ability to upload a new file version * - if data.showVersionsOnly is set to true, displays the version history of a node, with the ability to restore, delete and view version of the current node + * * @param data data to pass to MatDialog * @param config allow to override default MatDialogConfig * @param selectorAutoFocusedOnClose element's selector which should be autofocused after closing modal diff --git a/lib/content-services/src/lib/node-comments/services/node-comments.service.ts b/lib/content-services/src/lib/node-comments/services/node-comments.service.ts index 3fc0eae4820..f2c7ea956f3 100644 --- a/lib/content-services/src/lib/node-comments/services/node-comments.service.ts +++ b/lib/content-services/src/lib/node-comments/services/node-comments.service.ts @@ -37,6 +37,7 @@ export class NodeCommentsService implements CommentsService { /** * Gets all comments that have been added to a task. + * * @param id ID of the target task * @returns Details for each comment */ @@ -56,6 +57,7 @@ export class NodeCommentsService implements CommentsService { /** * Adds a comment to a task. + * * @param id ID of the target task * @param message Text for the comment * @returns Details about the comment diff --git a/lib/content-services/src/lib/permission-manager/services/node-permission-dialog.service.ts b/lib/content-services/src/lib/permission-manager/services/node-permission-dialog.service.ts index f1d2c2e074e..371a90096ea 100644 --- a/lib/content-services/src/lib/permission-manager/services/node-permission-dialog.service.ts +++ b/lib/content-services/src/lib/permission-manager/services/node-permission-dialog.service.ts @@ -35,6 +35,7 @@ export class NodePermissionDialogService { /** * Opens a dialog to add permissions to a node. + * * @param node target node * @param roles settable roles for the node * @param title Dialog title @@ -77,6 +78,7 @@ export class NodePermissionDialogService { /** * Opens a dialog to update permissions for a node. + * * @param nodeId ID of the target node * @param title Dialog title * @returns Node with updated permissions diff --git a/lib/content-services/src/lib/permission-manager/services/node-permission.service.ts b/lib/content-services/src/lib/permission-manager/services/node-permission.service.ts index 1e27a89fd99..4cf316bfa10 100644 --- a/lib/content-services/src/lib/permission-manager/services/node-permission.service.ts +++ b/lib/content-services/src/lib/permission-manager/services/node-permission.service.ts @@ -46,6 +46,7 @@ export class NodePermissionService { /** * Gets a list of roles for the current node. + * * @param node The target node * @returns Array of strings representing the roles */ @@ -65,6 +66,7 @@ export class NodePermissionService { /** * Get permissions for a given node + * * @param node Node to check permissions for * @returns list of permission models */ @@ -89,6 +91,7 @@ export class NodePermissionService { /** * Updates the permission role for a node. + * * @param node Target node * @param updatedPermissionRole Permission role to update or add * @returns Node with updated permission @@ -107,6 +110,7 @@ export class NodePermissionService { /** * Update permissions for a node. + * * @param nodeId ID of the target node * @param permissionList New permission settings * @returns Node with updated permissions @@ -117,6 +121,7 @@ export class NodePermissionService { /** * Updates the locally set permissions for a node. + * * @param node ID of the target node * @param permissions Permission settings * @returns Node with updated permissions @@ -159,6 +164,7 @@ export class NodePermissionService { /** * Removes a permission setting from a node. + * * @param node ID of the target node * @param permissionToRemove Permission setting to remove * @returns Node with modified permissions @@ -191,6 +197,7 @@ export class NodePermissionService { /** * Gets all members related to a group name. + * * @param groupName Name of group to look for members * @param opts Extra options supported by JS-API * @returns List of members @@ -251,6 +258,7 @@ export class NodePermissionService { /** * Removes permissions setting from a node. + * * @param node target node with permission * @param permissions Permissions to remove * @returns Node with modified permissions @@ -270,6 +278,7 @@ export class NodePermissionService { /** * updates permissions setting from a node. + * * @param node target node with permission * @param permissions Permissions to update * @returns Node with modified permissions @@ -282,6 +291,7 @@ export class NodePermissionService { /** * Gets all node detail for nodeId along with settable permissions. + * * @param nodeId Id of the node * @returns node and it's associated roles { node: Node; roles: RoleModel[] } */ diff --git a/lib/content-services/src/lib/prediction/services/prediction.service.ts b/lib/content-services/src/lib/prediction/services/prediction.service.ts index bc1e8323fec..e0011d78b28 100644 --- a/lib/content-services/src/lib/prediction/services/prediction.service.ts +++ b/lib/content-services/src/lib/prediction/services/prediction.service.ts @@ -33,6 +33,7 @@ export class PredictionService { /** * Get predictions for a given node + * * @param nodeId The identifier of node. * @returns Observable */ @@ -42,6 +43,7 @@ export class PredictionService { /** * Review a prediction + * * @param predictionId The identifier of prediction. * @param reviewStatus Review status to apply. * @returns Observable diff --git a/lib/content-services/src/lib/search-ai/services/search-ai.service.ts b/lib/content-services/src/lib/search-ai/services/search-ai.service.ts index 70d4841bb1b..5f6eb59fbc9 100644 --- a/lib/content-services/src/lib/search-ai/services/search-ai.service.ts +++ b/lib/content-services/src/lib/search-ai/services/search-ai.service.ts @@ -43,6 +43,7 @@ export class SearchAiService { /** * Update the state of the search AI input. + * * @param state The new state of the search AI input. */ updateSearchAiInputState(state: SearchAiInputState): void { @@ -51,6 +52,7 @@ export class SearchAiService { /** * Ask a question to the AI. + * * @param question The question to ask. * @returns QuestionModel object containing information about questions. */ @@ -60,6 +62,7 @@ export class SearchAiService { /** * Get an answer to specific question. + * * @param questionId The ID of the question to get an answer for. * @returns AiAnswerEntry object containing the answer. */ @@ -69,6 +72,7 @@ export class SearchAiService { /** * Get the knowledge retrieval configuration. + * * @returns KnowledgeRetrievalConfigEntry object containing the configuration. */ getConfig(): Observable { @@ -77,6 +81,7 @@ export class SearchAiService { /** * Check if using of search is possible (if all conditions are met). + * * @param selectedNodesState information about selected nodes. * @param maxSelectedNodes max number of selected nodes. Default 100. * @returns string with error if any condition is not met, empty string otherwise. diff --git a/lib/content-services/src/lib/search/components/search-chip-autocomplete-input/search-chip-autocomplete-input.component.spec.ts b/lib/content-services/src/lib/search/components/search-chip-autocomplete-input/search-chip-autocomplete-input.component.spec.ts index d5fae4994aa..32fedacd276 100644 --- a/lib/content-services/src/lib/search/components/search-chip-autocomplete-input/search-chip-autocomplete-input.component.spec.ts +++ b/lib/content-services/src/lib/search/components/search-chip-autocomplete-input/search-chip-autocomplete-input.component.spec.ts @@ -49,6 +49,7 @@ describe('SearchChipAutocompleteInputComponent', () => { /** * Get the input element + * * @returns native element */ function getInput(): HTMLInputElement { @@ -57,6 +58,7 @@ describe('SearchChipAutocompleteInputComponent', () => { /** * Enter the new input value + * * @param value value to input */ function enterNewInputValue(value: string) { @@ -69,6 +71,7 @@ describe('SearchChipAutocompleteInputComponent', () => { /** * Add new option + * * @param value value to input */ function addNewOption(value: string) { @@ -81,6 +84,7 @@ describe('SearchChipAutocompleteInputComponent', () => { /** * Get material chip list + * * @returns list of chips */ async function getChipList(): Promise { @@ -90,6 +94,7 @@ describe('SearchChipAutocompleteInputComponent', () => { /** * Get chip value by specific index + * * @param index index of the chip * @returns chip value */ @@ -100,6 +105,7 @@ describe('SearchChipAutocompleteInputComponent', () => { /** * Get material option elements + * * @returns list of debug elements */ async function getOptionElements(): Promise { @@ -109,6 +115,7 @@ describe('SearchChipAutocompleteInputComponent', () => { /** * Get added options for auto-complete + * * @returns list of debug elements */ function getAddedOptionElements(): DebugElement[] { diff --git a/lib/content-services/src/lib/search/components/search-chip-autocomplete-input/search-chip-autocomplete-input.component.ts b/lib/content-services/src/lib/search/components/search-chip-autocomplete-input/search-chip-autocomplete-input.component.ts index edd1de33500..16c5bd63554 100644 --- a/lib/content-services/src/lib/search/components/search-chip-autocomplete-input/search-chip-autocomplete-input.component.ts +++ b/lib/content-services/src/lib/search/components/search-chip-autocomplete-input/search-chip-autocomplete-input.component.ts @@ -168,6 +168,7 @@ export class SearchChipAutocompleteInputComponent implements OnInit, OnChanges { * This method checks if the provided `option` is present in the `selectedOptions` array. * If a custom comparison function (`compareOption`) is provided, it uses this function to determine equality. * Otherwise, it falls back to using strict equality comparison. + * * @param option - The option to check for selection. * @returns `true` if the option is selected, `false` otherwise. */ diff --git a/lib/content-services/src/lib/search/components/search-filter-autocomplete-chips/search-filter-autocomplete-chips.component.spec.ts b/lib/content-services/src/lib/search/components/search-filter-autocomplete-chips/search-filter-autocomplete-chips.component.spec.ts index 9b1ce6c3ee0..76cbf324d87 100644 --- a/lib/content-services/src/lib/search/components/search-filter-autocomplete-chips/search-filter-autocomplete-chips.component.spec.ts +++ b/lib/content-services/src/lib/search/components/search-filter-autocomplete-chips/search-filter-autocomplete-chips.component.spec.ts @@ -63,6 +63,7 @@ describe('SearchFilterAutocompleteChipsComponent', () => { /** * Add new auto-complete input + * * @param value value to add */ function addNewOption(value: string) { diff --git a/lib/content-services/src/lib/search/components/search-filter-chips/search-facet-chip-tabbed/search-facet-chip-tabbed.component.spec.ts b/lib/content-services/src/lib/search/components/search-filter-chips/search-facet-chip-tabbed/search-facet-chip-tabbed.component.spec.ts index b688fcde414..2563f8ff127 100644 --- a/lib/content-services/src/lib/search/components/search-filter-chips/search-facet-chip-tabbed/search-facet-chip-tabbed.component.spec.ts +++ b/lib/content-services/src/lib/search/components/search-filter-chips/search-facet-chip-tabbed/search-facet-chip-tabbed.component.spec.ts @@ -57,6 +57,7 @@ describe('SearchFacetChipTabbedComponent', () => { /** * Get the filter display value + * * @returns filter value */ function getDisplayValue(): string { @@ -65,6 +66,7 @@ describe('SearchFacetChipTabbedComponent', () => { /** * Emit the event for the tabbed content + * * @param eventName event name to trigger * @param event event to trigger */ diff --git a/lib/content-services/src/lib/search/components/search-filter-chips/search-facet-chip-tabbed/search-facet-tabbed-content.component.spec.ts b/lib/content-services/src/lib/search/components/search-filter-chips/search-facet-chip-tabbed/search-facet-tabbed-content.component.spec.ts index 5622d13fb2b..0997cd86f26 100644 --- a/lib/content-services/src/lib/search/components/search-filter-chips/search-facet-chip-tabbed/search-facet-tabbed-content.component.spec.ts +++ b/lib/content-services/src/lib/search/components/search-filter-chips/search-facet-chip-tabbed/search-facet-tabbed-content.component.spec.ts @@ -64,6 +64,7 @@ describe('SearchFacetTabbedContentComponent', () => { /** * Get the tab label content + * * @returns list of native elements */ async function getTabs(): Promise { @@ -84,6 +85,7 @@ describe('SearchFacetTabbedContentComponent', () => { /** * Add new item to the bucket + * * @param field field name * @param displayValue value to display */ diff --git a/lib/content-services/src/lib/search/components/search-input/search-input.component.spec.ts b/lib/content-services/src/lib/search/components/search-input/search-input.component.spec.ts index 3c1bc080a1c..d5c6c2d72df 100644 --- a/lib/content-services/src/lib/search/components/search-input/search-input.component.spec.ts +++ b/lib/content-services/src/lib/search/components/search-input/search-input.component.spec.ts @@ -31,6 +31,7 @@ describe('SearchInputComponent', () => { /** * Sets the search input value + * * @param value the value to set */ async function setInputValue(value: string) { diff --git a/lib/content-services/src/lib/search/components/search-logical-filter/search-logical-filter.component.spec.ts b/lib/content-services/src/lib/search/components/search-logical-filter/search-logical-filter.component.spec.ts index 2243e486d88..9c03587f9c7 100644 --- a/lib/content-services/src/lib/search/components/search-logical-filter/search-logical-filter.component.spec.ts +++ b/lib/content-services/src/lib/search/components/search-logical-filter/search-logical-filter.component.spec.ts @@ -47,6 +47,7 @@ describe('SearchLogicalFilterComponent', () => { /** * Get search input elements + * * @returns list of native elements */ function getInputs(): HTMLInputElement[] { @@ -55,6 +56,7 @@ describe('SearchLogicalFilterComponent', () => { /** * Get input label elements + * * @returns list of labels */ function getInputsLabels(): string[] { @@ -63,6 +65,7 @@ describe('SearchLogicalFilterComponent', () => { /** * Enters a new phrase + * * @param value new value * @param index value index */ diff --git a/lib/content-services/src/lib/search/models/search-filter-list.model.ts b/lib/content-services/src/lib/search/models/search-filter-list.model.ts index 977a9bfe125..d06e411f926 100644 --- a/lib/content-services/src/lib/search/models/search-filter-list.model.ts +++ b/lib/content-services/src/lib/search/models/search-filter-list.model.ts @@ -56,6 +56,7 @@ export class SearchFilterList implements Iterable { /** * Returns visible portion of the items. + * * @returns list of items */ get visibleItems(): T[] { @@ -64,6 +65,7 @@ export class SearchFilterList implements Iterable { /** * Get items length + * * @returns entire collection length including items not displayed on the page */ get length(): number { @@ -72,6 +74,7 @@ export class SearchFilterList implements Iterable { /** * Detect whether more items can be displayed. + * * @returns `true` if can show more items, otherwise `false` */ get canShowMoreItems(): boolean { @@ -80,6 +83,7 @@ export class SearchFilterList implements Iterable { /** * Detect whether less items can be displayed. + * * @returns `true` if can show less items, otherwise `false` */ get canShowLessItems(): boolean { @@ -88,6 +92,7 @@ export class SearchFilterList implements Iterable { /** * Detect whether content fits single page. + * * @returns `true` if content fits single page, otherwise `false`. */ get fitsPage(): boolean { diff --git a/lib/content-services/src/lib/search/services/base-query-builder.service.ts b/lib/content-services/src/lib/search/services/base-query-builder.service.ts index f6e56573567..7449118f4ee 100644 --- a/lib/content-services/src/lib/search/services/base-query-builder.service.ts +++ b/lib/content-services/src/lib/search/services/base-query-builder.service.ts @@ -202,6 +202,7 @@ export abstract class BaseQueryBuilderService { /** * Adds a facet bucket to a field. + * * @param field The target field * @param bucket Bucket to add */ @@ -218,6 +219,7 @@ export abstract class BaseQueryBuilderService { /** * Gets the buckets currently added to a field + * * @param field The target fields * @returns Bucket array */ @@ -227,6 +229,7 @@ export abstract class BaseQueryBuilderService { /** * Removes an existing bucket from a field. + * * @param field The target field * @param bucket Bucket to remove */ @@ -239,6 +242,7 @@ export abstract class BaseQueryBuilderService { /** * Adds a filter query to the current query. + * * @param query Query string to add */ addFilterQuery(query: string): void { @@ -253,6 +257,7 @@ export abstract class BaseQueryBuilderService { /** * Removes an existing filter query. + * * @param query The query to remove */ removeFilterQuery(query: string): void { @@ -264,6 +269,7 @@ export abstract class BaseQueryBuilderService { /** * Gets a facet query by label. + * * @param label Label of the query * @returns Facet query data */ @@ -279,6 +285,7 @@ export abstract class BaseQueryBuilderService { /** * Gets a facet field by label. + * * @param label Label of the facet field * @returns Facet field data */ @@ -304,6 +311,7 @@ export abstract class BaseQueryBuilderService { /** * Builds the current query and triggers the `updated` event. + * * @param queryBody query settings */ update(queryBody?: SearchRequest): void { @@ -313,6 +321,7 @@ export abstract class BaseQueryBuilderService { /** * Builds and executes the current query. + * * @param updateQueryParams whether query params should be updated with encoded query * @param queryBody query settings */ @@ -352,6 +361,7 @@ export abstract class BaseQueryBuilderService { /** * Builds the current query. + * * @returns The finished query */ buildQuery(): SearchRequest { @@ -392,6 +402,7 @@ export abstract class BaseQueryBuilderService { /** * Gets the primary sorting definition. + * * @returns The primary sorting definition */ getPrimarySorting(): SearchSortingDefinition { @@ -403,6 +414,7 @@ export abstract class BaseQueryBuilderService { /** * Gets all pre-configured sorting options that users can choose from. + * * @returns Pre-configured sorting options */ getSortingOptions(): SearchSortingDefinition[] { @@ -411,6 +423,7 @@ export abstract class BaseQueryBuilderService { /** * Gets the query group. + * * @param query Target query * @returns Query group */ @@ -420,6 +433,7 @@ export abstract class BaseQueryBuilderService { /** * Checks if FacetQueries has been defined + * * @returns True if defined, false otherwise */ get hasFacetQueries(): boolean { @@ -428,6 +442,7 @@ export abstract class BaseQueryBuilderService { /** * Checks if FacetIntervals has been defined + * * @returns True if defined, false otherwise */ get hasFacetIntervals(): boolean { @@ -548,6 +563,7 @@ export abstract class BaseQueryBuilderService { /** * Encloses a label name with double quotes if it contains whitespace characters. + * * @param configLabel Original label text * @returns Label, possibly with quotes if it contains spaces */ @@ -580,6 +596,7 @@ export abstract class BaseQueryBuilderService { /** * Builds search query with provided user query, executes query, encodes latest filter config and navigates to search. + * * @param query user query to search for * @param searchUrl search url to navigate to */ diff --git a/lib/content-services/src/lib/search/services/search-configuration.service.ts b/lib/content-services/src/lib/search/services/search-configuration.service.ts index cc471e0fdcd..8fb408e65a1 100644 --- a/lib/content-services/src/lib/search/services/search-configuration.service.ts +++ b/lib/content-services/src/lib/search/services/search-configuration.service.ts @@ -25,6 +25,7 @@ import { SearchConfigurationInterface } from '../../common/interfaces/search-con export class SearchConfigurationService implements SearchConfigurationInterface { /** * Generates a request object with custom search parameters. + * * @param searchTerm Term text to search for * @param maxResults Maximum number of search results to show in a page * @param skipCount The offset of the start of the page within the results list diff --git a/lib/content-services/src/lib/search/services/search.service.ts b/lib/content-services/src/lib/search/services/search.service.ts index 641e02626c0..bef7eb0faad 100644 --- a/lib/content-services/src/lib/search/services/search.service.ts +++ b/lib/content-services/src/lib/search/services/search.service.ts @@ -44,6 +44,7 @@ export class SearchService { /** * Gets a list of nodes that match the given search criteria. + * * @param term Term to search for * @param options Options for delivery of the search results * @returns List of nodes resulting from the search @@ -60,6 +61,7 @@ export class SearchService { /** * Performs a search. + * * @param searchTerm Term to search for * @param maxResults Maximum number of items in the list of results * @param skipCount Number of higher-ranked items to skip over in the list @@ -78,6 +80,7 @@ export class SearchService { /** * Performs a search with its parameters supplied by a request object. + * * @param queryBody Object containing the search parameters * @returns List of search results */ diff --git a/lib/content-services/src/lib/security/services/security-controls-groups-marks-security.service.ts b/lib/content-services/src/lib/security/services/security-controls-groups-marks-security.service.ts index ddac7f58715..deaf4d6419a 100644 --- a/lib/content-services/src/lib/security/services/security-controls-groups-marks-security.service.ts +++ b/lib/content-services/src/lib/security/services/security-controls-groups-marks-security.service.ts @@ -79,6 +79,7 @@ export class SecurityControlsService { /** * Get All security groups + * * @param skipCount The number of entities that exist in the collection before those included in this list. * @param maxItems The maximum number of items to return in the list. Default is specified by UserPreferencesService. * @param include Additional information about the security group @@ -112,6 +113,7 @@ export class SecurityControlsService { /** * Create security group + * * @param input securityGroupBody. * @returns Observable */ @@ -130,6 +132,7 @@ export class SecurityControlsService { /** * Create security marks + * * @param securityGroupId The key for the security group id. * @param input securityMarkBody[]. * @returns Promise @@ -153,6 +156,7 @@ export class SecurityControlsService { /** * Get security mark value * Gets the value for a selected **securityGroupId**. + * * @param securityGroupId The key for the security group id. * @param skipCount The number of entities that exist in the collection before those included in this list. * @returns Promise @@ -179,6 +183,7 @@ export class SecurityControlsService { /** * Update a security groups information + * * @param securityGroupId The Key of Security Group id for which info is required * @param input SecurityGroupBody * @param opts additional information about the security group @@ -210,6 +215,7 @@ export class SecurityControlsService { /** * Updates Security Mark value + * * @param securityGroupId The key for the security group id. * @param securityMarkId The key for the security mark is in use or not. * @param input securityMarkBody. @@ -236,6 +242,7 @@ export class SecurityControlsService { /** * Delete security group + * * @param securityGroupId The key for the security group id. * @returns Observable */ @@ -248,6 +255,7 @@ export class SecurityControlsService { /** * Delete security mark + * * @param securityGroupId The key for the security group id. * @param securityMarkId The key for the security mark id. * @returns Promise @@ -270,6 +278,7 @@ export class SecurityControlsService { /** * Get the authority clearances for a single user/group + * * @param authorityName The name for the authority for which the clearance is to be fetched. Can be left blank in which case it will fetch it for all users with pagination * @param skipCount The number of entities that exist in the collection before those included in this list. * @param maxItems The maximum number of items to return in the list. Default is specified by UserPreferencesService. @@ -292,6 +301,7 @@ export class SecurityControlsService { /** * Updates the authority clearance. + * * @param authorityName The name for the authority for which the clearance is to be updated * @param securityMarksList NodeSecurityMarkBody[] * @returns Observable diff --git a/lib/content-services/src/lib/tag/services/tag.service.ts b/lib/content-services/src/lib/tag/services/tag.service.ts index 450bd71b877..7216dc9cf3f 100644 --- a/lib/content-services/src/lib/tag/services/tag.service.ts +++ b/lib/content-services/src/lib/tag/services/tag.service.ts @@ -44,6 +44,7 @@ export class TagService { /** * Gets a list of tags added to a node. + * * @param nodeId ID of the target node * @returns TagPaging object (defined in JS-API) containing the tags */ @@ -53,6 +54,7 @@ export class TagService { /** * Gets a list of all the tags already defined in the repository. + * * @param opts Options supported by JS-API * @param includedCounts True if count field should be included in response object for each tag, false otherwise. * @returns TagPaging object (defined in JS-API) containing the tags @@ -68,6 +70,7 @@ export class TagService { /** * Adds a tag to a node. + * * @param nodeId ID of the target node * @param tagName Name of the tag to add * @returns TagEntry object (defined in JS-API) with details of the new tag @@ -81,6 +84,7 @@ export class TagService { /** * Removes a tag from a node. + * * @param nodeId ID of the target node * @param tag Name of the tag to remove * @returns Null object when the operation completes @@ -91,6 +95,7 @@ export class TagService { /** * Creates tags. + * * @param tags list of tags to create. * @returns Created tags. */ @@ -100,6 +105,7 @@ export class TagService { /** * Update a tag + * * @param tagId The identifier of a tag. * @param tagBody The updated tag. * @returns Updated tag. @@ -110,6 +116,7 @@ export class TagService { /** * Find tags which name contains searched name. + * * @param name Value for name which should be used during searching tags. * @param sorting Object which configures sorting. OrderBy field specifies field used for sorting, direction specified ascending or descending direction. * Default sorting is ascending by tag field. @@ -140,6 +147,7 @@ export class TagService { /** * Find tag which name matches exactly to passed name. + * * @param name Value for name which should be used during finding exact tag. * @returns Found tag which name matches exactly to passed name. */ @@ -151,6 +159,7 @@ export class TagService { * Deletes a tag with tagId. * This will cause the tag to be removed from all nodes. * You must have admin rights to delete a tag. + * * @param tagId of the tag to be deleted * @returns Null object when the operation completes */ @@ -160,6 +169,7 @@ export class TagService { /** * Assign tags to node. If tag is new then tag is also created additionally, if tag already exists then it is just assigned. + * * @param nodeId Id of node to which tags should be assigned. * @param tags List of tags to create and assign or just assign if they already exist. * @returns Just linked tags to node or single tag if linked only one tag. @@ -170,6 +180,7 @@ export class TagService { /** * Checks if tags plugin is enabled. + * * @returns boolean true if tags plugin is enabled, false otherwise. */ areTagsEnabled(): boolean { diff --git a/lib/content-services/src/lib/tag/tags-creator/tags-creator.component.spec.ts b/lib/content-services/src/lib/tag/tags-creator/tags-creator.component.spec.ts index 86140986be3..2707aa196c6 100644 --- a/lib/content-services/src/lib/tag/tags-creator/tags-creator.component.spec.ts +++ b/lib/content-services/src/lib/tag/tags-creator/tags-creator.component.spec.ts @@ -72,6 +72,7 @@ describe('TagsCreatorComponent', () => { /** * Get name input element + * * @returns native element */ function getNameInput(): HTMLInputElement { @@ -80,6 +81,7 @@ describe('TagsCreatorComponent', () => { /** * Get the create tag label + * * @returns native element */ function getCreateTagLabel(): HTMLSpanElement { @@ -88,6 +90,7 @@ describe('TagsCreatorComponent', () => { /** * Get remove tag buttons + * * @returns list of native elements */ function getRemoveTagButtons(): HTMLButtonElement[] { @@ -97,6 +100,7 @@ describe('TagsCreatorComponent', () => { /** * Get newly added tags + * * @returns list of tags */ async function getAddedTags(): Promise { @@ -110,6 +114,7 @@ describe('TagsCreatorComponent', () => { /** * Adds tag to the added list + * * @param tagName tag name * @param addUsingEnter use Enter when adding * @param typingTimeout typing timeout in milliseconds (default 300) @@ -129,6 +134,7 @@ describe('TagsCreatorComponent', () => { /** * type a new tag + * * @param tagName tag name * @param timeout typing timeout in milliseconds (default 300) */ @@ -146,6 +152,7 @@ describe('TagsCreatorComponent', () => { /** * Get the existing tags label + * * @returns label */ function getExistingTagsLabel(): string { @@ -306,6 +313,7 @@ describe('TagsCreatorComponent', () => { describe('Errors', () => { /** * Get first error + * * @returns error text */ function getFirstError(): string { @@ -420,6 +428,7 @@ describe('TagsCreatorComponent', () => { describe('Existing tags panel', () => { /** * Get the existing tags panel + * * @returns debug element */ function getPanel(): DebugElement { @@ -509,6 +518,7 @@ describe('TagsCreatorComponent', () => { describe('Existing tags', () => { /** * Get the existing tags + * * @returns list of tags */ function getExistingTags(): string[] { @@ -702,6 +712,7 @@ describe('TagsCreatorComponent', () => { describe('Spinner', () => { /** * Get the material progress spinner + * * @returns debug element */ async function getSpinner(): Promise { diff --git a/lib/content-services/src/lib/tag/tags-creator/tags-creator.component.ts b/lib/content-services/src/lib/tag/tags-creator/tags-creator.component.ts index fe0d78801ed..63b0b8180c5 100644 --- a/lib/content-services/src/lib/tag/tags-creator/tags-creator.component.ts +++ b/lib/content-services/src/lib/tag/tags-creator/tags-creator.component.ts @@ -99,6 +99,7 @@ export class TagsCreatorComponent implements OnInit, OnDestroy { /** * Default top list. + * * @param tags tags which should be displayed as default tags for top list. */ @Input() @@ -117,6 +118,7 @@ export class TagsCreatorComponent implements OnInit, OnDestroy { /** * Decides if input for tags creation/searching should be visible. When input is hidden then panel of existing tags is hidden as well. + * * @param tagNameControlVisible true if input should be visible, false otherwise. */ @Input() @@ -280,6 +282,7 @@ export class TagsCreatorComponent implements OnInit, OnDestroy { /** * Remove tag from top list. In case that tag was part of search result then that tag is moved to bottom list * (list of existing tags) after removing so user can reselect it again later. + * * @param tag tag's name which should be removed from top list. */ removeTag(tag: string): void { @@ -294,6 +297,7 @@ export class TagsCreatorComponent implements OnInit, OnDestroy { /** * Called when user selects any tag from list of existing tags. It moves tag from existing tags list to top list. + * * @param selectedTag changes */ addExistingTagToTagsToAssign(selectedTag: TagEntry): void { @@ -309,6 +313,7 @@ export class TagsCreatorComponent implements OnInit, OnDestroy { /** * Checks if component is in Create mode. + * * @returns `true` if `Create` mode, `false` otherwise. */ isOnlyCreateMode(): boolean { diff --git a/lib/content-services/src/lib/tree/components/tree.component.ts b/lib/content-services/src/lib/tree/components/tree.component.ts index e0813817418..f220447f32a 100644 --- a/lib/content-services/src/lib/tree/components/tree.component.ts +++ b/lib/content-services/src/lib/tree/components/tree.component.ts @@ -169,6 +169,7 @@ export class TreeComponent implements OnInit, OnDestroy { /** * Checks if node is LoadMoreNode node + * * @param _idx (unused) * @param node node to be checked * @returns `true` if there are more items to load, otherwise `false` @@ -179,6 +180,7 @@ export class TreeComponent implements OnInit, OnDestroy { /** * Checks if tree is empty + * * @returns boolean */ public isEmpty(): boolean { @@ -187,6 +189,7 @@ export class TreeComponent implements OnInit, OnDestroy { /** * Returns action icon based on expanded/collapsed node state. + * * @param node node to be checked * @returns collapse or expand icon */ @@ -196,6 +199,7 @@ export class TreeComponent implements OnInit, OnDestroy { /** * Refreshes the tree, root nodes are reloaded, tree selection is cleared. + * * @param skipCount Number of root nodes to skip. * @param maxItems Maximum number of nodes returned from Observable. * @param searchTerm Specifies if categories should be filtered out by name or not. If not specified then returns categories without filtering. @@ -213,6 +217,7 @@ export class TreeComponent implements OnInit, OnDestroy { /** * Collapses or expanding the node based on its current state + * * @param node node to be collapsed/expanded */ public expandCollapseNode(node: T): void { @@ -237,6 +242,7 @@ export class TreeComponent implements OnInit, OnDestroy { /** * Loads more subnode for a given parent node + * * @param node parent node */ public loadMoreSubnodes(node: T): void { @@ -260,6 +266,7 @@ export class TreeComponent implements OnInit, OnDestroy { /** * When node is selected it selects all its descendants + * * @param node selected node */ public onNodeSelected(node: T): void { @@ -275,6 +282,7 @@ export class TreeComponent implements OnInit, OnDestroy { /** * Checks if all descendants of a node are selected + * * @param node selected node * @returns boolean */ @@ -285,6 +293,7 @@ export class TreeComponent implements OnInit, OnDestroy { /** * Checks if some descendants of a node are selected + * * @param node selected node * @returns boolean */ diff --git a/lib/content-services/src/lib/tree/services/tree.service.ts b/lib/content-services/src/lib/tree/services/tree.service.ts index a6f64f942b5..026b2f9e9b4 100644 --- a/lib/content-services/src/lib/tree/services/tree.service.ts +++ b/lib/content-services/src/lib/tree/services/tree.service.ts @@ -49,6 +49,7 @@ export abstract class TreeService extends DataSource { /** * Expands node applying subnodes to it. + * * @param nodeToExpand Node to be expanded * @param subNodes List of nodes that will be added as children of expanded node */ @@ -64,6 +65,7 @@ export abstract class TreeService extends DataSource { /** * Collapses a node removing all children from it. + * * @param nodeToCollapse Node to be collapsed */ public collapseNode(nodeToCollapse: T): void { @@ -79,6 +81,7 @@ export abstract class TreeService extends DataSource { /** * Append more child nodes to already expanded parent node + * * @param nodeToAppend Expanded parent node * @param subNodes List of nodes that will be added as children of expanded node */ @@ -95,6 +98,7 @@ export abstract class TreeService extends DataSource { /** * Removes provided node from the tree + * * @param node Node to be removed */ public removeNode(node: T): void { @@ -103,6 +107,7 @@ export abstract class TreeService extends DataSource { /** * Gets children of the node + * * @param parentNode Parent node * @returns children of parent node */ @@ -112,6 +117,7 @@ export abstract class TreeService extends DataSource { /** * Checks if tree is empty + * * @returns boolean */ public isEmpty(): boolean { @@ -120,6 +126,7 @@ export abstract class TreeService extends DataSource { /** * Gets parent node of given node. If node with parentNodeId is not found it returns undefined. + * * @param parentNodeId Id of a parent node to be found * @returns parent node or undefined when not found */ diff --git a/lib/content-services/src/lib/upload/components/file-uploading-list.component.ts b/lib/content-services/src/lib/upload/components/file-uploading-list.component.ts index a82daa11bcb..e34a14df09d 100644 --- a/lib/content-services/src/lib/upload/components/file-uploading-list.component.ts +++ b/lib/content-services/src/lib/upload/components/file-uploading-list.component.ts @@ -44,6 +44,7 @@ export class FileUploadingListComponent { /** * Cancel file upload + * * @param file File model to cancel upload for. */ cancelFile(file: FileModel): void { @@ -56,6 +57,7 @@ export class FileUploadingListComponent { /** * Remove uploaded file + * * @param file File model to remove upload for. */ removeFile(file: FileModel): void { @@ -84,6 +86,7 @@ export class FileUploadingListComponent { /** * Checks if all the files are uploaded false if there is at least one file in Progress | Starting | Pending + * * @returns `true` if upload is complete, otherwise `false` */ isUploadCompleted(): boolean { @@ -98,6 +101,7 @@ export class FileUploadingListComponent { /** * Check if all the files are Cancelled | Aborted | Error. false if there is at least one file in uploading states + * * @returns `true` if upload is cancelled, otherwise `false` */ isUploadCancelled(): boolean { diff --git a/lib/content-services/src/lib/upload/components/upload-drag-area.component.ts b/lib/content-services/src/lib/upload/components/upload-drag-area.component.ts index a68c9d4952e..f867157b4d0 100644 --- a/lib/content-services/src/lib/upload/components/upload-drag-area.component.ts +++ b/lib/content-services/src/lib/upload/components/upload-drag-area.component.ts @@ -41,6 +41,7 @@ export class UploadDragAreaComponent extends UploadBase implements NodeAllowable /** * Method called when files are dropped in the drag area. + * * @param files - files dropped in the drag area. */ onFilesDropped(files: File[]): void { @@ -51,6 +52,7 @@ export class UploadDragAreaComponent extends UploadBase implements NodeAllowable /** * Called when a folder are dropped in the drag area + * * @param folder - name of the dropped folder */ onFolderEntityDropped(folder: any): void { @@ -63,6 +65,7 @@ export class UploadDragAreaComponent extends UploadBase implements NodeAllowable /** * Show undo notification bar. + * * @param latestFilesAdded - files in the upload queue enriched with status flag and xhr object. */ showUndoNotificationBar(latestFilesAdded: FileModel[]) { @@ -79,6 +82,7 @@ export class UploadDragAreaComponent extends UploadBase implements NodeAllowable /** * Check if content is droppable + * * @returns `true` or `false` considering the component options and node permissions */ isDroppable(): boolean { @@ -87,6 +91,7 @@ export class UploadDragAreaComponent extends UploadBase implements NodeAllowable /** * Handles 'upload-files' events raised by child components. + * * @param event DOM event */ onUploadFiles(event: CustomEvent) { diff --git a/lib/content-services/src/lib/upload/directives/file-draggable.directive.ts b/lib/content-services/src/lib/upload/directives/file-draggable.directive.ts index 4c6ed02980a..18b222c01f6 100644 --- a/lib/content-services/src/lib/upload/directives/file-draggable.directive.ts +++ b/lib/content-services/src/lib/upload/directives/file-draggable.directive.ts @@ -66,6 +66,7 @@ export class FileDraggableDirective implements OnInit, OnDestroy { /** * Method called when files is dropped in the drag and drop area. + * * @param event DOM event. */ onDropFiles(event: any): void { @@ -110,6 +111,7 @@ export class FileDraggableDirective implements OnInit, OnDestroy { /** * Change the style of the drag area when a file drag in. + * * @param event - DOM event. */ onDragEnter(event: DragEvent): void { @@ -126,6 +128,7 @@ export class FileDraggableDirective implements OnInit, OnDestroy { /** * Change the style of the drag area when a file drag out. + * * @param event - DOM event. */ onDragLeave(event: Event): void { @@ -137,6 +140,7 @@ export class FileDraggableDirective implements OnInit, OnDestroy { /** * Change the style of the drag area when a file is over the drag area. + * * @param event drag event */ onDragOver(event: DragEvent): void { @@ -153,6 +157,7 @@ export class FileDraggableDirective implements OnInit, OnDestroy { /** * Prevent default and stop propagation of the DOM event. + * * @param event DOM event */ preventDefault(event: Event): void { diff --git a/lib/content-services/src/lib/version-compatibility/version-compatibility-factory.ts b/lib/content-services/src/lib/version-compatibility/version-compatibility-factory.ts index 1750b5a074c..ddfe20f11e3 100644 --- a/lib/content-services/src/lib/version-compatibility/version-compatibility-factory.ts +++ b/lib/content-services/src/lib/version-compatibility/version-compatibility-factory.ts @@ -19,6 +19,7 @@ import { VersionCompatibilityService } from './version-compatibility.service'; /** * Create a version compatibility factory + * * @param versionCompatibilityService service dependency * @returns factory function */ diff --git a/lib/content-services/src/lib/version-manager/content-version.service.ts b/lib/content-services/src/lib/version-manager/content-version.service.ts index 226a2f556bf..72ae3199996 100644 --- a/lib/content-services/src/lib/version-manager/content-version.service.ts +++ b/lib/content-services/src/lib/version-manager/content-version.service.ts @@ -35,6 +35,7 @@ export class ContentVersionService { /** * Get content URL for the given nodeId and specific version. + * * @param nodeId The ID of the node * @param versionId The ID of the version * @param attachment Retrieve content as an attachment for download diff --git a/lib/core/api/src/lib/adf-http-client.service.ts b/lib/core/api/src/lib/adf-http-client.service.ts index f8e49c97943..b015643e7b2 100644 --- a/lib/core/api/src/lib/adf-http-client.service.ts +++ b/lib/core/api/src/lib/adf-http-client.service.ts @@ -274,6 +274,7 @@ export class AdfHttpClient implements ee.Emitter, JsApiHttpClient { /** * Chooses a content type from the given array, with JSON preferred; i.e. return JSON if included, otherwise return the first. + * * @param contentTypes a contentType array * @returns The chosen content type, preferring JSON. */ @@ -298,6 +299,7 @@ export class AdfHttpClient implements ee.Emitter, JsApiHttpClient { *
  • application/json; charset=UTF8
    • *
  • APPLICATION/JSON
    • * + * * @param contentType The MIME content type to check. * @returns true if contentType represents JSON, otherwise false. */ @@ -342,6 +344,7 @@ export class AdfHttpClient implements ee.Emitter, JsApiHttpClient { /** * Deserialize an HTTP response body into a value of the specified type. + * * @param response response object * @param returnType return type * @returns deserialized object diff --git a/lib/core/api/src/lib/alfresco-api/alfresco-api.utils.ts b/lib/core/api/src/lib/alfresco-api/alfresco-api.utils.ts index 85f0917fba8..842af702d5a 100644 --- a/lib/core/api/src/lib/alfresco-api/alfresco-api.utils.ts +++ b/lib/core/api/src/lib/alfresco-api/alfresco-api.utils.ts @@ -69,6 +69,7 @@ export const getQueryParamsWithCustomEncoder = ( /** * Removes null and undefined values from an object. + * * @param obj object to process * @returns object with updated values */ diff --git a/lib/core/breadcrumbs/src/_stories/breadcrumb.stories.ts b/lib/core/breadcrumbs/src/_stories/breadcrumb.stories.ts index fc4c58d9ab9..699b1e94eb2 100644 --- a/lib/core/breadcrumbs/src/_stories/breadcrumb.stories.ts +++ b/lib/core/breadcrumbs/src/_stories/breadcrumb.stories.ts @@ -32,6 +32,7 @@ type StoryWithoutFunction = NonFunctionProperties>; /** * Copy storybook story + * * @param story story * @param annotations annotations * @returns a copy of the story diff --git a/lib/core/feature-flags/src/lib/providers/dummy-feature-flags.provider.ts b/lib/core/feature-flags/src/lib/providers/dummy-feature-flags.provider.ts index c6384efeebf..ed333531434 100644 --- a/lib/core/feature-flags/src/lib/providers/dummy-feature-flags.provider.ts +++ b/lib/core/feature-flags/src/lib/providers/dummy-feature-flags.provider.ts @@ -23,6 +23,7 @@ import { DummyFeaturesService } from '../services/dummy-features.service'; /** * Provides the dummy feature flags. + * * @returns Environment Providers for Feature Flags. */ export function provideDummyFeatureFlags() { diff --git a/lib/core/feature-flags/src/lib/services/debug-features.service.ts b/lib/core/feature-flags/src/lib/services/debug-features.service.ts index b928e9e3bf9..8c69c9975f2 100644 --- a/lib/core/feature-flags/src/lib/services/debug-features.service.ts +++ b/lib/core/feature-flags/src/lib/services/debug-features.service.ts @@ -68,6 +68,7 @@ export class DebugFeaturesService implements IDebugFeaturesService { /** * Gets the flags as an observable. + * * @returns the observable that emits the flag changeset. */ getFlags$(): Observable { @@ -78,6 +79,7 @@ export class DebugFeaturesService implements IDebugFeaturesService { /** * Resets the specified flags. + * * @param flags The flags to reset. */ resetFlags(flags: FlagSet): void { diff --git a/lib/core/shell/src/lib/shell.module.ts b/lib/core/shell/src/lib/shell.module.ts index b97e63f9c64..e5648b84292 100644 --- a/lib/core/shell/src/lib/shell.module.ts +++ b/lib/core/shell/src/lib/shell.module.ts @@ -41,6 +41,7 @@ export class ShellModule { /** * Resolve module for routes + * * @param routes route configuration * @returns module with providers */ @@ -59,6 +60,7 @@ function getModuleForRoutes(routes: Routes): ModuleWithProviders { /** * Resolve a module for the route configuration + * * @param config route configuration * @returns module with providers */ diff --git a/lib/core/src/lib/app-config/app-config.loader.ts b/lib/core/src/lib/app-config/app-config.loader.ts index 693fe4b829d..f8acf01fc07 100644 --- a/lib/core/src/lib/app-config/app-config.loader.ts +++ b/lib/core/src/lib/app-config/app-config.loader.ts @@ -22,6 +22,7 @@ import { StoragePrefixFactory } from './app-config-storage-prefix.factory'; /** * Create a factory to load app configuration + * * @param appConfigService app config service * @param storageService storage service * @param adfHttpClient http client diff --git a/lib/core/src/lib/app-config/app-config.service.ts b/lib/core/src/lib/app-config/app-config.service.ts index c978fb81be3..25e507a25ed 100644 --- a/lib/core/src/lib/app-config/app-config.service.ts +++ b/lib/core/src/lib/app-config/app-config.service.ts @@ -95,6 +95,7 @@ export class AppConfigService { /** * Requests notification of a property value when it is loaded. + * * @param property The desired property value * @returns Property value, when loaded */ @@ -107,6 +108,7 @@ export class AppConfigService { /** * Gets the value of a named property. + * * @param key Name of the property * @param defaultValue Value to return if the key is not found * @returns Value of the property @@ -137,6 +139,7 @@ export class AppConfigService { /** * Gets the location.protocol value. + * * @returns The location.protocol string */ getLocationProtocol(): string { @@ -145,6 +148,7 @@ export class AppConfigService { /** * Gets the location.hostname property. + * * @returns Value of the property */ getLocationHostname(): string { @@ -153,6 +157,7 @@ export class AppConfigService { /** * Gets the location.port property. + * * @param prefix Text added before port value * @returns Port with prefix */ @@ -182,6 +187,7 @@ export class AppConfigService { /** * Loads the config file. + * * @param callback an optional callback to execute when configuration is loaded * @returns Notification when loading is complete */ @@ -217,6 +223,7 @@ export class AppConfigService { /** * Call the discovery API to fetch configuration + * * @param hostIdp host address * @returns Discovery configuration */ @@ -237,6 +244,7 @@ export class AppConfigService { /** * OAuth2 configuration + * * @returns auth config model */ get oauth2(): OauthConfigModel { diff --git a/lib/core/src/lib/auth/basic-auth/content-auth.ts b/lib/core/src/lib/auth/basic-auth/content-auth.ts index d5cb125c96e..c691c6f9179 100644 --- a/lib/core/src/lib/auth/basic-auth/content-auth.ts +++ b/lib/core/src/lib/auth/basic-auth/content-auth.ts @@ -81,6 +81,7 @@ export class ContentAuth { /** * login Alfresco API + * * @param username username to login * @param password password to login * @returns A promise that returns {new authentication ticket} if resolved and {error} if rejected. @@ -122,6 +123,7 @@ export class ContentAuth { /** * logout Alfresco API + * * @returns A promise that returns { authentication ticket} if resolved and {error} if rejected. */ logout(): Promise { @@ -149,6 +151,7 @@ export class ContentAuth { /** * Set the current Ticket + * * @param ticket a string representing the ticket */ setTicket(ticket: string) { diff --git a/lib/core/src/lib/auth/basic-auth/process-auth.ts b/lib/core/src/lib/auth/basic-auth/process-auth.ts index bdc50ae7611..70dc416d17b 100644 --- a/lib/core/src/lib/auth/basic-auth/process-auth.ts +++ b/lib/core/src/lib/auth/basic-auth/process-auth.ts @@ -67,6 +67,7 @@ export class ProcessAuth { /** * login Activiti API + * * @param username Username to login * @param password Password to login * @returns A promise that returns {new authentication ticket} if resolved and {error} if rejected. @@ -123,6 +124,7 @@ export class ProcessAuth { /** * logout Alfresco API + * * @returns A promise that returns {new authentication ticket} if resolved and {error} if rejected. */ async logout(): Promise { @@ -164,6 +166,7 @@ export class ProcessAuth { /** * Set the current Ticket + * * @param ticket a string representing the ticket */ setTicket(ticket: string) { diff --git a/lib/core/src/lib/auth/guard/auth-guard-sso-role.service.spec.ts b/lib/core/src/lib/auth/guard/auth-guard-sso-role.service.spec.ts index 657325cb278..d3d1fb86301 100644 --- a/lib/core/src/lib/auth/guard/auth-guard-sso-role.service.spec.ts +++ b/lib/core/src/lib/auth/guard/auth-guard-sso-role.service.spec.ts @@ -39,6 +39,7 @@ describe('Auth Guard SSO role service', () => { /** * Spy on user access + * * @param realmRoles roles * @param resourceAccess resource access values */ diff --git a/lib/core/src/lib/auth/oidc/auth-config.service.ts b/lib/core/src/lib/auth/oidc/auth-config.service.ts index b5f824f87aa..c79b5d0a513 100644 --- a/lib/core/src/lib/auth/oidc/auth-config.service.ts +++ b/lib/core/src/lib/auth/oidc/auth-config.service.ts @@ -24,6 +24,7 @@ import { OauthConfigModel } from '../models/oauth-config.model'; /** * Create auth configuration factory + * * @param authConfigService auth config service * @returns factory function */ diff --git a/lib/core/src/lib/auth/oidc/auth.module.ts b/lib/core/src/lib/auth/oidc/auth.module.ts index 9e8a63120d6..c21b9123565 100644 --- a/lib/core/src/lib/auth/oidc/auth.module.ts +++ b/lib/core/src/lib/auth/oidc/auth.module.ts @@ -35,6 +35,7 @@ export const JWT_STORAGE_SERVICE = new InjectionToken('JWT_STORAGE /** * Create a Login Factory function + * * @param redirectService auth redirect service * @returns a factory function */ diff --git a/lib/core/src/lib/auth/oidc/retry-login.service.ts b/lib/core/src/lib/auth/oidc/retry-login.service.ts index c59d7af52c7..34f548ee22b 100644 --- a/lib/core/src/lib/auth/oidc/retry-login.service.ts +++ b/lib/core/src/lib/auth/oidc/retry-login.service.ts @@ -26,6 +26,7 @@ export class RetryLoginService { /** * Attempts to log in a specified number of times if the initial login attempt fails. + * * @param loginOptions - The options to be used for the login attempt. * @param maxLoginAttempts - The maximum number of login attempts. Defaults to 3. * @returns A promise that resolves to `true` if the login is successful, or rejects with an error if all attempts fail. diff --git a/lib/core/src/lib/auth/services/base-authentication.service.ts b/lib/core/src/lib/auth/services/base-authentication.service.ts index 5d5fcea59b4..e4b50272c26 100644 --- a/lib/core/src/lib/auth/services/base-authentication.service.ts +++ b/lib/core/src/lib/auth/services/base-authentication.service.ts @@ -59,6 +59,7 @@ export abstract class BaseAuthenticationService implements AuthenticationService /** * Adds the auth token to an HTTP header using the 'bearer' scheme. + * * @param requestUrl the request url * @param headersArg Header that will receive the token * @returns The new header with the token added @@ -87,6 +88,7 @@ export abstract class BaseAuthenticationService implements AuthenticationService /** * Does the provider support BPM? + * * @returns True if supported, false otherwise */ isBPMProvider(): boolean { @@ -100,6 +102,7 @@ export abstract class BaseAuthenticationService implements AuthenticationService /** * Does the provider support both ECM and BPM? + * * @returns True if both are supported, false otherwise */ isALLProvider(): boolean { @@ -114,6 +117,7 @@ export abstract class BaseAuthenticationService implements AuthenticationService /** * Prints an error message in the console browser + * * @param error Error message * @returns Object representing the error message */ diff --git a/lib/core/src/lib/auth/services/identity-group.service.ts b/lib/core/src/lib/auth/services/identity-group.service.ts index 48ffb5c0d98..b01489ec740 100644 --- a/lib/core/src/lib/auth/services/identity-group.service.ts +++ b/lib/core/src/lib/auth/services/identity-group.service.ts @@ -40,6 +40,7 @@ export class IdentityGroupService implements IdentityGroupServiceInterface { /** * Gets all groups. + * * @returns Array of group information objects */ getGroups(): Observable { @@ -49,6 +50,7 @@ export class IdentityGroupService implements IdentityGroupServiceInterface { /** * Gets available roles + * * @param groupId Id of the group. * @returns Array of available roles information objects */ @@ -59,6 +61,7 @@ export class IdentityGroupService implements IdentityGroupServiceInterface { /** * Gets assigned roles + * * @param groupId Id of the group. * @returns Array of available roles */ @@ -69,6 +72,7 @@ export class IdentityGroupService implements IdentityGroupServiceInterface { /** * Assigns roles to the group + * * @param groupId The ID of the group * @param roles Array of roles to assign * @returns request result @@ -82,6 +86,7 @@ export class IdentityGroupService implements IdentityGroupServiceInterface { /** * Removes roles from the group + * * @param groupId The ID of the group * @param roles Array of roles to remove * @returns request result @@ -95,6 +100,7 @@ export class IdentityGroupService implements IdentityGroupServiceInterface { /** * Get effective roles + * * @param groupId Id of the group * @returns Array of effective roles */ @@ -105,6 +111,7 @@ export class IdentityGroupService implements IdentityGroupServiceInterface { /** * Queries groups. + * * @param requestQuery query settings * @returns Array of user information objects */ @@ -135,6 +142,7 @@ export class IdentityGroupService implements IdentityGroupServiceInterface { /** * Gets groups total count. + * * @returns Number of groups count. */ getTotalGroupsCount(): Observable { @@ -144,6 +152,7 @@ export class IdentityGroupService implements IdentityGroupServiceInterface { /** * Creates new group. + * * @param newGroup Object of containing the new group details. * @returns Empty response when the group created. */ @@ -156,6 +165,7 @@ export class IdentityGroupService implements IdentityGroupServiceInterface { /** * Updates group details. + * * @param groupId Id of the targeted group. * @param updatedGroup Object of containing the group details * @returns Empty response when the group updated. @@ -169,6 +179,7 @@ export class IdentityGroupService implements IdentityGroupServiceInterface { /** * Deletes Group. + * * @param groupId Id of the group. * @returns Empty response when the group deleted. */ @@ -179,6 +190,7 @@ export class IdentityGroupService implements IdentityGroupServiceInterface { /** * Finds groups filtered by name. + * * @param searchParams Object containing the name filter string * @returns List of group information */ @@ -194,6 +206,7 @@ export class IdentityGroupService implements IdentityGroupServiceInterface { /** * Gets details for a specified group. + * * @param groupId Id of the target group * @returns Group details */ @@ -204,6 +217,7 @@ export class IdentityGroupService implements IdentityGroupServiceInterface { /** * Check that a group has one or more roles from the supplied list. + * * @param groupId Id of the target group * @param roleNames Array of role names * @returns True if the group has one or more of the roles, false otherwise @@ -228,6 +242,7 @@ export class IdentityGroupService implements IdentityGroupServiceInterface { /** * Gets the client Id using the app name. + * * @param applicationName Name of the app * @returns client Id string */ @@ -240,6 +255,7 @@ export class IdentityGroupService implements IdentityGroupServiceInterface { /** * Gets client roles. + * * @param groupId Id of the target group * @param clientId Id of the client * @returns List of roles @@ -251,6 +267,7 @@ export class IdentityGroupService implements IdentityGroupServiceInterface { /** * Checks if a group has a client app. + * * @param groupId Id of the target group * @param clientId Id of the client * @returns True if the group has the client app, false otherwise @@ -261,6 +278,7 @@ export class IdentityGroupService implements IdentityGroupServiceInterface { /** * Check if a group has any of the client app roles in the supplied list. + * * @param groupId Id of the target group * @param clientId Id of the client * @param roleNames Array of role names to check diff --git a/lib/core/src/lib/auth/services/identity-role.service.ts b/lib/core/src/lib/auth/services/identity-role.service.ts index 042ac29074d..02315414552 100644 --- a/lib/core/src/lib/auth/services/identity-role.service.ts +++ b/lib/core/src/lib/auth/services/identity-role.service.ts @@ -42,6 +42,7 @@ export class IdentityRoleService { /** * Ret all roles + * * @param skipCount skip count * @param size page size * @returns List of roles @@ -65,6 +66,7 @@ export class IdentityRoleService { /** * Add new role + * * @param newRole Role model * @returns Server result payload */ @@ -77,6 +79,7 @@ export class IdentityRoleService { /** * Delete existing role + * * @param deletedRole Role model * @returns Server result payload */ @@ -86,6 +89,7 @@ export class IdentityRoleService { /** * Update existing role + * * @param updatedRole Role model * @param roleId Role id * @returns Server result payload diff --git a/lib/core/src/lib/auth/services/identity-user.service.ts b/lib/core/src/lib/auth/services/identity-user.service.ts index 8b683d138d9..ff2b04a7258 100644 --- a/lib/core/src/lib/auth/services/identity-user.service.ts +++ b/lib/core/src/lib/auth/services/identity-user.service.ts @@ -48,6 +48,7 @@ export class IdentityUserService implements IdentityUserServiceInterface { /** * Gets the name and other basic details of the current user. + * * @returns The user's details */ getCurrentUserInfo(): IdentityUserModel { @@ -60,6 +61,7 @@ export class IdentityUserService implements IdentityUserServiceInterface { /** * Find users based on search input. + * * @param search Search query string * @returns List of users */ @@ -75,6 +77,7 @@ export class IdentityUserService implements IdentityUserServiceInterface { /** * Find users based on username input. + * * @param username Search query string * @returns List of users */ @@ -90,6 +93,7 @@ export class IdentityUserService implements IdentityUserServiceInterface { /** * Find users based on email input. + * * @param email Search query string * @returns List of users */ @@ -105,6 +109,7 @@ export class IdentityUserService implements IdentityUserServiceInterface { /** * Find users based on id input. + * * @param id Search query string * @returns users object */ @@ -118,6 +123,7 @@ export class IdentityUserService implements IdentityUserServiceInterface { /** * Get client roles of a user for a particular client. + * * @param userId ID of the target user * @param clientId ID of the client app * @returns List of client roles @@ -129,6 +135,7 @@ export class IdentityUserService implements IdentityUserServiceInterface { /** * Checks whether user has access to a client app. + * * @param userId ID of the target user * @param clientId ID of the client app * @returns True if the user has access, false otherwise @@ -139,6 +146,7 @@ export class IdentityUserService implements IdentityUserServiceInterface { /** * Checks whether a user has any of the client app roles. + * * @param userId ID of the target user * @param clientId ID of the client app * @param roleNames List of role names to check for @@ -165,6 +173,7 @@ export class IdentityUserService implements IdentityUserServiceInterface { /** * Gets the client ID for an application. + * * @param applicationName Name of the application * @returns Client ID string */ @@ -177,6 +186,7 @@ export class IdentityUserService implements IdentityUserServiceInterface { /** * Checks if a user has access to an application. + * * @param userId ID of the user * @param applicationName Name of the application * @returns True if the user has access, false otherwise @@ -187,6 +197,7 @@ export class IdentityUserService implements IdentityUserServiceInterface { /** * Checks if a user has any application role. + * * @param userId ID of the target user * @param applicationName Name of the application * @param roleNames List of role names to check for @@ -200,6 +211,7 @@ export class IdentityUserService implements IdentityUserServiceInterface { /** * Gets details for all users. + * * @returns Array of user info objects */ getUsers(): Observable { @@ -209,6 +221,7 @@ export class IdentityUserService implements IdentityUserServiceInterface { /** * Gets a list of roles for a user. + * * @param userId ID of the user * @returns Array of role info objects */ @@ -219,6 +232,7 @@ export class IdentityUserService implements IdentityUserServiceInterface { /** * Gets an array of users (including the current user) who have any of the roles in the supplied list. + * * @param roleNames List of role names to look for * @returns Array of user info objects */ @@ -240,6 +254,7 @@ export class IdentityUserService implements IdentityUserServiceInterface { /** * Gets an array of users (not including the current user) who have any of the roles in the supplied list. + * * @param roleNames List of role names to look for * @returns Array of user info objects */ @@ -275,6 +290,7 @@ export class IdentityUserService implements IdentityUserServiceInterface { /** * Checks if a user has one of the roles from a list. + * * @param userId ID of the target user * @param roleNames Array of roles to check for * @returns True if the user has one of the roles, false otherwise @@ -299,6 +315,7 @@ export class IdentityUserService implements IdentityUserServiceInterface { /** * Gets details for all users. + * * @param requestQuery query model * @returns Array of user information objects. */ @@ -329,6 +346,7 @@ export class IdentityUserService implements IdentityUserServiceInterface { /** * Gets users total count. + * * @returns Number of users count. */ getTotalUsersCount(): Observable { @@ -338,6 +356,7 @@ export class IdentityUserService implements IdentityUserServiceInterface { /** * Creates new user. + * * @param newUser Object containing the new user details. * @returns Empty response when the user created. */ @@ -350,6 +369,7 @@ export class IdentityUserService implements IdentityUserServiceInterface { /** * Updates user details. + * * @param userId Id of the user. * @param updatedUser Object containing the user details. * @returns Empty response when the user updated. @@ -363,6 +383,7 @@ export class IdentityUserService implements IdentityUserServiceInterface { /** * Deletes User. + * * @param userId Id of the user. * @returns Empty response when the user deleted. */ @@ -373,6 +394,7 @@ export class IdentityUserService implements IdentityUserServiceInterface { /** * Changes user password. + * * @param userId Id of the user. * @param newPassword Details of user Credentials. * @returns Empty response when the password changed. @@ -386,6 +408,7 @@ export class IdentityUserService implements IdentityUserServiceInterface { /** * Gets involved groups. + * * @param userId Id of the user. * @returns Array of involved groups information objects. */ @@ -398,6 +421,7 @@ export class IdentityUserService implements IdentityUserServiceInterface { /** * Joins group. + * * @param joinGroupRequest Details of join group request (IdentityJoinGroupRequestModel). * @returns Empty response when the user joined the group. */ @@ -410,6 +434,7 @@ export class IdentityUserService implements IdentityUserServiceInterface { /** * Leaves group. + * * @param userId Id of the user. * @param groupId Id of the group. * @returns Empty response when the user left the group. @@ -421,6 +446,7 @@ export class IdentityUserService implements IdentityUserServiceInterface { /** * Gets available roles + * * @param userId Id of the user. * @returns Array of available roles information objects */ @@ -431,6 +457,7 @@ export class IdentityUserService implements IdentityUserServiceInterface { /** * Gets assigned roles. + * * @param userId Id of the user. * @returns Array of assigned roles information objects */ @@ -443,6 +470,7 @@ export class IdentityUserService implements IdentityUserServiceInterface { /** * Gets effective roles. + * * @param userId Id of the user. * @returns Array of composite roles information objects */ @@ -455,6 +483,7 @@ export class IdentityUserService implements IdentityUserServiceInterface { /** * Assigns roles to the user. + * * @param userId Id of the user. * @param roles Array of roles. * @returns Empty response when the role assigned. @@ -468,6 +497,7 @@ export class IdentityUserService implements IdentityUserServiceInterface { /** * Removes assigned roles. + * * @param userId Id of the user. * @param removedRoles Array of roles. * @returns Empty response when the role removed. diff --git a/lib/core/src/lib/auth/services/jwt-helper.service.ts b/lib/core/src/lib/auth/services/jwt-helper.service.ts index 6f86a9089e3..90c3b55cec1 100644 --- a/lib/core/src/lib/auth/services/jwt-helper.service.ts +++ b/lib/core/src/lib/auth/services/jwt-helper.service.ts @@ -33,10 +33,11 @@ export class JwtHelperService { static USER_PREFERRED_USERNAME = 'preferred_username'; static HXP_AUTHORIZATION = 'hxp_authorization'; - private storageService: OAuthStorage = inject(OAuthStorage) + private storageService: OAuthStorage = inject(OAuthStorage); /** * Decodes a JSON web token into a JS object. + * * @param token Token in encoded form * @returns Decoded token data object */ @@ -78,6 +79,7 @@ export class JwtHelperService { /** * Gets a named value from the user access or id token. + * * @param key Key name of the field to retrieve * @returns Value from the token */ @@ -87,6 +89,7 @@ export class JwtHelperService { /** * Gets a named value from the user access token. + * * @param key Key name of the field to retrieve * @returns Value from the token */ @@ -96,6 +99,7 @@ export class JwtHelperService { /** * Gets access token + * * @returns access token */ getAccessToken(): string { @@ -104,6 +108,7 @@ export class JwtHelperService { /** * Gets a named value from the user id token. + * * @param key Key name of the field to retrieve * @returns Value from the token */ @@ -113,6 +118,7 @@ export class JwtHelperService { /** * Gets id token + * * @returns id token */ getIdToken(): string { @@ -121,6 +127,7 @@ export class JwtHelperService { /** * Gets a named value from the user access token. + * * @param token your SSO access token where the value is encode * @param key Key name of the field to retrieve * @returns Value from the token @@ -137,6 +144,7 @@ export class JwtHelperService { /** * Gets realm roles. + * * @returns Array of realm roles */ getRealmRoles(): string[] { @@ -146,6 +154,7 @@ export class JwtHelperService { /** * Gets Client roles. + * * @param clientName client name * @returns Array of client roles */ @@ -156,6 +165,7 @@ export class JwtHelperService { /** * Checks for single realm role. + * * @param role Role name to check * @returns True if it contains given role, false otherwise */ @@ -170,6 +180,7 @@ export class JwtHelperService { /** * Checks for realm roles. + * * @param rolesToCheck List of role names to check * @returns True if it contains at least one of the given roles, false otherwise */ @@ -179,6 +190,7 @@ export class JwtHelperService { /** * Checks for client roles. + * * @param clientName Targeted client name * @param rolesToCheck List of role names to check * @returns True if it contains at least one of the given roles, false otherwise @@ -189,6 +201,7 @@ export class JwtHelperService { /** * Checks for client role. + * * @param clientName Targeted client name * @param role Role name to check * @returns True if it contains given role, false otherwise diff --git a/lib/core/src/lib/auth/services/time-sync.service.ts b/lib/core/src/lib/auth/services/time-sync.service.ts index 92d2870c83f..20f1b5cb54e 100644 --- a/lib/core/src/lib/auth/services/time-sync.service.ts +++ b/lib/core/src/lib/auth/services/time-sync.service.ts @@ -73,6 +73,7 @@ export class TimeSyncService { /** * Checks if the local time is out of sync with the server time. + * * @param maxAllowedClockSkewInSec - The maximum allowed clock skew in seconds. * @returns An Observable that emits a boolean indicating whether the local time is out of sync. */ diff --git a/lib/core/src/lib/auth/services/user-access.service.spec.ts b/lib/core/src/lib/auth/services/user-access.service.spec.ts index ac739835378..764f6715eba 100644 --- a/lib/core/src/lib/auth/services/user-access.service.spec.ts +++ b/lib/core/src/lib/auth/services/user-access.service.spec.ts @@ -40,6 +40,7 @@ describe('UserAccessService', () => { /** * spy on auth realm access + * * @param realmRoles roles * @param resourceAccess access settings */ @@ -53,6 +54,7 @@ describe('UserAccessService', () => { /** * spy on HxP authorisation + * * @param appkey app key * @param roles roles list */ diff --git a/lib/core/src/lib/auth/services/user-access.service.ts b/lib/core/src/lib/auth/services/user-access.service.ts index 1d33bccea1b..01c619c4ea1 100644 --- a/lib/core/src/lib/auth/services/user-access.service.ts +++ b/lib/core/src/lib/auth/services/user-access.service.ts @@ -67,6 +67,7 @@ export class UserAccessService { /** * Checks for global roles access. + * * @param rolesToCheck List of the roles to check * @returns True if it contains at least one of the given roles, false otherwise */ @@ -90,6 +91,7 @@ export class UserAccessService { /** * Checks for global roles access. + * * @param appName The app name * @param rolesToCheck List of the roles to check * @returns True if it contains at least one of the given roles, false otherwise diff --git a/lib/core/src/lib/card-view/components/card-view/card-view.component.spec.ts b/lib/core/src/lib/card-view/components/card-view/card-view.component.spec.ts index 2907a6b150e..0e4946a84d6 100644 --- a/lib/core/src/lib/card-view/components/card-view/card-view.component.spec.ts +++ b/lib/core/src/lib/card-view/components/card-view/card-view.component.spec.ts @@ -272,6 +272,7 @@ describe('CardViewComponent', () => { /** * Return the card view item dispatcher component + * * @returns the dispatcher component instance */ function getCardViewItemDispatcherComponent(): CardViewItemDispatcherComponent { diff --git a/lib/core/src/lib/card-view/services/card-view-update.service.ts b/lib/core/src/lib/card-view/services/card-view-update.service.ts index 0c2ea92b0b0..8e96f0a19ac 100644 --- a/lib/core/src/lib/card-view/services/card-view-update.service.ts +++ b/lib/core/src/lib/card-view/services/card-view-update.service.ts @@ -52,6 +52,7 @@ export class CardViewUpdateService implements BaseCardViewUpdate { /** * Updates the cardview items property + * * @param notification notification value */ updateElement(notification: CardViewBaseItemModel) { diff --git a/lib/core/src/lib/clipboard/clipboard.service.ts b/lib/core/src/lib/clipboard/clipboard.service.ts index 97cf7c6e3d4..48d9cf5cb66 100644 --- a/lib/core/src/lib/clipboard/clipboard.service.ts +++ b/lib/core/src/lib/clipboard/clipboard.service.ts @@ -25,6 +25,7 @@ export class ClipboardService { /** * Checks if the target element can have its text copied. + * * @param target Target HTML element * @returns True if the text can be copied, false otherwise */ @@ -37,6 +38,7 @@ export class ClipboardService { /** * Copies text from an HTML element to the clipboard. + * * @param target HTML element to be copied * @param message Snackbar message to alert when copying happens */ @@ -59,6 +61,7 @@ export class ClipboardService { /** * Copies a text string to the clipboard. + * * @param content Text to copy * @param message Snackbar message to alert when copying happens */ diff --git a/lib/core/src/lib/common/services/cookie.service.ts b/lib/core/src/lib/common/services/cookie.service.ts index a1c33dd582b..7be7214a104 100644 --- a/lib/core/src/lib/common/services/cookie.service.ts +++ b/lib/core/src/lib/common/services/cookie.service.ts @@ -36,6 +36,7 @@ export class CookieService { /** * Checks if cookies are enabled. + * * @returns True if enabled, false otherwise */ isEnabled(): boolean { @@ -44,6 +45,7 @@ export class CookieService { /** * Retrieves a cookie by its key. + * * @param key Key to identify the cookie * @returns The cookie data or null if it is not found */ @@ -55,6 +57,7 @@ export class CookieService { /** * Sets a cookie. + * * @param key Key to identify the cookie * @param data Data value to set for the cookie * @param expiration Expiration date of the data @@ -66,6 +69,7 @@ export class CookieService { /** * Delete a cookie Key. + * * @param key Key to identify the cookie * @param path "Pathname" to store the cookie */ diff --git a/lib/core/src/lib/common/services/download.service.ts b/lib/core/src/lib/common/services/download.service.ts index c7eafdea8fa..80bfaeb7915 100644 --- a/lib/core/src/lib/common/services/download.service.ts +++ b/lib/core/src/lib/common/services/download.service.ts @@ -59,6 +59,7 @@ export class DownloadService { /** * Invokes content download for a Blob with a file name. + * * @param blob Content to download. * @param fileName Name of the resulting file. */ @@ -68,6 +69,7 @@ export class DownloadService { /** * Invokes content download for a data array with a file name. + * * @param data Data to download. * @param fileName Name of the resulting file. */ @@ -77,6 +79,7 @@ export class DownloadService { /** * Invokes content download for a JSON object with a file name. + * * @param json JSON object to download. * @param fileName Name of the resulting file. */ @@ -86,6 +89,7 @@ export class DownloadService { /** * Invokes the download of the file by its URL address. + * * @param url Url address pointing to the file. * @param fileName Name of the file download. */ diff --git a/lib/core/src/lib/common/services/dynamic-component-mapper.service.ts b/lib/core/src/lib/common/services/dynamic-component-mapper.service.ts index d51b195c086..fafa18447a5 100644 --- a/lib/core/src/lib/common/services/dynamic-component-mapper.service.ts +++ b/lib/core/src/lib/common/services/dynamic-component-mapper.service.ts @@ -39,6 +39,7 @@ export abstract class DynamicComponentMapper { /** * Gets the currently active DynamicComponentResolveFunction for a field type. + * * @param type The type whose resolver you want * @param defaultValue Default type returned for types that are not yet mapped * @returns Resolver function @@ -52,6 +53,7 @@ export abstract class DynamicComponentMapper { /** * Sets or optionally replaces a DynamicComponentResolveFunction for a field type. + * * @param type The type whose resolver you want to set * @param resolver The new resolver function * @param override The new resolver will only replace an existing one if this parameter is true @@ -75,6 +77,7 @@ export abstract class DynamicComponentMapper { /** * Register multiple components + * * @param components map of components to register * @param override replace existing components */ @@ -88,6 +91,7 @@ export abstract class DynamicComponentMapper { /** * Finds the component type that is needed to render a form field. + * * @param model Form field model for the field to render * @param defaultValue Default type returned for field types that are not yet mapped. * @returns Component type diff --git a/lib/core/src/lib/common/services/highlight-transform.service.ts b/lib/core/src/lib/common/services/highlight-transform.service.ts index 1be9192fe3e..542e4c4e378 100644 --- a/lib/core/src/lib/common/services/highlight-transform.service.ts +++ b/lib/core/src/lib/common/services/highlight-transform.service.ts @@ -28,6 +28,7 @@ export interface HighlightTransformResult { export class HighlightTransformService { /** * Searches for `search` string(s) within `text` and highlights all occurrences. + * * @param text Text to search within * @param search Text pattern to search for * @param wrapperClass CSS class used to provide highlighting style diff --git a/lib/core/src/lib/common/services/log.service.ts b/lib/core/src/lib/common/services/log.service.ts index 083714441bf..b899885337e 100644 --- a/lib/core/src/lib/common/services/log.service.ts +++ b/lib/core/src/lib/common/services/log.service.ts @@ -47,6 +47,7 @@ export class LogService { /** * Logs a message at the "ERROR" level. + * * @param message Message to log * @param optionalParams Interpolation values for the message in "printf" format */ @@ -60,6 +61,7 @@ export class LogService { /** * Logs a message at the "DEBUG" level. + * * @param message Message to log * @param optionalParams Interpolation values for the message in "printf" format */ @@ -73,6 +75,7 @@ export class LogService { /** * Logs a message at the "INFO" level. + * * @param message Message to log * @param optionalParams Interpolation values for the message in "printf" format */ @@ -86,6 +89,7 @@ export class LogService { /** * Logs a message at any level from "TRACE" upwards. + * * @param message Message to log * @param optionalParams Interpolation values for the message in "printf" format */ @@ -99,6 +103,7 @@ export class LogService { /** * Logs a message at the "TRACE" level. + * * @param message Message to log * @param optionalParams Interpolation values for the message in "printf" format */ @@ -112,6 +117,7 @@ export class LogService { /** * Logs a message at the "WARN" level. + * * @param message Message to log * @param optionalParams Interpolation values for the message in "printf" format */ @@ -125,6 +131,7 @@ export class LogService { /** * Logs a message if a boolean test fails. + * * @param test Test value (typically a boolean expression) * @param message Message to show if test is false * @param optionalParams Interpolation values for the message in "printf" format @@ -139,6 +146,7 @@ export class LogService { /** * Starts an indented group of log messages. + * * @param groupTitle Title shown at the start of the group * @param optionalParams Interpolation values for the title in "printf" format */ @@ -159,6 +167,7 @@ export class LogService { /** * Converts a log level name string into its numeric equivalent. + * * @param level Level name * @returns Numeric log level */ @@ -170,6 +179,7 @@ export class LogService { /** * Triggers notification callback for log messages. + * * @param text Message text * @param logLevel Log level for the message */ diff --git a/lib/core/src/lib/common/services/page-title.service.ts b/lib/core/src/lib/common/services/page-title.service.ts index 06c42e548a3..7924072bd6b 100644 --- a/lib/core/src/lib/common/services/page-title.service.ts +++ b/lib/core/src/lib/common/services/page-title.service.ts @@ -34,6 +34,7 @@ export class PageTitleService { /** * Sets the page title. + * * @param value The new title */ setTitle(value: string = '') { diff --git a/lib/core/src/lib/common/services/storage.service.ts b/lib/core/src/lib/common/services/storage.service.ts index bb7167b3366..d1d768a6a6f 100644 --- a/lib/core/src/lib/common/services/storage.service.ts +++ b/lib/core/src/lib/common/services/storage.service.ts @@ -39,6 +39,7 @@ export class StorageService { /** * Gets an item. + * * @param key Key to identify the item * @returns The item (if any) retrieved by the key */ @@ -52,6 +53,7 @@ export class StorageService { /** * Stores an item + * * @param key Key to identify the item * @param data Data to store */ @@ -74,6 +76,7 @@ export class StorageService { /** * Removes a single item. + * * @param key Key to identify the item */ removeItem(key: string) { @@ -86,6 +89,7 @@ export class StorageService { /** * Is any item currently stored under `key`? + * * @param key Key identifying item to check * @returns True if key retrieves an item, false otherwise */ diff --git a/lib/core/src/lib/common/services/thumbnail.service.ts b/lib/core/src/lib/common/services/thumbnail.service.ts index 2ceedb906f1..0059fec3aa5 100644 --- a/lib/core/src/lib/common/services/thumbnail.service.ts +++ b/lib/core/src/lib/common/services/thumbnail.service.ts @@ -172,6 +172,7 @@ export class ThumbnailService { /** * Gets a thumbnail URL for a MIME type. + * * @param mimeType MIME type for the thumbnail * @returns URL string */ @@ -182,6 +183,7 @@ export class ThumbnailService { /** * Gets a "miscellaneous" thumbnail URL for types with no other icon defined. + * * @returns URL string */ getDefaultMimeTypeIcon(): string { diff --git a/lib/core/src/lib/common/services/url.service.ts b/lib/core/src/lib/common/services/url.service.ts index 17f7e3d2252..ff9ebf45cc8 100644 --- a/lib/core/src/lib/common/services/url.service.ts +++ b/lib/core/src/lib/common/services/url.service.ts @@ -27,6 +27,7 @@ export class UrlService { /** * Creates a trusted object URL from the Blob. * WARNING: calling this method with untrusted user data exposes your application to XSS security risks! + * * @param blob Data to wrap into object URL * @returns URL string */ diff --git a/lib/core/src/lib/common/services/user-preferences.service.ts b/lib/core/src/lib/common/services/user-preferences.service.ts index 7aa40a2e3c0..95e63f1f9ec 100644 --- a/lib/core/src/lib/common/services/user-preferences.service.ts +++ b/lib/core/src/lib/common/services/user-preferences.service.ts @@ -90,6 +90,7 @@ export class UserPreferencesService { /** * Sets up a callback to notify when a property has changed. + * * @param property The property to watch * @returns Notification callback */ @@ -102,6 +103,7 @@ export class UserPreferencesService { /** * Gets a preference property. + * * @param property Name of the property * @param defaultValue Default to return if the property is not found * @returns Preference property @@ -117,6 +119,7 @@ export class UserPreferencesService { /** * Sets a preference property. + * * @param property Name of the property * @param value New value for the property */ @@ -131,6 +134,7 @@ export class UserPreferencesService { /** * Sets a preference property. + * * @param property Name of the property * @param value New value for the property */ @@ -144,6 +148,7 @@ export class UserPreferencesService { /** * Check if an item is present in the storage + * * @param property Name of the property * @returns True if the item is present, false otherwise */ @@ -156,6 +161,7 @@ export class UserPreferencesService { /** * Gets the active storage prefix for preferences. + * * @returns Storage prefix */ getStoragePrefix(): string { @@ -164,6 +170,7 @@ export class UserPreferencesService { /** * Sets the active storage prefix for preferences. + * * @param value Name of the prefix */ setStoragePrefix(value: string | null) { @@ -173,6 +180,7 @@ export class UserPreferencesService { /** * Gets the full property key with prefix. + * * @param property The property name * @returns Property key */ @@ -182,6 +190,7 @@ export class UserPreferencesService { /** * Gets an array containing the available page sizes. + * * @returns Array of page size values */ get supportedPageSizes(): number[] { @@ -215,6 +224,7 @@ export class UserPreferencesService { /** * Current locale setting. + * * @returns locale name */ get locale(): string { @@ -227,6 +237,7 @@ export class UserPreferencesService { /** * Gets the default locale. + * * @returns Default locale language code */ getDefaultLocale(): string { diff --git a/lib/core/src/lib/common/utils/date-fns-adapter.ts b/lib/core/src/lib/common/utils/date-fns-adapter.ts index faea1c170f6..4bbafcd3d30 100644 --- a/lib/core/src/lib/common/utils/date-fns-adapter.ts +++ b/lib/core/src/lib/common/utils/date-fns-adapter.ts @@ -27,6 +27,7 @@ import { isValid, Locale, parse } from 'date-fns'; * * Automatically switches locales based on user preferences. * Supports custom display format. + * * @example * * Add the following to the component `providers` section diff --git a/lib/core/src/lib/common/utils/date-fns-utils.ts b/lib/core/src/lib/common/utils/date-fns-utils.ts index 3920c023657..7f8daf4f4cb 100644 --- a/lib/core/src/lib/common/utils/date-fns-utils.ts +++ b/lib/core/src/lib/common/utils/date-fns-utils.ts @@ -101,6 +101,7 @@ export class DateFnsUtils { /** * Converts a Moment.js date format string to the equivalent date-fns format string. + * * @param dateDisplayFormat - The Moment.js date format string to convert. * @returns The equivalent date-fns format string. */ @@ -119,6 +120,7 @@ export class DateFnsUtils { /** * Formats a date using the specified date format. + * * @param date - The date to format, can be a number or a Date object. * @param dateFormat - The date format string to use for formatting. * @returns The formatted date as a string @@ -132,6 +134,7 @@ export class DateFnsUtils { /** * Parses a date string using the specified date format. + * * @param value - The date value to parse. Can be a string or a Date (for generic calls) * @param dateFormat - The date format string to use for parsing. * @param options - Additional options @@ -154,6 +157,7 @@ export class DateFnsUtils { /** * Parses a datetime string using the ISO format + * * @param value - The date and time string to parse * @returns returns the parsed Date object */ @@ -163,6 +167,7 @@ export class DateFnsUtils { /** * Checks if the date string is a valid date according to the specified format + * * @param dateValue Date value * @param dateFormat The date format * @returns `true` if the date is valid, otherwise `false` @@ -177,6 +182,7 @@ export class DateFnsUtils { /** * Validates a date is before another one + * * @param source source date to compare * @param target target date to compare * @returns `true` if the source date is before the target one, otherwise `false` @@ -187,6 +193,7 @@ export class DateFnsUtils { /** * Validates a date is after another one + * * @param source source date to compare * @param target target date to compare * @returns `true` if the source date is after the target one, otherwise `false` diff --git a/lib/core/src/lib/common/utils/object-utils.ts b/lib/core/src/lib/common/utils/object-utils.ts index 3cbe1d66a30..c755de2277a 100644 --- a/lib/core/src/lib/common/utils/object-utils.ts +++ b/lib/core/src/lib/common/utils/object-utils.ts @@ -19,6 +19,7 @@ export class ObjectUtils { /** * Gets a value from an object by composed key * ObjectUtils.getValue({ item: { nodeType: 'cm:folder' }}, 'item.nodeType') ==> 'cm:folder' + * * @param target target object * @param key object property key * @returns object property value diff --git a/lib/core/src/lib/dialogs/unsaved-changes-dialog/unsaved-changes-dialog.component.ts b/lib/core/src/lib/dialogs/unsaved-changes-dialog/unsaved-changes-dialog.component.ts index 7dfec811926..76308677566 100644 --- a/lib/core/src/lib/dialogs/unsaved-changes-dialog/unsaved-changes-dialog.component.ts +++ b/lib/core/src/lib/dialogs/unsaved-changes-dialog/unsaved-changes-dialog.component.ts @@ -60,6 +60,7 @@ export class UnsavedChangesDialogComponent implements OnInit { /** * Sets 'unsaved_changes__modal_visible' checked state (true or false string) as new item in local storage. + * * @param savePreferences - MatCheckboxChange object with information about checkbox state. */ onToggleCheckboxPreferences(savePreferences: MatCheckboxChange) { diff --git a/lib/core/src/lib/dialogs/unsaved-changes-dialog/unsaved-changes.guard.ts b/lib/core/src/lib/dialogs/unsaved-changes-dialog/unsaved-changes.guard.ts index 56e267e46b0..1eb92a822f2 100644 --- a/lib/core/src/lib/dialogs/unsaved-changes-dialog/unsaved-changes.guard.ts +++ b/lib/core/src/lib/dialogs/unsaved-changes-dialog/unsaved-changes.guard.ts @@ -38,6 +38,7 @@ export class UnsavedChangesGuard implements CanDeactivate { /** * Allows to deactivate route when there is no unsaved changes, otherwise displays dialog to confirm discarding changes. + * * @returns boolean | Observable true when there is no unsaved changes or changes can be discarded, false otherwise. */ canDeactivate(): boolean | Observable { diff --git a/lib/core/src/lib/directives/upload.directive.ts b/lib/core/src/lib/directives/upload.directive.ts index 5cd9de6fc3f..b78aaa17775 100644 --- a/lib/core/src/lib/directives/upload.directive.ts +++ b/lib/core/src/lib/directives/upload.directive.ts @@ -191,6 +191,7 @@ export class UploadDirective implements OnInit, OnDestroy { /** * Extract files from the DataTransfer object used to hold the data that is being dragged during a drag and drop operation. + * * @param dataTransfer DataTransfer object * @returns a list of file info objects */ @@ -251,6 +252,7 @@ export class UploadDirective implements OnInit, OnDestroy { /** * Invoked when user selects files or folders by means of File Dialog + * * @param event DOM event */ onSelectFiles(event: any): void { diff --git a/lib/core/src/lib/dynamic-chip-list/dynamic-chip-list.component.spec.ts b/lib/core/src/lib/dynamic-chip-list/dynamic-chip-list.component.spec.ts index 4a9cfba3b1f..4b656a0bc6f 100644 --- a/lib/core/src/lib/dynamic-chip-list/dynamic-chip-list.component.spec.ts +++ b/lib/core/src/lib/dynamic-chip-list/dynamic-chip-list.component.spec.ts @@ -46,6 +46,7 @@ describe('DynamicChipListComponent', () => { /** * Find 'More' button + * * @returns native element */ function findViewMoreButton(): HTMLButtonElement { @@ -54,6 +55,7 @@ describe('DynamicChipListComponent', () => { /** * Get the chips + * * @returns native element list */ function findChips(): NodeListOf { @@ -174,6 +176,7 @@ describe('DynamicChipListComponent', () => { /** * Render chips + * * @param chipsToRender chips to render */ async function renderChips(chipsToRender?: Chip[]) { diff --git a/lib/core/src/lib/form/components/form-base.component.ts b/lib/core/src/lib/form/components/form-base.component.ts index 6bee6fcc4a5..22e60510836 100644 --- a/lib/core/src/lib/form/components/form-base.component.ts +++ b/lib/core/src/lib/form/components/form-base.component.ts @@ -185,6 +185,7 @@ export abstract class FormBaseComponent { /** * Invoked when user clicks outcome button. + * * @param outcome Form outcome model * @returns `true` if outcome button was clicked, otherwise `false` */ diff --git a/lib/core/src/lib/form/components/form-renderer.component.ts b/lib/core/src/lib/form/components/form-renderer.component.ts index 210427ff0e6..63c5146c84e 100644 --- a/lib/core/src/lib/form/components/form-renderer.component.ts +++ b/lib/core/src/lib/form/components/form-renderer.component.ts @@ -113,6 +113,7 @@ export class FormRendererComponent implements OnInit, OnDestroy { /** * Serializes column fields + * * @param content container model * @returns a list of form field models */ @@ -149,6 +150,7 @@ export class FormRendererComponent implements OnInit, OnDestroy { /** * Calculate the column width based on the numberOfColumns and current field's colspan property + * * @param container container model * @returns the column width for the given model */ diff --git a/lib/core/src/lib/form/components/widgets/base-viewer/base-viewer.widget.spec.ts b/lib/core/src/lib/form/components/widgets/base-viewer/base-viewer.widget.spec.ts index 8c31170feca..185bf3419a5 100644 --- a/lib/core/src/lib/form/components/widgets/base-viewer/base-viewer.widget.spec.ts +++ b/lib/core/src/lib/form/components/widgets/base-viewer/base-viewer.widget.spec.ts @@ -68,6 +68,7 @@ describe('BaseViewerWidgetComponent', () => { /** * Assert the field value + * * @param value field value * @param expectedFileId field id * @param fakeForm form model diff --git a/lib/core/src/lib/form/components/widgets/core/form-field.model.ts b/lib/core/src/lib/form/components/widgets/core/form-field.model.ts index 214956c5bda..ce82c5c67b3 100644 --- a/lib/core/src/lib/form/components/widgets/core/form-field.model.ts +++ b/lib/core/src/lib/form/components/widgets/core/form-field.model.ts @@ -536,6 +536,7 @@ export class FormFieldModel extends FormWidgetModel { /** * Check if the field type is invalid, requires a type to be a `container` + * * @param type field type * @returns `true` if type is a `container`, otherwise `false` */ diff --git a/lib/core/src/lib/form/components/widgets/core/form.model.ts b/lib/core/src/lib/form/components/widgets/core/form.model.ts index 2095bfaeb31..09bf385a5bd 100644 --- a/lib/core/src/lib/form/components/widgets/core/form.model.ts +++ b/lib/core/src/lib/form/components/widgets/core/form.model.ts @@ -169,6 +169,7 @@ export class FormModel implements ProcessFormModel { /** * Validates a specific form field, triggers form validation. + * * @param field Form field to validate. */ validateField(field: FormFieldModel): void { @@ -253,6 +254,7 @@ export class FormModel implements ProcessFormModel { /** * Returns a form variable that matches the identifier. + * * @param identifier The `name` or `id` value. * @returns form variable model */ @@ -266,6 +268,7 @@ export class FormModel implements ProcessFormModel { /** * Returns a value of the form variable that matches the identifier. * Provides additional conversion of types (date, boolean). + * * @param identifier The `name` or `id` value * @returns form variable value */ @@ -283,6 +286,7 @@ export class FormModel implements ProcessFormModel { * Returns a process variable value. * When mapping a process variable with a form variable the mapping * is already resolved by the rest API with the name of variables.formVariableName + * * @param name Variable name * @returns process variable value */ diff --git a/lib/core/src/lib/form/models/form-rules.model.ts b/lib/core/src/lib/form/models/form-rules.model.ts index f5b0ee1b803..f257bf7d95a 100644 --- a/lib/core/src/lib/form/models/form-rules.model.ts +++ b/lib/core/src/lib/form/models/form-rules.model.ts @@ -26,6 +26,7 @@ export const FORM_RULES_MANAGER = new InjectionToken>('for /** * A factory for forms rule manager + * * @param injector Angular injector * @returns FormsRuleManager instance */ diff --git a/lib/core/src/lib/form/services/form.service.ts b/lib/core/src/lib/form/services/form.service.ts index b9175aa30b3..5e4bf9c49f3 100644 --- a/lib/core/src/lib/form/services/form.service.ts +++ b/lib/core/src/lib/form/services/form.service.ts @@ -63,6 +63,7 @@ export class FormService implements FormValidationService { /** * Parses JSON data to create a corresponding Form model. + * * @param json JSON to create the form * @param data Values for the form fields * @param readOnly Should the form fields be read-only? diff --git a/lib/core/src/lib/login/components/login/login.component.ts b/lib/core/src/lib/login/components/login/login.component.ts index e55390c2cc5..abc844f002b 100644 --- a/lib/core/src/lib/login/components/login/login.component.ts +++ b/lib/core/src/lib/login/components/login/login.component.ts @@ -204,6 +204,7 @@ export class LoginComponent implements OnInit { /** * Method called on submit form + * * @param values login form values */ onSubmit(values: LoginFormValues): void { @@ -230,6 +231,7 @@ export class LoginComponent implements OnInit { /** * The method check the error in the form and push the error in the formError object + * * @param data form data */ onValueChanged(data: any) { @@ -282,6 +284,7 @@ export class LoginComponent implements OnInit { /** * Check and display the right error message in the UI + * * @param err error object */ private displayErrorMessage(err: any): void { @@ -298,6 +301,7 @@ export class LoginComponent implements OnInit { /** * Add a custom form error for a field + * * @param field field * @param msg error message */ @@ -307,6 +311,7 @@ export class LoginComponent implements OnInit { /** * Add a custom validation rule error for a field + * * @param field field * @param ruleId - i.e. required | minlength | maxlength * @param msg message @@ -323,6 +328,7 @@ export class LoginComponent implements OnInit { /** * Display and hide the password value. + * * @param event input event */ toggleShowPassword(event: Event) { @@ -332,6 +338,7 @@ export class LoginComponent implements OnInit { /** * The method return if a field is valid or not + * * @param field form field to check * @returns `true` if form field should display an error, otherwise `false` */ @@ -341,6 +348,7 @@ export class LoginComponent implements OnInit { /** * Trim username + * * @param event event */ trimUsername(event: any) { diff --git a/lib/core/src/lib/notifications/services/notification.service.ts b/lib/core/src/lib/notifications/services/notification.service.ts index 4e28134d007..783bf9e335d 100644 --- a/lib/core/src/lib/notifications/services/notification.service.ts +++ b/lib/core/src/lib/notifications/services/notification.service.ts @@ -38,6 +38,7 @@ export class NotificationService { /** * Opens a SnackBar notification to show a message. + * * @param message The message (or resource key) to show. * @param config Time before notification disappears after being shown or MatSnackBarConfig object * @param interpolateArgs The interpolation parameters to add for the translation @@ -53,6 +54,7 @@ export class NotificationService { /** * Opens a SnackBar notification with a message and a response button. + * * @param message The message (or resource key) to show. * @param action Caption for the response button * @param config Time before notification disappears after being shown or MatSnackBarConfig object @@ -70,6 +72,7 @@ export class NotificationService { /** * Rase error message + * * @param message Text message or translation key for the message. * @param action Action name * @param interpolateArgs The interpolation parameters to add for the translation @@ -92,6 +95,7 @@ export class NotificationService { /** * Rase info message + * * @param message Text message or translation key for the message. * @param action Action name * @param interpolateArgs The interpolation parameters to add for the translation @@ -114,6 +118,7 @@ export class NotificationService { /** * Rase warning message + * * @param message Text message or translation key for the message. * @param action Action name * @param interpolateArgs The interpolation parameters to add for the translation @@ -143,6 +148,7 @@ export class NotificationService { /** * Push new notification to Notification History + * * @param notification - Notification model to be pushed. */ pushToNotificationHistory(notification: NotificationModel) { diff --git a/lib/core/src/lib/progress/progress.component.ts b/lib/core/src/lib/progress/progress.component.ts index 72504dfa2d2..4aee6821189 100644 --- a/lib/core/src/lib/progress/progress.component.ts +++ b/lib/core/src/lib/progress/progress.component.ts @@ -45,6 +45,7 @@ export class ProgressComponent { /** * The value of the progress bar or spinner. * Changes the mode to `determinate` if a value is provided. + * * @returns The progress value */ get value(): number | undefined { @@ -64,6 +65,7 @@ export class ProgressComponent { * * For progress spinner, the mode can be either `indeterminate` or `determinate`. * For progress bar, the mode can be either `determinate`, `indeterminate`, `buffer`, or `query`. + * * @returns The progress mode */ get mode(): ProgressMode { diff --git a/lib/core/src/lib/search-text/search-text-input.component.spec.ts b/lib/core/src/lib/search-text/search-text-input.component.spec.ts index 5118b58dfeb..0ff63642b93 100644 --- a/lib/core/src/lib/search-text/search-text-input.component.spec.ts +++ b/lib/core/src/lib/search-text/search-text-input.component.spec.ts @@ -182,6 +182,7 @@ describe('SearchTextInputComponent', () => { /** * Runs a test for ltr/rtl margin values + * * @param isLtr sets ltr or rtl value to test */ function testMarginValue(isLtr: boolean): void { @@ -202,6 +203,7 @@ describe('SearchTextInputComponent', () => { /** * Runs a test for ltr/rtl transform values + * * @param isLtr sets ltr or rtl value to test */ function testTransformValue(isLtr: boolean): void { diff --git a/lib/core/src/lib/services/startup-service-factory.ts b/lib/core/src/lib/services/startup-service-factory.ts index e1ff18dc20a..ad603654827 100644 --- a/lib/core/src/lib/services/startup-service-factory.ts +++ b/lib/core/src/lib/services/startup-service-factory.ts @@ -20,6 +20,7 @@ import { StorageService } from '../common/services/storage.service'; /** * Loads application config file + * * @param appConfigService configuration service * @param storageService storage service * @returns a factory to load application config diff --git a/lib/core/src/lib/translation/translation.service.ts b/lib/core/src/lib/translation/translation.service.ts index 8fd786badbf..509e08f2526 100644 --- a/lib/core/src/lib/translation/translation.service.ts +++ b/lib/core/src/lib/translation/translation.service.ts @@ -30,6 +30,7 @@ export interface TranslationProvider { /** * Generate translation provider + * * @param id Unique identifier * @param path Path to translation files * @returns Provider @@ -80,6 +81,7 @@ export class TranslationService { /** * Adds a new folder of translation source files. + * * @param name Name for the translation provider * @param path Path to the folder */ @@ -97,6 +99,7 @@ export class TranslationService { /** * Loads a translation file. + * * @param lang Language code for the language to load * @param fallback Language code to fall back to if the first one was unavailable */ @@ -116,6 +119,7 @@ export class TranslationService { /** * Triggers a notification callback when the translation language changes. + * * @param lang The new language code */ onTranslationChanged(lang: string): void { @@ -127,6 +131,7 @@ export class TranslationService { /** * Sets the target language for translations. + * * @param lang Code name for the language * @returns Translations available for the language */ @@ -137,6 +142,7 @@ export class TranslationService { /** * Gets the translation for the supplied key. + * * @param key Key to translate * @param interpolateParams String(s) to be interpolated into the main message * @returns Translated text @@ -147,6 +153,7 @@ export class TranslationService { /** * Directly returns the translation for the supplied key. + * * @param key Key to translate * @param interpolateParams String(s) to be interpolated into the main message * @returns Translated text diff --git a/lib/core/src/lib/viewer/components/pdf-viewer/pdf-viewer.component.ts b/lib/core/src/lib/viewer/components/pdf-viewer/pdf-viewer.component.ts index e3f9ea73003..11e2fc21de4 100644 --- a/lib/core/src/lib/viewer/components/pdf-viewer/pdf-viewer.component.ts +++ b/lib/core/src/lib/viewer/components/pdf-viewer/pdf-viewer.component.ts @@ -290,6 +290,7 @@ export class PdfViewerComponent implements OnChanges, OnDestroy { /** * Method to scale the page current support implementation + * * @param scaleMode - new scale mode */ scalePage(scaleMode: PdfScaleMode) { @@ -397,6 +398,7 @@ export class PdfViewerComponent implements OnChanges, OnDestroy { /** * Update all the pages with the newScale scale + * * @param newScale - new scale page */ setScaleUpdatePages(newScale: number) { @@ -412,6 +414,7 @@ export class PdfViewerComponent implements OnChanges, OnDestroy { /** * Check if the request scale of the page is the same for avoid useless re-rendering + * * @param oldScale - old scale page * @param newScale - new scale page * @returns `true` if the scale is the same, otherwise `false` @@ -422,6 +425,7 @@ export class PdfViewerComponent implements OnChanges, OnDestroy { /** * Check if is a land scape view + * * @param width target width * @param height target height * @returns `true` if the target is in the landscape mode, otherwise `false` @@ -450,6 +454,7 @@ export class PdfViewerComponent implements OnChanges, OnDestroy { /** * zoom in page pdf + * * @param ticks number of ticks to zoom */ zoomIn(ticks?: number): void { @@ -465,6 +470,7 @@ export class PdfViewerComponent implements OnChanges, OnDestroy { /** * zoom out page pdf + * * @param ticks number of ticks to scale */ zoomOut(ticks?: number): void { @@ -504,6 +510,7 @@ export class PdfViewerComponent implements OnChanges, OnDestroy { /** * load the page in input + * * @param page to load */ inputPage(page: string) { @@ -520,6 +527,7 @@ export class PdfViewerComponent implements OnChanges, OnDestroy { /** * Page Change Event + * * @param event event */ onPageChange(event: any) { @@ -562,6 +570,7 @@ export class PdfViewerComponent implements OnChanges, OnDestroy { /** * Keyboard Event Listener + * * @param event KeyboardEvent */ @HostListener('document:keydown', ['$event']) diff --git a/lib/core/src/lib/viewer/components/viewer-render/viewer-render.component.ts b/lib/core/src/lib/viewer/components/viewer-render/viewer-render.component.ts index a6a79db63ae..729900fea12 100644 --- a/lib/core/src/lib/viewer/components/viewer-render/viewer-render.component.ts +++ b/lib/core/src/lib/viewer/components/viewer-render/viewer-render.component.ts @@ -17,17 +17,7 @@ import { AppExtensionService, ExtensionsModule, ViewerExtensionRef } from '@alfresco/adf-extensions'; import { NgForOf, NgIf, NgSwitch, NgSwitchCase, NgSwitchDefault, NgTemplateOutlet } from '@angular/common'; -import { - Component, - EventEmitter, - Injector, - Input, - OnChanges, - OnInit, - Output, - TemplateRef, - ViewEncapsulation -} from '@angular/core'; +import { Component, EventEmitter, Injector, Input, OnChanges, OnInit, Output, TemplateRef, ViewEncapsulation } from '@angular/core'; import { MatDialog } from '@angular/material/dialog'; import { MatProgressSpinnerModule } from '@angular/material/progress-spinner'; import { TranslateModule } from '@ngx-translate/core'; @@ -151,6 +141,7 @@ export class ViewerRenderComponent implements OnChanges, OnInit { /** * Returns a list of the active Viewer content extensions. + * * @returns list of extension references */ get viewerExtensions(): ViewerExtensionRef[] { @@ -159,6 +150,7 @@ export class ViewerRenderComponent implements OnChanges, OnInit { /** * Provides a list of file extensions supported by external plugins. + * * @returns list of extensions */ get externalExtensions(): string[] { diff --git a/lib/core/src/lib/viewer/directives/viewer-extension.directive.ts b/lib/core/src/lib/viewer/directives/viewer-extension.directive.ts index 1a4376dd068..1bd480f1e50 100644 --- a/lib/core/src/lib/viewer/directives/viewer-extension.directive.ts +++ b/lib/core/src/lib/viewer/directives/viewer-extension.directive.ts @@ -54,6 +54,7 @@ export class ViewerExtensionDirective implements AfterContentInit { /** * Check if the current extension in the viewer is compatible with this extension checking against `supportedExtensions` + * * @param fileExtension file extension to check * @returns `true` if file extension is compatible, otherwise `false` */ diff --git a/lib/core/src/lib/viewer/services/rendering-queue.services.ts b/lib/core/src/lib/viewer/services/rendering-queue.services.ts index 257219d78e7..32f88a38659 100644 --- a/lib/core/src/lib/viewer/services/rendering-queue.services.ts +++ b/lib/core/src/lib/viewer/services/rendering-queue.services.ts @@ -44,6 +44,7 @@ export class RenderingQueueServices { /** * Set the instance of the PDF Viewer + * * @param pdfViewer viewer instance */ setViewer(pdfViewer): void { @@ -52,6 +53,7 @@ export class RenderingQueueServices { /** * Sets the instance of the PDF Thumbnail Viewer + * * @param pdfThumbnailViewer viewer instance */ setThumbnailViewer(pdfThumbnailViewer): void { @@ -60,6 +62,7 @@ export class RenderingQueueServices { /** * Check if the view has highest rendering priority + * * @param view view to render * @returns `true` if the view has higher priority, otherwise `false` */ @@ -137,6 +140,7 @@ export class RenderingQueueServices { /** * Checks if the view rendering is finished + * * @param view the View instance to check * @returns `true` if rendering is finished, otherwise `false` */ @@ -148,6 +152,7 @@ export class RenderingQueueServices { * Render a page or thumbnail view. This calls the appropriate function * based on the views state. If the view is already rendered it will return * false. + * * @param view View instance to render * @returns the rendered state of the view */ diff --git a/lib/core/src/lib/viewer/services/view-util.service.ts b/lib/core/src/lib/viewer/services/view-util.service.ts index 2fe560cdbce..c9ee939b689 100644 --- a/lib/core/src/lib/viewer/services/view-util.service.ts +++ b/lib/core/src/lib/viewer/services/view-util.service.ts @@ -40,6 +40,7 @@ export class ViewUtilService { /** * Returns a list of the active Viewer content extensions. + * * @returns list of extension references */ get viewerExtensions(): ViewerExtensionRef[] { @@ -48,6 +49,7 @@ export class ViewUtilService { /** * Provides a list of file extensions supported by external plugins. + * * @returns list of extensions */ get externalExtensions(): string[] { @@ -58,6 +60,7 @@ export class ViewUtilService { /** * get File name from url + * * @param url - url file * @returns file name portion of the url */ @@ -73,6 +76,7 @@ export class ViewUtilService { * Supports the URL formats like: * http://localhost/test.jpg?cache=1000 * http://localhost/test.jpg#cache=1000 + * * @param fileName - file name * @returns file extension */ diff --git a/lib/process-services-cloud/src/lib/app/components/app-list-cloud/app-list-cloud.component.ts b/lib/process-services-cloud/src/lib/app/components/app-list-cloud/app-list-cloud.component.ts index e0bdcf18676..2f72c39b1fc 100644 --- a/lib/process-services-cloud/src/lib/app/components/app-list-cloud/app-list-cloud.component.ts +++ b/lib/process-services-cloud/src/lib/app/components/app-list-cloud/app-list-cloud.component.ts @@ -96,6 +96,7 @@ export class AppListCloudComponent implements OnInit, AfterContentInit { /** * Check if the value of the layoutType property is an allowed value + * * @returns `true` if layout type is valid, otherwise `false` */ isValidType(): boolean { @@ -114,6 +115,7 @@ export class AppListCloudComponent implements OnInit, AfterContentInit { /** * Check if the layout type is LIST + * * @returns `true` if the layout is list, otherwise `false` */ isList(): boolean { @@ -122,6 +124,7 @@ export class AppListCloudComponent implements OnInit, AfterContentInit { /** * Check if the layout type is GRID + * * @returns `true` if layout is grid, otherwise `false` */ isGrid(): boolean { diff --git a/lib/process-services-cloud/src/lib/app/services/apps-process-cloud.service.ts b/lib/process-services-cloud/src/lib/app/services/apps-process-cloud.service.ts index 8564795ddf8..06f636dee79 100644 --- a/lib/process-services-cloud/src/lib/app/services/apps-process-cloud.service.ts +++ b/lib/process-services-cloud/src/lib/app/services/apps-process-cloud.service.ts @@ -34,6 +34,7 @@ export class AppsProcessCloudService { /** * Gets a list of deployed apps for this user by status. + * * @param status Required status value * @param roles to filter the apps * @returns The list of deployed apps diff --git a/lib/process-services-cloud/src/lib/form/components/form-cloud-custom-outcomes.component.ts b/lib/process-services-cloud/src/lib/form/components/form-cloud-custom-outcomes.component.ts index a01e18b9b98..c2e86c761a6 100644 --- a/lib/process-services-cloud/src/lib/form/components/form-cloud-custom-outcomes.component.ts +++ b/lib/process-services-cloud/src/lib/form/components/form-cloud-custom-outcomes.component.ts @@ -20,6 +20,6 @@ import { Component } from '@angular/core'; @Component({ selector: 'adf-cloud-form-custom-outcomes', standalone: true, - template: '' + template: '' }) export class FormCustomOutcomesComponent {} diff --git a/lib/process-services-cloud/src/lib/form/components/form-cloud.component.html b/lib/process-services-cloud/src/lib/form/components/form-cloud.component.html index 8b3a76d0e47..9dc7ed70a1f 100644 --- a/lib/process-services-cloud/src/lib/form/components/form-cloud.component.html +++ b/lib/process-services-cloud/src/lib/form/components/form-cloud.component.html @@ -1,6 +1,5 @@
    - - +
    - +