[ADF-1769] Added JSDocs and prop tables (#2913)

lib/content-services/upload/components/upload-button.component.ts

@@ -53,42 +53,59 @@ import 'rxjs/add/observable/throw';
 })
 export class UploadButtonComponent implements OnInit, OnChanges, NodePermissionSubject {
 
+    /** Toggles component disabled state (if there is no node permission checking). */
     @Input()
     disabled: boolean = false;
 
+    /** Allows/disallows upload folders (only for Chrome). */
     @Input()
     uploadFolders: boolean = false;
 
+    /** Allows/disallows multiple files */
     @Input()
     multipleFiles: boolean = false;
 
+    /** Toggles versioning. */
     @Input()
     versioning: boolean = false;
 
+    /** List of allowed file extensions, for example: ".jpg,.gif,.png,.svg". */
     @Input()
     acceptedFilesType: string = '*';
 
+    /** Sets a limit on the maximum size (in bytes) of a file to be uploaded.
+     * Has no effect if undefined.
+     */
     @Input()
     maxFilesSize: number;
 
+    /** Defines the text of the upload button. */
     @Input()
     staticTitle: string;
 
+    /** Custom tooltip text. */
     @Input()
     tooltip: string = null;
 
+    /** The ID of the root. Use the nodeId for
+     * Content Services or the taskId/processId for Process Services.
+     */
     @Input()
     rootFolderId: string = '-root-';
 
+    /** Emitted when the file is uploaded successfully. */
     @Output()
     success = new EventEmitter();
 
+    /** Emitted when an error occurs. */
     @Output()
     error = new EventEmitter();
 
+    /** Emitted when a folder is created. */
     @Output()
     createFolder = new EventEmitter();
 
+    /** Emitted when delete permission is missing. */
     @Output()
     permissionEvent: EventEmitter<PermissionModel> = new EventEmitter<PermissionModel>();
 

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

@@ -38,15 +38,21 @@ import { Component, EventEmitter, forwardRef, Input, Output, ViewEncapsulation }
 })
 export class UploadDragAreaComponent implements NodePermissionSubject {
 
+    /** Toggle component disabled state. */
     @Input()
     disabled: boolean = false;
 
+    /** When false, renames the file using an integer suffix if there is a name clash.
+     * Set to true to indicate that a major version should be created instead.
+     */
     @Input()
     versioning: boolean = false;
 
+    /** ID of parent folder node. */
     @Input()
     parentId: string;
 
+    /** Emitted when the file is uploaded. */
     @Output()
     success = new EventEmitter();
 

lib/content-services/version-manager/version-list.component.ts

@@ -34,6 +34,7 @@ export class VersionListComponent implements OnChanges {
     versions: any = [];
     isLoading: boolean = true;
 
+    /** ID of the node whose version history you want to display. */
     @Input()
     id: string;
 

lib/content-services/version-manager/version-manager.component.ts

@@ -26,6 +26,7 @@ import { MinimalNodeEntryEntity } from 'alfresco-js-api';
 })
 export class VersionManagerComponent {
 
+    /** The node whose version history you want to manage. */
     @Input()
     node: MinimalNodeEntryEntity;
 }

lib/content-services/webscript/webscript.component.ts

@@ -46,24 +46,36 @@ import { Component, EventEmitter, Input, OnChanges, Output } from '@angular/core
 })
 export class WebscriptComponent implements OnChanges {
 
+    /** (required) Path to the webscript (as defined by webscript). */
     @Input()
     scriptPath: string;
 
+    /** Arguments to pass to the webscript. */
     @Input()
     scriptArgs: any;
 
+    /** Toggles whether to show or hide the data. */
     @Input()
     showData: boolean = true;
 
+    /** Path where the application is deployed */
     @Input()
     contextRoot: string = 'alfresco';
 
+    /** Path that the webscript service is mapped to. */
     @Input()
     servicePath: string = 'service';
 
+    /** Content type to interpret the data received from the webscript.
+     * Can be "JSON" , "HTML" , "DATATABLE" or "TEXT"
+     */
     @Input()
     contentType: string = 'TEXT';
 
+    /** Emitted when the operation succeeds. You can get the plain data from
+     * the webscript through the **success** event parameter and use it as you
+     * need in your application.
+     */
     @Output()
     success = new EventEmitter();