refactor: update comment styles for consistency across ProjectAPI, DataPoint, and ComponentCode

This commit is contained in:
Nawaz Dhandala 2025-10-02 11:57:39 +01:00
parent 6d5bc111ba
commit 2dda68c462
No known key found for this signature in database
GPG key ID: 96C5DCA24769DBCA
4 changed files with 18 additions and 12 deletions

View file

@ -25,8 +25,10 @@ export default class ProjectAPI extends BaseAPI<Project, ProjectServiceType> {
public constructor() {
super(Project, ProjectService);
/// This API lists all the projects where user is its team member.
/// This API is usually used to show project selector dropdown in the UI
/*
* This API lists all the projects where user is its team member.
* This API is usually used to show project selector dropdown in the UI
*/
this.router.post(
`${new this.entityType()
.getCrudApiPath()

View file

@ -1,9 +1,11 @@
/// ChartDataPoint is in the format of:
// {
// date: "Feb 22",
// SolarPanels: 2756,
// Inverters: 2103,
// }
/*
* ChartDataPoint is in the format of:
* {
* date: "Feb 22",
* SolarPanels: 2756,
* Inverters: 2103,
* }
*/
import BadDataException from "../../../../Types/Exception/BadDataException";
import ChartDataPoint from "../ChartLibrary/Types/ChartDataPoint";

View file

@ -16,8 +16,10 @@ export default class ComponentCodeAPI {
}
public init(): void {
// init all component code.
/// Get all the components.
/*
* init all component code.
* Get all the components.
*/
for (const key in Components) {
const ComponentCode: ComponentCode | undefined = Components[key];

View file

@ -59,8 +59,8 @@ export default tseslint.config(
"@typescript-eslint/no-var-requires": "off", // TODO: Remove this rule
"@typescript-eslint/no-duplicate-enum-values": "off", // TODO: Remove this rule
"no-constant-binary-expression": "off", // TODO: Remove this rule
"@typescript-eslint/ban-ts-comment": "off", // TODO: Remove this rule
"multiline-comment-style": "error", // TODO: Remove this rule
"@typescript-eslint/ban-ts-comment": "off",
"multiline-comment-style": "error",
"@typescript-eslint/no-floating-promises": "off", // TODO: Remove this rule
"no-fallthrough": "error",
"no-unreachable": "error",