[ADF-3551] Doc review updates (#3789)

* [ADF-3551] Updated docs plus minor ToC tool fix

* [ADF-3551] Updated docs and JSDocs

* [ADF-3551] Updated docs and JSDocs

lib/core/app-config/app-config.service.ts

@@ -94,6 +94,7 @@ export class AppConfigService {
 
     /**
      * Gets the location.protocol value.
+     * @returns The location.protocol string
      */
     getLocationProtocol(): string {
         return location.protocol;

lib/core/datatable/components/datatable/datatable.component.ts

@@ -149,6 +149,10 @@ export class DataTableComponent implements AfterContentInit, OnChanges, DoCheck,
     @Input()
     noPermission: boolean = false;
 
+    /**
+     * Should the items for the row actions menu be cached for reuse after they are loaded
+     * the first time?
+     */
     @Input()
     rowMenuCacheEnabled = true;
 

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

@@ -28,8 +28,9 @@ export class NodeService {
     }
 
     /**
-     * Get All the metadata and the nodeType for a nodeId cleaned by the prefix
-     * @param nodeId Node Id
+     * Get the metadata and the nodeType for a nodeId cleaned by the prefix.
+     * @param nodeId ID of the target node
+     * @returns Node metadata
      */
     public getNodeMetadata(nodeId: string): Observable<NodeMetadata> {
         return from(this.apiService.getInstance().nodes.getNodeInfo(nodeId))
@@ -37,11 +38,13 @@ export class NodeService {
     }
 
     /**
-     * Create a new Node from form metadata
-     * @param path path
-     * @param nodeType node type
-     * @param nameSpace namespace node
-     * @param data data to store
+     * Create a new Node from form metadata.
+     * @param path Path to the node
+     * @param nodeType Node type
+     * @param name Node name
+     * @param nameSpace Namespace for properties
+     * @param data Property data to store in the node under namespace
+     * @returns The created node
      */
     public createNodeMetadata(nodeType: string, nameSpace: any, data: any, path: string, name?: string): Observable<any> {
         let properties = {};
@@ -56,10 +59,11 @@ export class NodeService {
 
     /**
      * Create a new Node from form metadata
-     * @param name path
-     * @param nodeType node type
-     * @param properties namespace node
-     * @param path path
+     * @param name Node name
+     * @param nodeType Node type
+     * @param properties Node body properties
+     * @param path Path to the node
+     * @returns The created node
      */
     public createNode(name: string, nodeType: string, properties: any, path: string): Observable<any> {
         let body = {

lib/core/interface/search-configuration.interface.ts

@@ -19,6 +19,13 @@ import { QueryBody } from 'alfresco-js-api';
 
 export interface SearchConfigurationInterface {
 
+    /**
+     * Generates a QueryBody object with custom search parameters.
+     * @param searchTerm Term text to search for
+     * @param maxResults Maximum number of search results to show in a page
+     * @param skipCount The offset of the start of the page within the results list
+     * @returns Query body defined by the parameters
+     */
     generateQueryBody(searchTerm: string, maxResults: number, skipCount: number): QueryBody;
 
 }

lib/core/login/components/login.component.ts

@@ -86,8 +86,9 @@ export class LoginComponent implements OnInit {
     @Input()
     copyrightText: string = '\u00A9 2016 Alfresco Software, Inc. All Rights Reserved.';
 
-    /** @deprecated 3.0.0 Possible valid values are ECM, BPM or ALL.
-     * deprecated in 3.0.0 use the providers property in the the app.config.json
+    /**
+     * Possible valid values are ECM, BPM or ALL.
+     * @deprecated 3.0.0 - use the providers property in the the app.config.json
      */
     @Input()
     providers: string;
@@ -96,7 +97,10 @@ export class LoginComponent implements OnInit {
     @Input()
     fieldsValidation: any;
 
-    /** @depreated 3.0.0 Prevents the CSRF Token from being submitted. Only valid for Alfresco Process Services. */
+    /**
+     * Prevents the CSRF Token from being submitted. Only valid for Alfresco Process Services.
+     * @deprecated 3.0.0
+     */
     @Input()
     disableCsrf: boolean;
 

lib/core/services/authentication.service.ts

@@ -53,18 +53,34 @@ export class AuthenticationService {
             return this.alfrescoApi.getInstance().isLoggedIn();
     }
 
+    /**
+     * Does the provider support OAuth?
+     * @returns True if supported, false otherwise
+     */
     isOauth(): boolean {
         return this.alfrescoApi.getInstance().isOauthConfiguration();
     }
 
+    /**
+     * Does the provider support ECM?
+     * @returns True if supported, false otherwise
+     */
     isECMProvider(): boolean {
         return this.alfrescoApi.getInstance().isEcmConfiguration();
     }
 
+    /**
+     * Does the provider support BPM?
+     * @returns True if supported, false otherwise
+     */
     isBPMProvider(): boolean {
         return this.alfrescoApi.getInstance().isBpmConfiguration();
     }
 
+    /**
+     * Does the provider support both ECM and BPM?
+     * @returns True if both are supported, false otherwise
+     */
     isALLProvider(): boolean {
         return this.alfrescoApi.getInstance().isEcmBpmConfiguration();
     }
@@ -137,9 +153,6 @@ export class AuthenticationService {
             );
     }
 
-    /**
-     *
-     */
     private callApiLogout(): Promise<any> {
         if (this.alfrescoApi.getInstance()) {
             return this.alfrescoApi.getInstance().logout();
@@ -233,6 +246,10 @@ export class AuthenticationService {
         return this.hasValidRedirection(provider) ? this.redirectUrl.url : null;
     }
 
+    /**
+     * Gets information about the user currently logged into APS.
+     * @returns User information
+     */
     getBpmLoggedUser(): Observable<UserRepresentation> {
         return from(this.alfrescoApi.getInstance().activiti.profileApi.getProfile());
     }

lib/core/services/search-configuration.service.ts

@@ -25,6 +25,13 @@ export class SearchConfigurationService implements SearchConfigurationInterface
     constructor() {
     }
 
+    /**
+     * Generates a QueryBody object with custom search parameters.
+     * @param searchTerm Term text to search for
+     * @param maxResults Maximum number of search results to show in a page
+     * @param skipCount The offset of the start of the page within the results list
+     * @returns Query body defined by the parameters
+     */
     public generateQueryBody(searchTerm: string, maxResults: number, skipCount: number): QueryBody {
         let defaultQueryBody: QueryBody = {
             query: {

lib/core/settings/host-settings.component.ts

@@ -35,6 +35,10 @@ export class HostSettingsComponent implements OnInit {
 
     HOST_REGEX: string = '^(http|https):\/\/.*[^/]$';
 
+    /**
+     * Tells the component which provider options are available. Possible valid values
+     * are "ECM" (Content), "BPM" (Process) , "ALL" (Content and Process), 'OAUTH2' SSO.
+     */
     @Input()
     providers: string[] = ['BPM', 'ECM', 'ALL'];
 
@@ -52,9 +56,11 @@ export class HostSettingsComponent implements OnInit {
     @Output()
     ecmHostChange = new EventEmitter<string>();
 
+    /** Emitted when the user cancels the changes. */
     @Output()
     cancel = new EventEmitter<boolean>();
 
+    /** Emitted when the changes are successfully applied. */
     @Output()
     success = new EventEmitter<boolean>();
 

lib/core/templates/empty-content/empty-content.component.ts

@@ -27,12 +27,15 @@ import { Component, ChangeDetectionStrategy, ViewEncapsulation, Input } from '@a
 })
 export class EmptyContentComponent {
 
+    /** Material Icon to use. */
     @Input()
     icon = 'cake';
 
+    /** String or Resource Key for the title. */
     @Input()
     title = '';
 
+    /** String or Resource Key for the subtitle. */
     @Input()
     subtitle = '';
 

lib/core/templates/error-content/error-content.component.ts

@@ -36,12 +36,15 @@ import { TranslationService } from '../../services/translation.service';
 })
 export class ErrorContentComponent implements OnInit, AfterContentChecked {
 
+    /** Target URL for the secondary button. */
     @Input()
     secondaryButtonUrl: string = 'report-issue';
 
+    /** Target URL for the return button. */
     @Input()
     returnButtonUrl: string = '/';
 
+    /** Error code associated with this error. */
     @Input()
     errorCode: string;