From bbaab54ec929d3a9690342e3781963e88a1fc091 Mon Sep 17 00:00:00 2001
From: Justin Greywolf <jgreywolf@users.noreply.github.com>
Date: Tue, 15 Aug 2023 11:02:06 -0700
Subject: [PATCH] add tsdoc comments

---
 .../mermaid/src/diagrams/class/classTypes.ts  | 32 ++++++++++++++++---
 1 file changed, 28 insertions(+), 4 deletions(-)

diff --git a/packages/mermaid/src/diagrams/class/classTypes.ts b/packages/mermaid/src/diagrams/class/classTypes.ts
index 2f779a238..de083bdcc 100644
--- a/packages/mermaid/src/diagrams/class/classTypes.ts
+++ b/packages/mermaid/src/diagrams/class/classTypes.ts
@@ -16,13 +16,32 @@ export interface ClassNode {
   tooltip?: string;
 }
 
+export type Visibility = '#' | '+' | '~' | '-' | '';
+export const visibilityValues = ['#', '+', '~', '-', ''];
+
+/**
+ * Parses and stores class diagram member variables/methods.
+ *
+ */
 export class ClassMember {
   id!: string;
   cssStyle!: string;
   memberType!: 'method' | 'attribute';
-  visibility!: string;
+  visibility!: Visibility;
+  /**
+   * denote if static or to determine which css class to apply to the node
+   * @defaultValue ''
+   */
   classifier!: string;
+  /**
+   * parameters for method
+   * @defaultValue ''
+   */
   parameters!: string;
+  /**
+   * return type for method
+   * @defaultValue ''
+   */
   returnType!: string;
 
   constructor(input: string, memberType: 'method' | 'attribute') {
@@ -57,7 +76,12 @@ export class ClassMember {
       const methodRegEx = /([#+~-])?(.+)\((.*)\)([\s$*])?(.*)([$*])?/;
       const match = input.match(methodRegEx);
       if (match) {
-        this.visibility = match[1] ? match[1].trim() : '';
+        const detectedVisibility = match[1] ? match[1].trim() : '';
+
+        if (visibilityValues.includes(detectedVisibility)) {
+          this.visibility = detectedVisibility as Visibility;
+        }
+
         this.id = match[2].trim();
         this.parameters = match[3] ? match[3].trim() : '';
         potentialClassifier = match[4] ? match[4].trim() : '';
@@ -76,8 +100,8 @@ export class ClassMember {
       const firstChar = input.substring(0, 1);
       const lastChar = input.substring(length - 1);
 
-      if (firstChar.match(/[#+~-]/)) {
-        this.visibility = firstChar;
+      if (visibilityValues.includes(firstChar)) {
+        this.visibility = firstChar as Visibility;
       }
 
       if (lastChar.match(/[*?]/)) {