style(types): update tsdoc example for "DocumentType"

typegoose · Feb 19, 2023 · 33fa48e · 33fa48e
1 parent f1bd331
commit 33fa48e
Showing 1 changed file with 4 additions and 1 deletion.
diff --git a/src/types.ts b/src/types.ts
@@ -5,7 +5,10 @@ import type { Severity, PropType } from './internal/constants';
  * Get the Type of an instance of a Document with Class properties
  * @example
  * ```ts
- * class ClassName {}
+ * class ClassName {
+ *   @prop()
+ *   public someProperty: string;
+ * }
  * const NameModel = getModelForClass(ClassName);
  *
  * const doc: DocumentType<ClassName> = await NameModel.create({});