[ADF-4249] Updates for doc review (#4454)

* [ADF-4249] Updates for doc review

* [ADF-4249] Clarified text slightly

lib/content-services/search/search-query-builder.service.ts

@@ -403,6 +403,11 @@ export class SearchQueryBuilderService {
         return null;
     }
 
+    /**
+     * Encloses a label name with double quotes if it contains whitespace characters.
+     * @param configLabel Original label text
+     * @returns Label, possibly with quotes if it contains spaces
+     */
     getSupportedLabel(configLabel: string): string {
         const spaceInsideLabelIndex = configLabel.search(/\s/g);
         if (spaceInsideLabelIndex > -1) {

lib/core/about/about.component.ts

@@ -39,8 +39,14 @@ export class AboutComponent implements OnInit {
     modules: ObjectDataTableAdapter;
     extensionColumns: string[] = ['$id', '$name', '$version', '$vendor', '$license', '$runtime', '$description'];
     extensions$: Observable<ExtensionRef[]>;
+
+    /** Commit corresponding to the version of ADF to be used. */
     @Input() githubUrlCommitAlpha = 'https://github.com/Alfresco/alfresco-ng2-components/commits/';
+ 
+    /** Toggles showing/hiding of extensions block. */
     @Input() showExtensions = true;
+ 
+    /** Regular expression for filtering dependencies packages. */
     @Input() regexp = '^(@alfresco)';
 
     ecmHost = '';

lib/core/services/authentication.service.ts

@@ -316,7 +316,8 @@ export class AuthenticationService {
     }
 
     /**
-     * Check if SSO is configured correctly
+     * Checks if SSO is configured correctly.
+     * @returns True if configured correctly, false otherwise
      */
     isSSODiscoveryConfigured() {
         return this.alfrescoApi.getInstance().storage.getItem('discovery') ? true : false;

lib/core/services/content.service.ts

@@ -175,7 +175,7 @@ export class ContentService {
     /**
      * Checks if the user has permission on that node
      * @param node Node to check permissions
-     * @param permission
+     * @param permission Required permission type
      * @returns True if the user has the required permissions, false otherwise
      */
     hasPermissions(node: Node, permission: PermissionsEnum | string): boolean {
@@ -205,7 +205,7 @@ export class ContentService {
     /**
      * Checks if the user has permissions on that node
      * @param node Node to check allowableOperations
-     * @param permission Create, delete, update, updatePermissions, !create, !delete, !update, !updatePermissions
+     * @param allowableOperation Create, delete, update, updatePermissions, !create, !delete, !update, !updatePermissions
      * @returns True if the user has the required permissions, false otherwise
      */
     hasAllowableOperations(node: Node, allowableOperation: AllowableOperationsEnum | string): boolean {

lib/extensions/src/lib/services/extension.service.ts

@@ -80,6 +80,11 @@ export class ExtensionService {
         this.features = this.loader.getFeatures(config);
     }
 
+    /**
+     * Gets features by key.
+     * @param key Key string, using dot notation
+     * @returns Features array found by key
+     */
     getFeature(key: string): any[] {
         let properties: string[] = Array.isArray(key) ? [key] : key.split('.');
         return properties.reduce((prev, curr) => prev && prev[curr], this.features) || [];