It is sometimes necessary to indent documentation blocks to match the surrounding code format. Documentation blocks erase indentation based on the indentation level of the opening block:
---- The most useful augmentation *ever*. ---- augment java.lang.String { ---- Creates a URL from a string, as in: `let url = "http://foo.bar/plop": toURL()`. ---- function toURL = |this| -> java.net.URL(this) }
When generating documentation from the code above, the documentation block of the toURL
function
is unindented of 2 spaces.