Skip to content

Commit cc1b7fa

Browse files
committed
Show doc titles in bold
1 parent 20a0596 commit cc1b7fa

File tree

2 files changed

+12
-21
lines changed

2 files changed

+12
-21
lines changed

compiler/src/dotty/tools/dotc/util/ParsedComment.scala

Lines changed: 1 addition & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -202,7 +202,7 @@ object ParsedComment {
202202
case Nil =>
203203
None
204204
case items =>
205-
Some(s"""${heading(title)}:
205+
Some(s"""${bold(title)}
206206
|${fn(ctx, items)}
207207
|""".stripMargin)
208208
}
@@ -212,15 +212,6 @@ object ParsedComment {
212212
private def colorEnabled(implicit ctx: Context): Boolean =
213213
ctx.settings.color.value != "never"
214214

215-
/**
216-
* If the color is enabled, underline `str`, otherwise make it a markdown header by
217-
* prepending `####`.
218-
*/
219-
private def heading(str: String)(implicit ctx: Context): String = {
220-
if (colorEnabled) s"$UNDERLINED$str$RESET"
221-
else s"#### $str"
222-
}
223-
224215
/** Show `str` in bold */
225216
private def bold(str: String)(implicit ctx: Context): String = {
226217
if (colorEnabled) s"$BOLD$str$RESET"

language-server/test/dotty/tools/languageserver/HoverTest.scala

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -129,45 +129,45 @@ class HoverTest {
129129
hoverContent("[T, U](fizz: Int, buzz: String)(implicit ev: Boolean): Any",
130130
"""Does something
131131
|
132-
|#### Type Parameters:
132+
|**Type Parameters**
133133
| - **T** A first type param
134134
| - **U** Another type param
135135
|
136-
|#### Parameters:
136+
|**Parameters**
137137
| - **fizz** Again another number
138138
| - **buzz** A String
139139
| - **ev** An implicit boolean
140140
|
141-
|#### Returns:
141+
|**Returns**
142142
| - Something
143143
|
144-
|#### Throws:
144+
|**Throws**
145145
| - **java.lang.NullPointerException** if you're unlucky
146146
| - **java.lang.InvalidArgumentException** if the argument is invalid
147147
|
148-
|#### See Also:
148+
|**See Also**
149149
| - java.nio.file.Paths#get()
150150
|
151-
|#### Examples:
151+
|**Examples**
152152
| - ```scala
153153
| myFoo.bar[Int, String](0, "hello, world")
154154
| ```
155155
|
156-
|#### Usecases:
156+
|**Usecases**
157157
| - ```scala
158158
| def bar(fizz: Int, buzz: String): Any
159159
| ```
160160
|
161-
|#### Note:
161+
|**Note**
162162
| - A note
163163
|
164-
|#### Authors:
164+
|**Authors**
165165
| - John Doe
166166
|
167-
|#### Since:
167+
|**Since**
168168
| - 0.1
169169
|
170-
|#### Version:
170+
|**Version**
171171
| - 1.0""".stripMargin))
172172

173173
}

0 commit comments

Comments
 (0)