Do numbered lists actually work in ScalaDoc markup?

Documentation
1

Having spent a fair while trying to get bullet lists working in my ScalaDoc, I’m prepping a small PR for this page, to clarify that you need spaces in front of the bullet items. So far, so good.

But while I’m at it, I decided to also try out numbered lists (to see if that bit of doc also needs work), and I can’t get those working at all. If I try something like:

  * Here is some text, to break things up.
  *
  *   1. First item
  *   2. Second item

the resulting ScalaDoc simply looks like:

Here is some text, to break things up.

1. First item 2. Second item

Note that that second line is a numbered list – but all of the elements are being squished together onto the same item, and nothing obvious is fixing that.

Does anybody have any idea what’s going on here? Am I missing something, or is numbered-list markup simply broken?

2

I think you have to repeat the first number, for example:

/**
  * Here is some text, to break things up.
  *
  *   1. First item
  *   1. Second item
  */
2 Likes
3

Ah. Okay, that’s reasonable but not obvious unless you’ve used it in other wikitexts. (I rarely use numbered lists myself.) Also worth documenting. Thanks!

1 Like