github/hedgedoc
1
0
Fork 0
mirror of https://github.com/hedgedoc/hedgedoc.git synced 2025-01-22 13:44:47 +00:00
Code Issues Projects Releases Packages Wiki Activity

HistoryEntryDto: Add doc comments

Browse source 
Signed-off-by: David Mehren <git@herrmehren.de>
This commit is contained in:
David Mehren 2021-01-25 22:45:52 +01:00
parent c38019b0f2
commit af35cd1bb2
No known key found for this signature in database
GPG key ID: 185982BA4C42B7C3
1 changed files with 8 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

8
src/history/history-entry.dto.ts
View file

@ -8,8 +8,16 @@ import { IsBoolean, ValidateNested } from 'class-validator';
import { NoteMetadataDto } from '../notes/note-metadata.dto'; import { NoteMetadataDto } from '../notes/note-metadata.dto';
export class HistoryEntryDto { export class HistoryEntryDto {
/**
* Metadata of this note
*/
@ValidateNested() @ValidateNested()
metadata: NoteMetadataDto; metadata: NoteMetadataDto;
/**
* True if this note is pinned
* @example false
*/
@IsBoolean() @IsBoolean()
pinStatus: boolean; pinStatus: boolean;
} }