[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
This commit is contained in:
Andy Stark
2018-09-25 21:45:16 +01:00
committed by Eugenio Romano
parent 95a91c670d
commit 431bde3ddf
27 changed files with 105 additions and 60 deletions

View File

@@ -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;

View File

@@ -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

View File

@@ -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();

View File

@@ -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 {

View File

@@ -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();