#13, ClassMembersMap, adding missed JSDoc.

ajvincent · Jan 13, 2024 · 53fce4b · 53fce4b
1 parent 09c5fee
commit 53fce4b
Show file tree

Hide file tree

Showing 2 changed files with 22 additions and 2 deletions.
diff --git a/stage_1_integration/toolbox/ClassMembersMap.ts b/stage_1_integration/toolbox/ClassMembersMap.ts
@@ -87,6 +87,11 @@ extends Map<string, ClassMemberImpl>
     return rv;
   }
 
+  /**
+   * Create a `ClassMembersMap` from a class declaration.
+   * @param classDecl - the class declaration.
+   * @returns the class members map.
+   */
   static fromClassDeclaration(
     classDecl: ClassDeclarationImpl
   ): ClassMembersMap
@@ -162,6 +167,11 @@ extends Map<string, ClassMemberImpl>
     return undefined;
   }
 
+  /**
+   * Convert get and/or set accessors to a property.  This may be lossy, but we try to be faithful.
+   * @param isStatic - true if the property is static (and the accessors should be)
+   * @param name - the property name
+   */
   convertAccessorsToProperty(
     isStatic: boolean,
     name: string
@@ -210,7 +220,7 @@ extends Map<string, ClassMemberImpl>
   }
 
   /**
-   * 
+   * Convert a property to get and/or set accessors.  This may be lossy, but we try to be faithful.
    * @param isStatic - true if the property is static (and the accessors should be)
    * @param name - the property name
    * @param toGetter - true if the caller wants a getter

diff --git a/stage_2_fullset/snapshot/source/toolbox/ClassMembersMap.ts b/stage_2_fullset/snapshot/source/toolbox/ClassMembersMap.ts
@@ -72,6 +72,11 @@ export default class ClassMembersMap extends Map<string, ClassMemberImpl> {
     return rv;
   }
 
+  /**
+   * Create a `ClassMembersMap` from a class declaration.
+   * @param classDecl - the class declaration.
+   * @returns the class members map.
+   */
   static fromClassDeclaration(
     classDecl: ClassDeclarationImpl,
   ): ClassMembersMap {
@@ -135,6 +140,11 @@ export default class ClassMembersMap extends Map<string, ClassMemberImpl> {
     return undefined;
   }
 
+  /**
+   * Convert get and/or set accessors to a property.  This may be lossy, but we try to be faithful.
+   * @param isStatic - true if the property is static (and the accessors should be)
+   * @param name - the property name
+   */
   convertAccessorsToProperty(isStatic: boolean, name: string): void {
     const getter = this.getAsKind<StructureKind.GetAccessor>(
       StructureKind.GetAccessor,
@@ -206,7 +216,7 @@ export default class ClassMembersMap extends Map<string, ClassMemberImpl> {
   }
 
   /**
-   *
+   * Convert a property to get and/or set accessors.  This may be lossy, but we try to be faithful.
    * @param isStatic - true if the property is static (and the accessors should be)
    * @param name - the property name
    * @param toGetter - true if the caller wants a getter