Clean up documentation

Author: gitKrystan

transforms/helpers/eo-prop/private/abstract.ts

@@ -14,7 +14,11 @@ type EOPropValue = AST.EOProp['value'] | AST.EOMethod;
 /**
  * Ember Object Property
  *
- * A wrapper object for ember object properties
+ * A wrapper object for Ember Object properties and methods.
+ *
+ * Each subclass is required to implement a `build` method that returns the
+ * appropriate AST node (or array thereof) to be added to the parent
+ * `EOExtendExpression`'s `ClassBody`.
  */
 export default abstract class AbstractEOProp<
   P extends AST.EOExpressionProp,

transforms/helpers/eo-prop/private/call-expression/abstract.ts

@@ -8,6 +8,15 @@ import AbstractEOProp from '../abstract';
 import type { CallExpressionModifier } from './modifier-helper';
 import { COMPUTED_DECORATOR_NAME } from '../../../util/index';
 
+/**
+ * Ember Object Call Expression Property
+ *
+ * A wrapper object for Ember Object properties with `CallExpression` values
+ * to be transformed the appropriate AST node (or array thereof) to be added to
+ * the parent `EOExtendExpression`'s `ClassBody`.
+ *
+ * See each subclass for more details.
+ */
 export default abstract class AbstractEOCallExpressionProp<
   B extends AST.ClassProperty | AST.ClassMethod | AST.ClassMethod[]
 > extends AbstractEOProp<AST.EOCallExpressionProp, B> {

transforms/helpers/eo-prop/private/call-expression/function-expression.ts

@@ -4,6 +4,38 @@ import { replaceComputedSuperExpressions as replaceComputedSuperExpression } fro
 import { assert, defined } from '../../../util/types';
 import AbstractEOCallExpressionProp from './abstract';
 
+/**
+ * Ember Object Computed Function Expression Property
+ *
+ * A wrapper object for Ember Object properties with `FunctionExpression` values
+ * for computed properties (including computed macros) to be transformed into
+ * `ClassMethod`s with their appropriate decorators (and any modifiers).
+ *
+ * @example
+ *
+ * ```
+ * const MyObject = EmberObject.extend({
+ *   firstName: 'Krystan',
+ *   lastName: 'HuffMenne',
+ *   fName1: alias('firstName'),
+ *   fName2: alias('firstName').readOnly(),
+ *   fullName: computed('firstName', 'lastName', function() {
+ *     return `${firstName} ${lastName}`;
+ *   }),
+ *   // FIXME: Getter/setter version
+ * });
+ * ```
+ *
+ * transforms into:
+ *
+ * ```
+ * class MyObject extends EmberObject {
+ *   FIXME: Fill in
+ * }
+ * ```
+ *
+ * @see EOMethod
+ */
 export default class EOComputedFunctionExpressionProp extends AbstractEOCallExpressionProp<AST.ClassMethod> {
   build(): AST.ClassMethod {
     const args = this.arguments;

transforms/helpers/eo-prop/private/class-decorator.ts

@@ -14,14 +14,26 @@ import AbstractEOProp from './abstract';
 /**
  * Ember Object Class Decorator
  *
- * A wrapper object for ember object properties that should be converted into
- * class decorators, including:
- * - `@classNames`
- * - `@attributeBindings`
- * - `@classNameBindings`
- * - `@layout`
- * - `@tagName`
- * - `@templateLayout`
+ * A wrapper object for Ember Object properties that should be converted into
+ * class decorators. See `CLASS_DECORATOR_NAMES` for the list of handled
+ * decorator properties.
+ *
+ * @example
+ *
+ * ```
+ * const MyObject = EmberObject.extend({
+ *   tagName: '',
+ *   classNames: ['my-object'],
+ * });
+ * ```
+ *
+ * transforms into:
+ *
+ * ```
+ * @tagName('')
+ * @classNames('my-object')
+ * class MyObject extends EmberObject {
+ * }
  */
 export default class EOClassDecorator extends AbstractEOProp<
   AST.EOClassDecoratorProp,

transforms/helpers/eo-prop/private/function-expression.ts

@@ -3,6 +3,34 @@ import type * as AST from '../../ast';
 import { replaceMethodSuperExpression } from '../../transform-helper';
 import AbstractEOProp from './abstract';
 
+/**
+ * Ember Object Function Expression Property
+ *
+ * A wrapper object for Ember Object properties with `FunctionExpression` values
+ * to be transformed into `ClassMethod`s.
+ *
+ * @example
+ *
+ * ```
+ * const MyObject = EmberObject.extend({
+ *   myMethod: () => {
+ *     this._super(...arguments);
+ *   }
+ * });
+ * ```
+ *
+ * transforms into:
+ *
+ * ```
+ * class MyObject extends EmberObject {
+ *   myMethod() {
+ *     super.myMethod(...arguments);
+ *   }
+ * }
+ * ```
+ *
+ * @see EOMethod
+ */
 export default class EOFunctionExpressionProp extends AbstractEOProp<
   AST.EOFunctionExpressionProp,
   AST.ClassMethod
@@ -13,11 +41,6 @@ export default class EOFunctionExpressionProp extends AbstractEOProp<
 
   protected override readonly supportsObjectLiteralDecorators = true;
 
-  /**
-   * Transform functions to class methods
-   *
-   * For example { foo: function() { }} --> { foo() { }}
-   */
   build(): AST.ClassMethod {
     return replaceMethodSuperExpression(
       j.classMethod.from({

transforms/helpers/eo-prop/private/method.ts

@@ -3,6 +3,38 @@ import type * as AST from '../../ast';
 import { replaceMethodSuperExpression } from '../../transform-helper';
 import AbstractEOProp from './abstract';
 
+/**
+ * Ember Object Method
+ *
+ * A wrapper object for Ember Object methods (including getters and setters) to
+ * be transformed into `ClassMethod`s.
+ *
+ * @example
+ *
+ * ```
+ * const MyObject = EmberObject.extend({
+ *   get myGetter() {},
+ *
+ *   myMethod() {
+ *     this._super(...arguments);
+ *   }
+ * });
+ * ```
+ *
+ * transforms into:
+ *
+ * ```
+ * class MyObject extends EmberObject {
+ *   get myGetter() {}
+ *
+ *   myMethod() {
+ *     super.myMethod(...arguments);
+ *   }
+ * }
+ * ```
+ *
+ * @see EOFunctionExpressionProp
+ */
 export default class EOMethod extends AbstractEOProp<
   AST.EOMethod,
   AST.ClassMethod
@@ -13,11 +45,6 @@ export default class EOMethod extends AbstractEOProp<
 
   protected override readonly supportsObjectLiteralDecorators = true;
 
-  /**
-   * Transform object method to class method
-   *
-   * For example { foo() { }} --> { foo() { }}
-   */
   build(): AST.ClassMethod {
     return replaceMethodSuperExpression(
       j.classMethod.from({

transforms/helpers/eo-prop/private/simple.ts

@@ -4,6 +4,31 @@ import { createDecoratorWithArgs } from '../../decorator-helper';
 import logger from '../../log-helper';
 import AbstractEOProp from './abstract';
 
+/**
+ * Ember Object Simple Property
+ *
+ * A wrapper object for Ember Object properties not captured by the other
+ * `EOProp`/`EOClassDecorator` classes to be transformed into
+ * `ClassProperties`s.
+ *
+ * @example
+ *
+ * ```
+ * const MyObject = EmberObject.extend({
+ *   myMethod: () => {}
+ * });
+ * ```
+ *
+ * transforms into:
+ *
+ * ```
+ * class MyObject extends EmberObject {
+ *   myMethod() {}
+ * }
+ * ```
+ *
+ * @see EOMethod
+ */
 export default class EOSimpleProp extends AbstractEOProp<
   AST.EOSimpleProp,
   AST.ClassProperty