Skip to content

Clarifications for List blocks #1260

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jan 27, 2019
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 22 additions & 2 deletions _overviews/scaladoc/for-library-authors.md
Original file line number Diff line number Diff line change
Expand Up @@ -181,8 +181,28 @@ Some of the standard markup available:
subheadings. E.g. `=Heading=`, `==Sub-Heading==`, etc.
- **List blocks** are a sequence of list items with the same style and level,
with no interruptions from other block styles. Unordered lists can be bulleted
using `-`, while numbered lists can be denoted using `1.`, `i.`, `I.`, `a.` for
the various numbering styles.
using `-`; numbered lists can be denoted using `1.`, `i.`, `I.`, or `a.` for the
various numbering styles. In both cases, you must have extra space in front, and
more space makes a sub-level.

The markup for list blocks looks like:

/** Here is an unordered list:
*
* - First item
* - Second item
* - Sub-item to the second
* - Another sub-item
* - Third item
*
* Here is an ordered list:
*
* 1. First numbered item
* 1. Second numbered item
* i. Sub-item to the second
* i. Another sub-item
* 1. Third item
*/

## General Notes for Writing Scaladoc Comments ##

Expand Down