From 61998661fbc4f08529f77b545e721a8295572cc0 Mon Sep 17 00:00:00 2001
From: Michael Kleinhenz <kleinhenz@redhat.com>
Date: Thu, 17 May 2018 16:03:04 +0200
Subject: [PATCH] fix(markdown): Added documentation. Triggering semantic
 versioning. (#144)

---
 src/app/markdown/markdown.component.ts | 8 ++++++++
 1 file changed, 8 insertions(+)

diff --git a/src/app/markdown/markdown.component.ts b/src/app/markdown/markdown.component.ts
index 86915d3..dfbbcb1 100644
--- a/src/app/markdown/markdown.component.ts
+++ b/src/app/markdown/markdown.component.ts
@@ -21,6 +21,14 @@ import { SafeHtml } from '@angular/platform-browser';
   styleUrls: ['./markdown.component.less'],
   templateUrl: './markdown.component.html'
 })
+
+/**
+ * Implements a markdown component. Important: in order that the checkbox
+ * feature is working, the rendered content set using the attribute needs
+ * to be wrapped into a SafeValue instance. This prevents the sanitizer
+ * to strip the input fields needed for the checkboxes from the rendered
+ * html.
+ */
 export class MarkdownComponent implements OnChanges, OnInit, AfterViewChecked {
 
   @Input() fieldName: string = 'Description';