Skip to content

Commit cea229d

Browse files
committed
use markdown-to-html for all descriptions
1 parent f5215a7 commit cea229d

File tree

3 files changed

+6
-6
lines changed

3 files changed

+6
-6
lines changed

app/components/class-field-description.hbs

+4-4
Original file line numberDiff line numberDiff line change
@@ -54,14 +54,14 @@
5454
<div class='parameter'>
5555
<dt>{{param.name}}</dt>
5656
<dd class='parameter-type'>{{param.type}}</dd>
57-
<dd>{{param.description}}</dd>
57+
<dd><MarkdownToHtml @markdown={{param.description}} /></dd>
5858
{{#if param.props}}
5959
<dl class='parameters'>
6060
{{#each param.props as |prop|}}
6161
<div class='prop'>
6262
<dt>{{prop.name}}</dt>
6363
<dd class='parameter-type'>{{prop.type}}</dd>
64-
<dd>{{prop.description}}</dd>
64+
<dd><MarkdownToHtml @markdown={{prop.description}} /></dd>
6565
</div>
6666
{{/each}}
6767
</dl>
@@ -72,9 +72,9 @@
7272
<div class='return'>
7373
<dt>returns</dt>
7474
<dd class='return-type'>{{@field.return.type}}</dd>
75-
<dd>{{@field.return.description}}</dd>
75+
<dd><MarkdownToHtml @markdown={{@field.return.description}} /></dd>
7676
</div>
7777
{{/if}}
7878
</dl>
79-
{{html-safe @field.description}}
79+
<MarkdownToHtml @markdown={{@field.description}} />
8080
</section>

app/templates/project-version/classes/class.hbs

+1-1
Original file line numberDiff line numberDiff line change
@@ -63,7 +63,7 @@
6363
{{#if (and (not (eq this.static 1)) this.hasImportExample)}}
6464
<ImportExample @item={{@model.name}} @package={{this.module}} />
6565
{{/if}}
66-
<p class="description">{{html-safe @model.description}}</p>
66+
<p class="description"><MarkdownToHtml @markdown={{@model.description}} /></p>
6767

6868
{{#if (or @model.methods @model.properties @model.events)}}
6969
<div class="tabbed-layout">

app/templates/project-version/modules/module.hbs

+1-1
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@
1515
{{/if}}
1616
</p>
1717

18-
<p class="description">{{html-safe this.model.description}}</p>
18+
<p class="description"><MarkdownToHtml @markdown={{this.model.description}} /></p>
1919

2020
{{#if this.submodules}}
2121
<section>

0 commit comments

Comments
 (0)