[ADF-3587] Fixed doc comment problems (#3822)

* [ADF-3587] Fixed missing docs for accessor properties

* [ADF-3587] Fixed badly formed doc comments with deprecated tag

* [ADF-3587] Fixed linting issue with doc comment

lib/content-services/document-list/components/document-list.component.ts

@@ -166,8 +166,10 @@ export class DocumentListComponent implements OnInit, OnChanges, OnDestroy, Afte
     @Input()
     currentFolderId: string = null;
 
-    /** @deprecated 2.3.0 use currentFolderId or node */
-    /** Currently displayed folder node */
+    /**
+     * Currently displayed folder node
+     * @deprecated 2.3.0 - use currentFolderId or node
+     */
     @Input()
     folderNode: MinimalNodeEntryEntity = null;
 
@@ -179,13 +181,17 @@ export class DocumentListComponent implements OnInit, OnChanges, OnDestroy, Afte
     @Input()
     maxItems: number;
 
-    /** @deprecated 2.3.0 define it in pagination */
-    /** Number of elements to skip over for pagination purposes */
+    /**
+     * Number of elements to skip over for pagination purposes
+     * @deprecated 2.3.0 - define it in pagination
+     */
     @Input()
     skipCount: number = 0;
 
-    /** @deprecated 2.3.0 */
-    /** Set document list to work in infinite scrolling mode */
+    /**
+     * Set document list to work in infinite scrolling mode
+     * @deprecated 2.3.0
+     */
     @Input()
     enableInfiniteScrolling: boolean = false;
 

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

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

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

@@ -63,8 +63,10 @@ export abstract class UploadBase implements OnInit, OnDestroy {
     @Output()
     success = new EventEmitter();
 
-    /** @deprecated 2.4.0 No longer used by the framework */
-    /** Emitted when a folder is created. */
+    /**
+     * Emitted when a folder is created.
+     * @deprecated 2.4.0 No longer used by the framework
+     */
     @Output()
     createFolder = new EventEmitter();
 

lib/content-services/upload/components/upload-drag-area.component.ts

@@ -34,7 +34,10 @@ import { UploadBase } from './base-upload/upload-base';
 })
 export class UploadDragAreaComponent extends UploadBase implements NodePermissionSubject {
 
-    /** @deprecated 2.4.0  use rootFolderId ID of parent folder node. */
+    /**
+     * ID of parent folder node
+     * @deprecated 2.4.0 - use rootFolderId ID of parent folder node
+     */
     @Input()
     set parentId(nodeId: string) {
         this.rootFolderId = nodeId;
@@ -60,9 +63,8 @@ export class UploadDragAreaComponent extends UploadBase implements NodePermissio
     }
 
     /**
+     * Called when the file are dropped in the drag area.
      * @deprecated in 2.4.0: use `onFilesDropped` instead
-     * Called when the file are dropped in the drag area
-     *
      * @param item - FileEntity
      */
     onFilesEntityDropped(item: any): void {

lib/content-services/upload/directives/file-draggable.directive.ts

@@ -35,8 +35,9 @@ export class FileDraggableDirective implements OnInit, OnDestroy {
     @Output()
     filesDropped: EventEmitter<File[]> = new EventEmitter<File[]>();
 
-    /** @deprecated in 2.4.0: use `filesDropped` instead.
+    /**
      * Emitted when one or more files are dragged and dropped onto the draggable element.
+     * @deprecated in 2.4.0: use `filesDropped` instead
      */
     @Output()
     filesEntityDropped: EventEmitter<any> = new EventEmitter();

lib/core/directives/node-restore.directive.ts

@@ -40,7 +40,10 @@ export class NodeRestoreDirective {
     @Input('adf-restore')
     selection: DeletedNodeEntry[];
 
-    /** @deprecated 2.4.0 Path to restored node. */
+    /**
+     * Path to restored node.
+     * @deprecated 2.4.0
+     */
     @Input()
     location: string = '';
 

lib/core/form/components/form.component.ts

@@ -156,8 +156,10 @@ export class FormComponent implements OnInit, OnChanges, OnDestroy {
     @Output()
     executeOutcome: EventEmitter<FormOutcomeEvent> = new EventEmitter<FormOutcomeEvent>();
 
-    /** @deprecated in 2.4.0, will be renamed in error in 3.x.x */
-    /** Emitted when any error occurs. */
+    /**
+     * Emitted when any error occurs.
+     * @deprecated in 2.4.0, will be renamed as "error" in 3.x.x
+     */
     @Output()
     onError: EventEmitter<any> = new EventEmitter<any>();
 

lib/core/form/components/widgets/widget.component.ts

@@ -55,7 +55,10 @@ export class WidgetComponent implements AfterViewInit {
     @Input()
     field: FormFieldModel;
 
-    /** @deprecated Used only to trigger visibility engine; components should do that internally if needed */
+    /**
+     * Emitted when a field value changes.
+     * @deprecated Used only to trigger visibility engine; components should do that internally if needed.
+     */
     @Output()
     fieldChanged: EventEmitter<FormFieldModel> = new EventEmitter<FormFieldModel>();
 

lib/core/form/services/form.service.ts

@@ -164,8 +164,8 @@ export class FormService {
     }
 
     /**
+     * Add Fields to a form
      * @deprecated in 1.7.0, use saveForm API instead
-     * Add Fields to A form
      * @param formId ID of the form
      * @param formModel Form definition
      */

lib/core/pagination/infinite-pagination.component.ts

@@ -47,7 +47,10 @@ export class InfinitePaginationComponent implements OnInit, OnDestroy, Paginatio
         merge: true
     };
 
-    /**  @deprecated 2.3.0  Pagination object. */
+    /**
+     * Pagination object.
+     * @deprecated 2.3.0
+     */
     @Input()
     pagination: PaginationModel;
 

lib/core/viewer/components/viewer.component.ts

@@ -69,8 +69,10 @@ export class ViewerComponent implements OnChanges, OnInit, OnDestroy {
     @Input()
     blobFile: Blob;
 
-    /** @deprecated 2.4.0 use nodeId */
-    /** Node Id of the file to load. */
+    /**
+     * Node Id of the file to load.
+     * @deprecated 2.4.0 use nodeId
+     */
     @Input()
     set fileNodeId(nodeId: string) {
         this.nodeId = nodeId;
@@ -114,8 +116,10 @@ export class ViewerComponent implements OnChanges, OnInit, OnDestroy {
     @Input()
     allowPrint = false;
 
-    /**  @deprecated 2.5.0 inkect the share button directive as custom button */
-    /** Toggles sharing. */
+    /**
+     * Toggles sharing.
+     * @deprecated 2.5.0 - inject the share button directive as custom button
+     */
     @Input()
     allowShare = false;
 
@@ -145,8 +149,10 @@ export class ViewerComponent implements OnChanges, OnInit, OnDestroy {
     @Input()
     allowThumbnails = true;
 
-    /** @deprecated 2.5.0 will be renamed showRightSidebar in 3.0.0  */
-    /** Toggles sidebar visibility. Requires `allowSidebar` to be set to `true`. */
+    /**
+     * Toggles sidebar visibility. Requires `allowSidebar` to be set to `true`.
+     * @deprecated 2.5.0 - will be renamed showRightSidebar in 3.0.0
+     */
     @Input()
     showSidebar = false;
 
@@ -154,13 +160,17 @@ export class ViewerComponent implements OnChanges, OnInit, OnDestroy {
     @Input()
     showLeftSidebar = false;
 
-    /** @deprecated 2.5.0 use sidebarTemplateLeft */
-    /** The position of the sidebar. Can be `left` or `right`. */
+    /**
+     * The position of the sidebar. Can be `left` or `right`.
+     * @deprecated 2.5.0 use sidebarTemplateLeft
+     */
     @Input()
     sidebarPosition = 'right';
 
-    /**  @deprecated 2.5.0 rename sidebarRight */
-    /** The template for the sidebar. The template context contains the loaded node data. */
+    /**
+     * The template for the sidebar. The template context contains the loaded node data.
+     * @deprecated 2.5.0 renamed as sidebarRight
+     */
     @Input()
     sidebarTemplate: TemplateRef<any> = null;
 

lib/process-services/task-list/components/task-list.component.ts

@@ -55,7 +55,8 @@ export class TaskListComponent extends DataTableSchema implements OnChanges, Aft
     @Input()
     processDefinitionId: string;
 
-    /** The Definition Key of the process.
+    /**
+     * The Definition Key of the process.
      * @deprecated 2.4.0
      */
     @Input()
@@ -89,7 +90,8 @@ export class TaskListComponent extends DataTableSchema implements OnChanges, Aft
     @Input()
     landingTaskId: string;
 
-    /** Data source object that represents the number and the type of the columns that
+    /**
+     * Data source object that represents the number and the type of the columns that
      * you want to show.
      * @deprecated 2.4.0
      */