Merge pull request #9 from riehlegroup/jsdoc

Apply JSDoc style
riehlegroup · Oct 22, 2024 · 0115ed5 · 0115ed5
2 parents 2b4aa56 + 40e7e4b
commit 0115ed5
Show file tree

Hide file tree

Showing 2 changed files with 2 additions and 2 deletions.
diff --git a/src/adap-b01/names/Name.ts b/src/adap-b01/names/Name.ts
@@ -10,7 +10,7 @@ export class Name {
         throw new Error("needs implementation");
     }
 
-    // Returns human-readable representation of Name instance
+    /** Returns human-readable representation of Name instance */
     public asNameString(delimiter: string = this.delimiter): string {
         throw new Error("needs implementation");
     }

diff --git a/src/adap-b02/names/Name.ts b/src/adap-b02/names/Name.ts
@@ -3,7 +3,7 @@ export const ESCAPE_CHARACTER = '\\';
 
 export interface Name {
 
-    // Returns human-readable representation of Name instance
+    /** Returns human-readable representation of Name instance */
     asNameString(delimiter?: string): string;
 
     isEmpty(): boolean;