Skip to content

Commit 2eb3769

Browse files
docs(*): Show the shortText for properties in the heading section.
1 parent 09e10e3 commit 2eb3769

File tree

2 files changed

+20
-4
lines changed

2 files changed

+20
-4
lines changed

Diff for: typedoctheme/assets/css/typedoctheme.css

+9-1
Original file line numberDiff line numberDiff line change
@@ -2,16 +2,24 @@
22
.tsd-panel.tsd-member { padding-top: 0; }
33
.tsd-panel .tsd-signature, .tsd-panel .tsd-signatures { background-color: #eee; }
44

5+
.tsd-signature .tsd-header { margin: 1em 0 }
6+
.tsd-signature .tsd-header p { margin: 0 }
7+
58
/* The short text, one line description of a member */
69
.tsd-header { list-style: none; margin: 0 2em; font-weight: bold; }
710
.tsd-header p { margin-top : 0; }
811

912
/* We added the short text in the .tsd-header, so don't display it in the main comment block */
1013
.tsd-member .tsd-description .lead { display: none; }
14+
.tsd-member .tsd-declaration .lead { display: none; }
1115

16+
/* Display the parameters list and returns block as inline */
1217
ul.tsd-parameters li { margin-top: 1em; }
1318
ul.tsd-parameters li > * { display: inline; }
1419
ul.tsd-parameters li > * > p { display: inline; }
1520

1621
.tsd-returns { margin-top: 1em; }
17-
.tsd-returns > * { display: inline; }
22+
.tsd-returns > * { display: inline; }
23+
24+
/* Draw a separator line under each h4/h5 header in a comment section */
25+
.tsd-comment h4, .tsd-comment h5 { border-bottom: 1px solid #AAA; }

Diff for: typedoctheme/partials/member.declaration.hbs

+11-3
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,18 @@
11
<div class="tsd-signature tsd-kind-icon">{{#compact}}
22
{{{wbr name}}}<span class="tsd-signature-symbol">{{#if isOptional}}?{{/if}}:</span>&nbsp;{{#with type}}{{>type}}{{/with}}
3-
{{/compact}}</div>
3+
{{/compact}}
4+
{{#if comment.shortText}}
5+
<div class="tsd-header">
6+
{{#markdown}} {{{comment.shortText}}} {{/markdown}}
7+
</div>
8+
{{/if}}
9+
</div>
410

5-
{{> member.sources}}
11+
<div class="tsd-declaration">
12+
{{> comment}}
13+
</div>
614

7-
{{> comment}}
15+
{{> member.sources}}
816

917
{{#if type.declaration}}
1018
<div class="tsd-type-declaration">

0 commit comments

Comments
 (0)