From 5f71e779ef30c413958c226b894e97a19ee693f5 Mon Sep 17 00:00:00 2001
From: David Mehren <git@herrmehren.de>
Date: Mon, 25 Jan 2021 22:45:34 +0100
Subject: [PATCH] NoteDto: Add doc comments

Signed-off-by: David Mehren <git@herrmehren.de>
---
 src/notes/note.dto.ts | 10 ++++++++++
 1 file changed, 10 insertions(+)

diff --git a/src/notes/note.dto.ts b/src/notes/note.dto.ts
index 91e842602..a32fca9e6 100644
--- a/src/notes/note.dto.ts
+++ b/src/notes/note.dto.ts
@@ -9,12 +9,22 @@ import { NoteAuthorshipDto } from './note-authorship.dto';
 import { NoteMetadataDto } from './note-metadata.dto';
 
 export class NoteDto {
+  /**
+   * Markdown content of the note
+   * @example "# I am a heading"
+   */
   @IsString()
   content: string;
 
+  /**
+   * Metadata of the note
+   */
   @ValidateNested()
   metadata: NoteMetadataDto;
 
+  /**
+   * Authorship information of this note
+   */
   @IsArray()
   @ValidateNested({ each: true })
   editedByAtPosition: NoteAuthorshipDto[];