Skip to content

Commit f6c6003

Browse files
authored
Merge pull request #2134 from jmdavis/dstyle2
Adjust section for ddoc comments in style guide.
2 parents 1b408f8 + 2448c48 commit f6c6003

File tree

1 file changed

+3
-3
lines changed

1 file changed

+3
-3
lines changed

dstyle.dd

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -421,9 +421,9 @@ bool isPositive(int number)
421421
}
422422
---
423423
$(LI Text in sections (e.g. `Params:`, `Returns:`, `See_Also`) should be indented by one level if it spans more than the line of the section.)
424-
$(LI Documentation comments should not use more than two stars `/**` in the header line.)
425-
$(LI Block comments (`/**`) should be used - not nesting block comments (`/++`))
426-
$(LI Global functions shouldn't indent their documentation block nor use stars as indentation.)
424+
$(LI Documentation comments should not use more than two stars `/**` or two pluses `/++` in the header line.)
425+
$(LI Either Block comments (`/**`) or nesting block comments (`/++`) should be used except when the ddoc comment is a ditto comment such as `/// Ditto`)
426+
$(LI Documentation comments should not have leading stars or zeroes on each line.)
427427
$(LI Text example blocks should use three dashes (`---`) only.)
428428
)
429429

0 commit comments

Comments
 (0)