Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Commit f5d6f97

Browse files
vogloblinskyvogloblinsky
committed
fix(app): @example render twice for methods
closes #1385
1 parent b8c9a56 commit f5d6f97

File tree

2 files changed

+107
-114
lines changed

2 files changed

+107
-114
lines changed

‎src/app/engines/markdown.engine.ts

+4-1
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,7 @@ import * as _ from 'lodash';
33
import * as path from 'path';
44

55
import FileEngine from './file.engine';
6+
import I18nEngine from './i18n.engine';
67
import { markedAcl } from '../../utils/marked.acl';
78

89
const decache = require('decache');
@@ -33,7 +34,9 @@ export class MarkdownEngine {
3334
}
3435

3536
highlighted = this.escape(code);
36-
return `<div><pre class="line-numbers"><code class="language-${language}">${highlighted}</code></pre></div>`;
37+
return `<b>${I18nEngine.translate(
38+
'example'
39+
)} :</b><div><pre class="line-numbers"><code class="language-${language}">${highlighted}</code></pre></div>`;
3740
};
3841

3942
renderer.table = (header, body) => {

‎src/templates/partials/block-method.hbs

+103-113
Original file line numberDiff line numberDiff line change
@@ -12,10 +12,10 @@
1212
<a name="{{name}}"></a>
1313
<span class="name">
1414
{{#each modifierKind}}
15-
<span class="modifier">{{modifKind this}}</span>
15+
<span class="modifier">{{modifKind this}}</span>
1616
{{/each}}
1717
{{#if optional}}
18-
<span class="modifier">{{t "optional" }}</span>
18+
<span class="modifier">{{t "optional" }}</span>
1919
{{/if}}
2020
<span {{#if deprecated}}class="deprecated-name"{{/if}}><b>{{name}}</b></span>
2121
<a href="#{{name}}"><span class="icon ion-ios-link"></span></a>
@@ -46,7 +46,7 @@
4646
<tr>
4747
<td class="col-md-4">
4848
{{#if modifierKind}}
49-
<span class="modifier-icon icon ion-ios-{{modifIcon modifierKind}}"></span>
49+
<span class="modifier-icon icon ion-ios-{{modifIcon modifierKind}}"></span>
5050
{{/if}}<code>{{{functionSignature this}}}</code>
5151
</td>
5252
</tr>
@@ -62,135 +62,125 @@
6262
{{/if}}
6363

6464
{{#if line}}
65-
{{#isTabEnabled ../navTabs "source"}}
66-
{{#if inheritance}}
67-
<tr>
68-
<td class="col-md-4">
69-
<div class="io-line">{{t "inherited-from" }} {{> link-type type=inheritance.file }}</div>
70-
</td>
71-
</tr>
72-
{{/if}}
73-
<tr>
74-
<td class="col-md-4">
65+
{{#isTabEnabled ../navTabs "source"}}
7566
{{#if inheritance}}
76-
<div class="io-line">{{t "defined-in" }} {{> link-type type=inheritance.file withline=true }}</div>
77-
{{else}}
78-
<div class="io-line">{{t "defined-in" }} <a href="" data-line="{{{line}}}"
79-
class="link-to-prism">{{../file}}:{{{line}}}</a></div>
67+
<tr>
68+
<td class="col-md-4">
69+
<div class="io-line">{{t "inherited-from" }} {{> link-type type=inheritance.file }}</div>
70+
</td>
71+
</tr>
8072
{{/if}}
81-
</td>
82-
</tr>
83-
{{/isTabEnabled}}
73+
<tr>
74+
<td class="col-md-4">
75+
{{#if inheritance}}
76+
<div class="io-line">{{t "defined-in" }} {{> link-type type=inheritance.file withline=true }}</div>
77+
{{else}}
78+
<div class="io-line">{{t "defined-in" }} <a href="" data-line="{{{line}}}"
79+
class="link-to-prism">{{../file}}:{{{line}}}</a></div>
80+
{{/if}}
81+
</td>
82+
</tr>
83+
{{/isTabEnabled}}
8484
{{/if}}
8585

8686
{{#if typeParameters}}
87-
{{#compare typeParameters.length ">" 0}}
88-
<tr>
89-
<td class="col-md-4">
90-
<b>{{t "type-parameters" }} :</b>
91-
<ul class="type-parameters">
92-
{{#each typeParameters}}
93-
<li>{{this}}</li>
94-
{{/each}}
95-
</ul>
96-
</td>
97-
</tr>
98-
{{/compare}}
87+
{{#compare typeParameters.length ">" 0}}
88+
<tr>
89+
<td class="col-md-4">
90+
<b>{{t "type-parameters" }} :</b>
91+
<ul class="type-parameters">
92+
{{#each typeParameters}}
93+
<li>{{this}}</li>
94+
{{/each}}
95+
</ul>
96+
</td>
97+
</tr>
98+
{{/compare}}
9999
{{/if}}
100100

101101
{{#or jsdoctags returnType description}}
102102
<tr>
103103
<td class="col-md-4">
104104
{{#if description}}
105-
<div class="io-description">{{{parseDescription description ../depth}}}</div>
105+
<div class="io-description">{{{parseDescription description ../depth}}}</div>
106106
{{/if}}
107107

108108
{{#if jsdoctags}}
109-
{{#jsdoc-params-valid jsdoctags}}
110-
<div class="io-description">
111-
{{#jsdoc-params jsdoctags}}
112-
<b>{{t "parameters" }} :</b>
113-
114-
<table class="params">
115-
<thead>
116-
<tr>
117-
<td>{{t "name" }}</td>
118-
{{#one-parameter-has tags 'type'}}
119-
<td>{{t "type" }}</td>
120-
{{/one-parameter-has}}
121-
<td>{{t "optional" }}</td>
122-
{{#one-parameter-has tags 'defaultValue'}}
123-
<td>{{t "default-value" }}</td>
124-
{{/one-parameter-has}}
125-
{{#one-parameter-has tags 'comment'}}
126-
<td>{{t "description" }}</td>
127-
{{/one-parameter-has}}
128-
</tr>
129-
</thead>
130-
<tbody>
131-
{{#each tags}}
132-
<tr>
133-
{{#if name}}
134-
<td>{{name}}</td>
135-
{{/if}}
136-
{{#one-parameter-has ../tags 'type'}}
137-
<td>
138-
{{#if type}}
139-
{{> link-type type=type }}
140-
{{/if}}
141-
</td>
142-
{{/one-parameter-has}}
109+
{{#jsdoc-params-valid jsdoctags}}
110+
<div class="io-description">
111+
{{#jsdoc-params jsdoctags}}
112+
<b>{{t "parameters" }} :</b>
113+
114+
<table class="params">
115+
<thead>
116+
<tr>
117+
<td>{{t "name" }}</td>
118+
{{#one-parameter-has tags 'type'}}
119+
<td>{{t "type" }}</td>
120+
{{/one-parameter-has}}
121+
<td>{{t "optional" }}</td>
122+
{{#one-parameter-has tags 'defaultValue'}}
123+
<td>{{t "default-value" }}</td>
124+
{{/one-parameter-has}}
125+
{{#one-parameter-has tags 'comment'}}
126+
<td>{{t "description" }}</td>
127+
{{/one-parameter-has}}
128+
</tr>
129+
</thead>
130+
<tbody>
131+
{{#each tags}}
132+
<tr>
133+
{{#if name}}
134+
<td>{{name}}</td>
135+
{{/if}}
136+
{{#one-parameter-has ../tags 'type'}}
137+
<td>
138+
{{#if type}}
139+
{{> link-type type=type }}
140+
{{/if}}
141+
</td>
142+
{{/one-parameter-has}}
143143

144-
<td>
145-
{{#if optional}}
146-
{{t "yes" }}
147-
{{else}}
148-
{{t "no" }}
149-
{{/if}}
150-
</td>
144+
<td>
145+
{{#if optional}}
146+
{{t "yes" }}
147+
{{else}}
148+
{{t "no" }}
149+
{{/if}}
150+
</td>
151151

152-
{{#one-parameter-has ../tags 'defaultValue'}}
153-
<td>
154-
{{#if defaultValue}}
155-
<code>{{defaultValue}}</code>
156-
{{/if}}
157-
</td>
158-
{{/one-parameter-has}}
152+
{{#one-parameter-has ../tags 'defaultValue'}}
153+
<td>
154+
{{#if defaultValue}}
155+
<code>{{defaultValue}}</code>
156+
{{/if}}
157+
</td>
158+
{{/one-parameter-has}}
159159

160-
{{#one-parameter-has ../tags 'comment'}}
161-
<td>
162-
{{#if comment}}
163-
{{{parseDescription comment ../../depth}}}
164-
{{/if}}
165-
</td>
166-
{{/one-parameter-has}}
167-
</tr>
168-
{{/each}}
169-
</tbody>
170-
</table>
171-
{{/jsdoc-params}}
172-
</div>
173-
{{/jsdoc-params-valid}}
174-
<div>
175-
{{#jsdoc-code-example jsdoctags}}
176-
<b>{{t "example" }} :</b>
177-
{{#each tags}}
178-
<div>
179-
{{{comment}}}
180-
</div>
181-
{{/each}}
182-
{{/jsdoc-code-example}}
183-
</div>
160+
{{#one-parameter-has ../tags 'comment'}}
161+
<td>
162+
{{#if comment}}
163+
{{{parseDescription comment ../../depth}}}
164+
{{/if}}
165+
</td>
166+
{{/one-parameter-has}}
167+
</tr>
168+
{{/each}}
169+
</tbody>
170+
</table>
171+
{{/jsdoc-params}}
172+
</div>
173+
{{/jsdoc-params-valid}}
184174
{{/if}}
185175
{{#if returnType}}
186-
<div class="io-description">
187-
<b>{{t "returns" }} : </b>{{> link-type type=returnType }}
188-
</div>
189-
{{#if jsdoctags}}
190-
<div class="io-description">
191-
{{{jsdoc-returns-comment jsdoctags}}}
192-
</div>
193-
{{/if}}
176+
<div class="io-description">
177+
<b>{{t "returns" }} : </b>{{> link-type type=returnType }}
178+
</div>
179+
{{#if jsdoctags}}
180+
<div class="io-description">
181+
{{{jsdoc-returns-comment jsdoctags}}}
182+
</div>
183+
{{/if}}
194184
{{/if}}
195185
</td>
196186
</tr>

0 commit comments

Comments
 (0)