Skip to content

Commit 63bdd7b

Browse files
committed
Add constructors to docs
1 parent 01f05b0 commit 63bdd7b

File tree

3 files changed

+51
-17
lines changed

3 files changed

+51
-17
lines changed

doc-tool/resources/_layouts/api-page.html

Lines changed: 33 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -57,7 +57,39 @@
5757
</div>
5858
{% endif %}
5959

60-
<h1 class="section {% if entity.hasVisibleMembers == false %}empty{% endif %}">Members</h1>
60+
<h1 class="section {% if entity.constructors == null or entity.constructors.size == 0 %}empty{% endif %}">
61+
Constructors
62+
</h1>
63+
64+
<div id="entity-constructors" class="entity-section {% if entity.constructors == null or entity.constructors.size == 0 %}empty{% endif %}">
65+
{% for constructor in entity.constructors %}
66+
{% for plist in constructor %}
67+
<div class="member">
68+
<div class="member-title">
69+
<span class="member-name">{{ entity.name }}</span>
70+
<span class="no-left">(</span>
71+
{% if plist.isImplicit %}
72+
<span class="no-left keyword">implicit</span>
73+
{% endif %}
74+
{% for namedRef in plist.list %}
75+
<span class="{% if forloop.first %}no-left{% endif %}">
76+
{{ namedRef.title }}:{% if namedRef.isByName %} =&gt;{% endif %}
77+
</span>
78+
{% renderRef namedRef.ref %}
79+
{% if forloop.last != true %}
80+
<span class="no-left">, </span>
81+
{% endif %}
82+
{% endfor %}
83+
<span class="no-left">)</span>
84+
</div>
85+
</div>
86+
{% endfor %}
87+
{% endfor %}
88+
</div>
89+
90+
<h1 class="section {% if entity.hasVisibleMembers == false %}empty{% endif %}">
91+
Members
92+
</h1>
6193

6294
<div id="entity-members" class="entity-section {% if entity.hasVisibleMembers == false %}empty{% endif %}">
6395
{% for member in entity.members %}

doc-tool/resources/css/api-page.css

Lines changed: 16 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -70,70 +70,70 @@ h1.section {
7070
display: none;
7171
}
7272

73-
div#entity-members > div.member.protected {
73+
div.entity-section > div.member.protected {
7474
display: none;
7575
}
7676

77-
div#entity-members > div.member.private {
77+
div.entity-section > div.member.private {
7878
display: none;
7979
}
8080

81-
div#entity-members > div.member {
81+
div.entity-section > div.member {
8282
margin-bottom: 30px;
8383
}
8484

85-
div#entity-members > div.member:last-child {
85+
div.entity-section > div.member:last-child {
8686
margin-bottom: 0px;
8787
}
8888

89-
div#entity-members > div.member > div.member-title {
89+
div.entity-section > div.member > div.member-title {
9090
font-family: "Source Code Pro", sans-serif;
9191
}
9292

93-
div#entity-members > div.member > div.member-title > span.member-name {
93+
div.entity-section > div.member > div.member-title > span.member-name {
9494
color: #458;
9595
font-weight: 600;
9696
}
9797

98-
div#entity-members > div.member > div.member-title > span.member-name.implicitly-added {
98+
div.entity-section > div.member > div.member-title > span.member-name.implicitly-added {
9999
color: #019875;
100100
}
101101

102-
div#entity-members > div.member > div.member-title span.keyword {
102+
div.entity-section > div.member > div.member-title span.keyword {
103103
font-weight: 600;
104104
margin-right: 11px;
105105
}
106106

107-
div#entity-members > div.member > div.member-title span.no-left {
107+
div.entity-section > div.member > div.member-title span.no-left {
108108
margin-left: -11px;
109109
}
110110

111-
div#entity-members > div.member > div.member-title span.no-right {
111+
div.entity-section > div.member > div.member-title span.no-right {
112112
margin-right: -11px;
113113
}
114114

115-
div#entity-members > div.member > div.member-title > span.expand-button {
115+
div.entity-section > div.member > div.member-title > span.expand-button {
116116
color: rgba(167, 161, 161, 0.5);
117117
}
118118

119-
div#entity-members > div.member > div.member-title > span.expand-button:hover {
119+
div.entity-section > div.member > div.member-title > span.expand-button:hover {
120120
color: rgb(167, 161, 161);
121121
cursor: pointer;
122122
user-select: none;
123123
}
124124

125-
div#entity-members > div.member > div.member-body {
125+
div.entity-section > div.member > div.member-body {
126126
margin: 5px 0 0 39px;
127127
}
128128

129-
div#entity-members > div.member > div.member-body > div.member-body-short.toggled {
129+
div.entity-section > div.member > div.member-body > div.member-body-short.toggled {
130130
display: none;
131131
}
132132

133-
div#entity-members > div.member > div.member-body > div.member-body-long {
133+
div.entity-section > div.member > div.member-body > div.member-body-long {
134134
display: none;
135135
}
136136

137-
div#entity-members > div.member > div.member-body > div.member-body-long.toggled {
137+
div.entity-section > div.member > div.member-body > div.member-body-long.toggled {
138138
display: block;
139139
}

doc-tool/src/dotty/tools/dottydoc/model/JavaConverters.scala

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -70,6 +70,7 @@ object JavaConverters {
7070
"typeParams" -> ent.typeParams.asJava,
7171
"superTypes" -> ent.superTypes.map(_.asJava).asJava,
7272
"comment" -> ent.comment.map(_.asJava).asJava,
73+
"constructors" -> ent.constructors.map(_.map(_.asJava).asJava).asJava,
7374
"isPrivate" -> ent.isPrivate,
7475
"isProtected" -> ent.isProtected,
7576
"hasVisibleMembers" -> ent.hasVisibleMembers,
@@ -90,6 +91,7 @@ object JavaConverters {
9091
"typeParams" -> ent.typeParams.asJava,
9192
"superTypes" -> ent.superTypes.map(_.asJava).asJava,
9293
"comment" -> ent.comment.map(_.asJava).asJava,
94+
"constructors" -> ent.constructors.map(_.map(_.asJava).asJava).asJava,
9395
"isPrivate" -> ent.isPrivate,
9496
"isProtected" -> ent.isProtected,
9597
"hasVisibleMembers" -> ent.hasVisibleMembers,

0 commit comments

Comments
 (0)