[ADF-3551] Updates for doc review (#3784)

* [ADF-3551] Updated doc comments

* [ADF-3551] Updated doc comments

* [ADF-3551] Doc files updated with new doc comments

lib/content-services/document-list/services/custom-resources.service.ts

@@ -261,6 +261,11 @@ export class CustomResourcesService {
         return isCustomSources;
     }
 
+    /**
+     * 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 suppored sources, false otherwise
+     */
     isSupportedSource(folderId: string): boolean {
         let isSupportedSources = false;
         const sources = ['-my-', '-root-', '-shared-'];
@@ -330,6 +335,11 @@ export class CustomResourcesService {
         return of([]);
     }
 
+    /**
+     * 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
+     */
     hasCorrespondingNodeIds(nodeId: string): boolean {
         return this.isCustomSource(nodeId) || this.isSupportedSource(nodeId);
     }

lib/content-services/document-list/services/document-list.service.ts

@@ -150,8 +150,7 @@ export class DocumentListService {
     }
 
     /**
-     * @deprecated 2.3.0
-     * Gets a folder node via its node ID.
+     * @deprecated 2.3.0. 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
@@ -195,8 +194,7 @@ export class DocumentListService {
     }
 
     /**
-     * @Deprecated 2.3.0 use the one in the content service
-     * Checks if a node has the specified permission.
+     * @Deprecated 2.3.0 - use the equivalent in the content service. Checks if a node has the specified permission.
      * @param node Target node
      * @param permission Permission level to query
      * @returns True if the node has the permission, false otherwise

lib/content-services/permission-manager/components/inherited-button.directive.ts

@@ -29,12 +29,15 @@ import { MinimalNodeEntryEntity } from 'alfresco-js-api';
 })
 export class InheritPermissionDirective {
 
+    /** ID of the node to add/remove inherited permissions. */
     @Input()
     nodeId: string;
 
+    /** Emitted when the node is updated. */
     @Output()
     updated: EventEmitter<MinimalNodeEntryEntity> = new EventEmitter<MinimalNodeEntryEntity>();
 
+    /** Emitted when an error occurs. */
     @Output()
     error: EventEmitter<any> = new EventEmitter<any>();
 

lib/content-services/permission-manager/components/permission-list/permission-list.component.ts

@@ -37,6 +37,7 @@ export class PermissionListComponent implements OnInit {
     @Output()
     update: EventEmitter<PermissionElement> = new EventEmitter();
 
+    /** Emitted when an error occurs. */
     @Output()
     error: EventEmitter<any> = new EventEmitter();
 

lib/content-services/permission-manager/services/node-permission-dialog.service.ts

@@ -35,7 +35,7 @@ export class NodePermissionDialogService {
 
     /**
      * Opens a dialog to add permissions to a node.
-     * @param nodeId ID of the target node
+     * @param node ID of the target node
      * @param title Dialog title
      * @returns Node with updated permissions
      */

lib/content-services/search/components/search-radio/search-radio.component.ts

@@ -37,6 +37,7 @@ export interface SearchRadioOption {
 })
 export class SearchRadioComponent implements SearchWidget, OnInit {
 
+    /** The value of the selected radio button. */
     @Input()
     value: string;
 

lib/content-services/search/components/search-slider/search-slider.component.ts

@@ -38,6 +38,7 @@ export class SearchSliderComponent implements SearchWidget, OnInit {
     max: number;
     thumbLabel = false;
 
+    /** The numeric value represented by the slider. */
     @Input()
     value: number | null;
 

lib/content-services/search/components/search-text/search-text.component.ts

@@ -29,6 +29,7 @@ import { SearchQueryBuilderService } from '../../search-query-builder.service';
 })
 export class SearchTextComponent implements SearchWidget, OnInit {
 
+    /** The content of the text box. */
     @Input()
     value = '';
 

lib/content-services/tag/services/tag.service.ts

@@ -45,6 +45,7 @@ export class TagService {
 
     /**
      * Gets a list of all the tags already defined in the repository.
+     * @param opts Options supported by JSAPI
      * @returns TagPaging object (defined in JSAPI) containing the tags
      */
     getAllTheTags(opts?: any): Observable<TagPaging> {

lib/content-services/upload/components/base-upload/upload-base.ts

@@ -72,6 +72,7 @@ export abstract class UploadBase implements OnInit, OnDestroy {
     @Output()
     error = new EventEmitter();
 
+    /** Emitted when the upload begins. */
     @Output()
     beginUpload = new EventEmitter<UploadFilesEvent>();