[ACS-6071] fix jsdoc warnings and errors (#8948)

* fix content docs

* fix extensions docs

* fix insights docs

* [ci:force] fix jsdoc errors and warnings

* enable jsdoc linter

* [ci:force] fix demo shell jsdoc

* [ci:force] fix e2e typings

* fix typo

* fix typo
This commit is contained in:
Denys Vuika
2023-09-29 08:11:58 +01:00
committed by GitHub
parent 501516c8f5
commit d72eb5ebd3
86 changed files with 1233 additions and 254 deletions

View File

@@ -80,6 +80,8 @@ export class AnalyticsReportListComponent implements OnInit {
/**
* Reload the component
*
* @param reportId report id
*/
reload(reportId?: number) {
this.reset();
@@ -88,8 +90,11 @@ export class AnalyticsReportListComponent implements OnInit {
/**
* Get the report list
*
* @param appId application id
* @param reportId report id
*/
getReportList(appId: number, reportId?: number) {
getReportList(appId: number, reportId?: number): void {
this.analyticsService.getReportList(appId).subscribe(
(res: ReportParametersModel[]) => {
if (res && res.length === 0) {
@@ -133,6 +138,8 @@ export class AnalyticsReportListComponent implements OnInit {
/**
* Check if the report list is empty
*
* @returns `true` if report list is empty, otherwise `false`
*/
isReportsEmpty(): boolean {
return this.reports === undefined || (this.reports && this.reports.length === 0);
@@ -141,7 +148,7 @@ export class AnalyticsReportListComponent implements OnInit {
/**
* Select the current report
*
* @param report
* @param report report model
*/
selectReport(report: any) {
this.currentReport = report;

View File

@@ -51,6 +51,9 @@ export class AnalyticsService {
/**
* Retrieve all the Deployed app
*
* @param appId application id
* @returns list or report parameter models
*/
getReportList(appId: number): Observable<ReportParametersModel[]> {
return from(this.reportApi.getReportList())
@@ -72,7 +75,8 @@ export class AnalyticsService {
/**
* Retrieve Report by name
*
* @param reportName - string - The name of report
* @param reportName - The name of report
* @returns report model
*/
getReportByName(reportName: string): Observable<any> {
return from(this.reportApi.getReportList())