Generate docs (#8481)

* Generate docs

* Fix duplicated Optional and restore code block ticks

* Fix docbuild command errors, improve documentations

---------

Co-authored-by: Amedeo Lepore <amedeo.lepore85@gmail.com>
Co-authored-by: Amedeo Lepore <amedeo.lepore@hyland.com>

lib/content-services/src/lib/audit/audit.service.ts

@@ -43,6 +43,11 @@ export class AuditService {
     constructor(private apiService: AlfrescoApiService, private logService: LogService) {
     }
 
+    /**
+     * Gets a list of audit applications.
+     * @param opts Options.
+     * @returns a list of the audit applications.
+     */
     getAuditApps(opts?: any): Observable<AuditAppPaging> {
         const defaultOptions = {
             skipCount: 0
@@ -54,6 +59,12 @@ export class AuditService {
             );
     }
 
+    /**
+     * Get audit application info.
+     * @param auditApplicationId The identifier of an audit application.
+     * @param opts Options.
+     * @returns status of an audit application.
+     */
     getAuditApp(auditApplicationId: string, opts?: any): Observable<AuditAppEntry> {
         const defaultOptions = {
             auditApplicationId
@@ -65,6 +76,13 @@ export class AuditService {
             );
     }
 
+    /**
+     * Update audit application info.
+     * @param auditApplicationId The identifier of an audit application.
+     * @param auditAppBodyUpdate The audit application to update.
+     * @param opts Options.
+     * @returns
+     */
     updateAuditApp(auditApplicationId: string, auditAppBodyUpdate: boolean, opts?: any): Observable<AuditApp | any> {
         const defaultOptions = {};
         const queryOptions = Object.assign({}, defaultOptions, opts);
@@ -74,6 +92,12 @@ export class AuditService {
             );
     }
 
+    /**
+     * List audit entries for an audit application.
+     * @param auditApplicationId The identifier of an audit application.
+     * @param opts Options.
+     * @returns a list of audit entries.
+     */
     getAuditEntries(auditApplicationId: string, opts?: any): Observable<AuditEntryPaging> {
         const defaultOptions = {
             skipCount: 0,
@@ -86,6 +110,13 @@ export class AuditService {
             );
     }
 
+    /**
+     * Get audit entry.
+     * @param auditApplicationId The identifier of an audit application.
+     * @param auditEntryId The identifier of an audit entry.
+     * @param opts Options.
+     * @returns audit entry.
+     */
     getAuditEntry(auditApplicationId: string, auditEntryId: string, opts?: any): Observable<AuditEntryEntry> {
         const defaultOptions = {};
         const queryOptions = Object.assign({}, defaultOptions, opts);
@@ -95,6 +126,12 @@ export class AuditService {
             );
     }
 
+    /**
+     * List audit entries for a node.
+     * @param nodeId The identifier of a node.
+     * @param opts Options.
+     * @returns
+     */
     getAuditEntriesForNode(nodeId: string, opts?: any): Observable<AuditEntryPaging> {
         const defaultOptions = {
             nodeId
@@ -106,6 +143,12 @@ export class AuditService {
             );
     }
 
+    /**
+     * Permanently delete audit entries for an audit application.
+     * @param auditApplicationId The identifier of an audit application.
+     * @param where Audit entries to permanently delete for an audit application, given an inclusive time period or range of ids.
+     * @returns
+     */
     deleteAuditEntries(auditApplicationId: string, where: string): Observable<any> {
         return from(this.auditApi.deleteAuditEntriesForAuditApp(auditApplicationId, where))
             .pipe(
@@ -113,6 +156,12 @@ export class AuditService {
             );
     }
 
+    /**
+     * Permanently delete an audit entry.
+     * @param auditApplicationId The identifier of an audit application.
+     * @param auditEntryId The identifier of an audit entry.
+     * @returns
+     */
     deleteAuditEntry(auditApplicationId: string, auditEntryId: string): Observable<any> {
         return from(this.auditApi.deleteAuditEntry(auditApplicationId, auditEntryId))
             .pipe(

lib/content-services/src/lib/content-user-info/content-user-info.component.ts

@@ -32,15 +32,19 @@ export class ContentUserInfoComponent implements OnDestroy {
 
     @ViewChild(MatMenuTrigger) trigger: MatMenuTrigger;
 
+    /** Determines if user is logged in. */
     @Input()
     isLoggedIn: boolean;
 
+    /** ECM user info. */
     @Input()
     ecmUser: EcmUserModel;
 
+    /** Identity user info. */
     @Input()
     identityUser: IdentityUserModel;
 
+    /** current mode. */
     @Input()
     mode: UserInfoMode = UserInfoMode.CONTENT;
 

lib/content-services/src/lib/search/components/search-chip-list/search-chip-list.component.ts

@@ -28,8 +28,11 @@ import { SearchFacetFiltersService } from '../../services/search-facet-filters.s
 })
 export class SearchChipListComponent {
 
+    /**
+     * Search filter to supply the data for the chips.
+     * Not required from 4.5.0 and later versions @deprecated
+     * */
     @Input()
-    /** This is not required since ADF 4.5.0  @deprecated*/
     searchFilter: SearchFilterComponent;
 
     /** Flag used to enable the display of a clear-all-filters button. */

lib/content-services/src/lib/tag/services/tag.service.ts

@@ -150,10 +150,8 @@ export class TagService {
      * @param maxItems Specify max number of returned tags. Default is specified by UserPreferencesService.
      * @returns Found tags which name contains searched name.
      */
-    searchTags(name: string, sorting = {
-        orderBy: 'tag',
-        direction: 'asc'
-    }, includedCounts?: boolean, skipCount = 0, maxItems?: number): Observable<TagPaging> {
+    searchTags(name: string, sorting = { orderBy: 'tag', direction: 'asc' },
+               includedCounts?: boolean, skipCount = 0, maxItems?: number): Observable<TagPaging> {
         maxItems = maxItems || this.userPreferencesService.paginationSize;
         return this.getAllTheTags({
             tag: `*${name}*`,

lib/content-services/src/lib/tag/tags-creator/tags-creator.component.ts

@@ -117,10 +117,10 @@ export class TagsCreatorComponent implements OnInit, OnDestroy {
      */
     @Output()
     existingTagsPanelVisibilityChange = new EventEmitter<boolean>();
-    @Output()
     /**
      * Emitted when tags in top list are changed.
      */
+    @Output()
     tagsChange = new EventEmitter<string[]>();
     /**
      * Emitted when input is showing or hiding.