[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

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

View File

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

View File

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

View File

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

View File

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

View File

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