File tree Expand file tree Collapse file tree 1 file changed +8
-1
lines changed Expand file tree Collapse file tree 1 file changed +8
-1
lines changed Original file line number Diff line number Diff line change @@ -28,8 +28,15 @@ The general format for a Scaladoc comment should be as follows:
28
28
*/
29
29
def myMethod = {}
30
30
31
+ An alternative Scaladoc comment style right-aligns the column of asterisks
32
+ under the second asterisk, in the third column.
33
+ The Scaladoc tool also accepts Javadoc comment formatting,
34
+ with text following the single asterisks, separated by a single space.
35
+ Because the comment markup is sensitive to whitespace,
36
+ the tool must be able to infer the left margin.
37
+
31
38
For methods and other type members where the only documentation needed
32
- is a simple, short description, this format can be used:
39
+ is a simple, short description, a one-line format can be used:
33
40
34
41
/** Does something very simple */
35
42
def simple = {}
You can’t perform that action at this time.
0 commit comments