Improve JSDoc

aedart · Jan 31, 2024 · b0096c4 · b0096c4
1 parent 46af35a
commit b0096c4
Showing 1 changed file with 8 additions and 0 deletions.
diff --git a/packages/support/src/meta/meta.ts b/packages/support/src/meta/meta.ts
@@ -23,6 +23,14 @@ const registry: WeakMap<object, MetadataRecord> = new WeakMap<object, MetadataRe
 /**
  * Store value as metadata, for given key.
  *
+ * **Note**: _Method is intended to be used as a decorator!_
+ * 
+ * @example
+ * ```ts
+ * @meta('my-key', 'my-value)
+ * class A {}
+ * ```
+ * 
  * @see getMeta
  * @see getAllMeta
  *