Skip to content
This repository was archived by the owner on Jun 30, 2025. It is now read-only.

Commit 18c8854

Browse files
committed
refactor: internal functions
1 parent ea42be6 commit 18c8854

File tree

1 file changed

+4
-4
lines changed

1 file changed

+4
-4
lines changed

src/validator.ts

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -59,19 +59,19 @@ export class Validator {
5959
}
6060

6161
// All defined parameters should have natspec
62-
validateParameters(node: ErrorDefinition | FunctionDefinition | ModifierDefinition, natspecParams: (string | undefined)[]): string[] {
62+
private validateParameters(node: ErrorDefinition | FunctionDefinition | ModifierDefinition, natspecParams: (string | undefined)[]): string[] {
6363
let definedParameters = node.vParameters.vParameters.map((p) => p.name);
6464
return definedParameters.filter((p) => !natspecParams.includes(p)).map((p) => `@param ${p} is missing`);
6565
}
6666

6767
// All members of a struct should have natspec
68-
validateMembers(node: StructDefinition, natspecParams: (string | undefined)[]): string[] {
68+
private validateMembers(node: StructDefinition, natspecParams: (string | undefined)[]): string[] {
6969
let members = node.vMembers.map((p) => p.name);
7070
return members.filter((m) => !natspecParams.includes(m)).map((m) => `@param ${m} is missing`);
7171
}
7272

7373
// All returned parameters should have natspec
74-
validateReturnParameters(node: FunctionDefinition, natspecReturns: (string | undefined)[]): string[] {
74+
private validateReturnParameters(node: FunctionDefinition, natspecReturns: (string | undefined)[]): string[] {
7575
let alerts: string[] = [];
7676
let functionReturns = node.vReturnParameters.vParameters.map((p) => p.name);
7777

@@ -93,7 +93,7 @@ export class Validator {
9393
return alerts;
9494
}
9595

96-
requiresInheritdoc(node: NodeToProcess): boolean {
96+
private requiresInheritdoc(node: NodeToProcess): boolean {
9797
let _requiresInheritdoc: boolean = false;
9898

9999
// External or public function

0 commit comments

Comments
 (0)