ScalaDoc: UnOrdered List

There is a listing of wiki-like markup that ScalaDoc supports.  Unfortunately the example of unordered lists was somewhat confusing:

Unordered list item: $ – item becomes a list item ($ signifies the left margin of a line (it doesn’t appear in the code), note the space between the left margin and the dash). More leading space characters are allowed between the left margin and the dash: list items with the same number of leading spaces are at the same level, more space creates sub-levels.

After some struggle; I found the solution.  Here is an example:

 * Example of an unordered list
 *  - item lalala
 *  - item lululu


Here is a ref and ref that I’ve found to be quite helpful (with examples of other options).


keyword bullet lists markdown scaladoc


About Neil Rubens

This entry was posted in Uncategorized. Bookmark the permalink.

Leave a Reply

Your email address will not be published. Required fields are marked *