Skip to content

Commit 10b6831

Browse files
authored
Merge pull request scala#1260 from jducoeur/jducoeur-patch-1
Clarifications for List blocks
2 parents a613231 + 5f0b43f commit 10b6831

File tree

1 file changed

+22
-2
lines changed

1 file changed

+22
-2
lines changed

_overviews/scaladoc/for-library-authors.md

Lines changed: 22 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -181,8 +181,28 @@ Some of the standard markup available:
181181
subheadings. E.g. `=Heading=`, `==Sub-Heading==`, etc.
182182
- **List blocks** are a sequence of list items with the same style and level,
183183
with no interruptions from other block styles. Unordered lists can be bulleted
184-
using `-`, while numbered lists can be denoted using `1.`, `i.`, `I.`, `a.` for
185-
the various numbering styles.
184+
using `-`; numbered lists can be denoted using `1.`, `i.`, `I.`, or `a.` for the
185+
various numbering styles. In both cases, you must have extra space in front, and
186+
more space makes a sub-level.
187+
188+
The markup for list blocks looks like:
189+
190+
/** Here is an unordered list:
191+
*
192+
* - First item
193+
* - Second item
194+
* - Sub-item to the second
195+
* - Another sub-item
196+
* - Third item
197+
*
198+
* Here is an ordered list:
199+
*
200+
* 1. First numbered item
201+
* 1. Second numbered item
202+
* i. Sub-item to the second
203+
* i. Another sub-item
204+
* 1. Third item
205+
*/
186206

187207
## General Notes for Writing Scaladoc Comments ##
188208

0 commit comments

Comments
 (0)