docs(classes): add more comments to AutoMap decorator

nartc · Apr 9, 2021 · b00a01c · b00a01c
1 parent 75a16b4
commit b00a01c
Showing 1 changed file with 4 additions and 1 deletion.
diff --git a/packages/classes/src/lib/decorators/automap.decorator.ts b/packages/classes/src/lib/decorators/automap.decorator.ts
@@ -31,11 +31,14 @@ export function AutoMap(
   depth?: number
 ): PropertyDecorator;
 /**
- * AutoMap decorator to decorate fields in classes to store metadata of that field
+ * AutoMap decorator to decorate fields in classes to store metadata of that field with a config object
  *
  * @param {AutoMapOptions} config
  */
 export function AutoMap(config: AutoMapOptions): PropertyDecorator;
+/**
+ * AutoMap decorator to decorate fields in classes to store metadata.
+ */
 export function AutoMap(): PropertyDecorator;
 export function AutoMap(
   typeFnOrConfig?: AutoMapOptions | (() => Constructible),