@@ -37,7 +37,7 @@ that starts with a `/**` and ends with a `*/`, like this:
37
37
* left margin is on the same column on the
38
38
* first line and on subsequent ones.
39
39
*
40
- * The closing scaladoc tag goes on its own,
40
+ * The closing Scaladoc tag goes on its own,
41
41
* separate line. E.g.
42
42
*
43
43
* Calculate the square of the given number
@@ -71,7 +71,7 @@ include:
71
71
- ` @return ` detail the return value from a method (one per method).
72
72
73
73
74
- ### Constructor and/or Class tags
74
+ ### Method, Constructor and/or Class tags
75
75
- ` @throws ` what exceptions (if any) the method or constructor may throw.
76
76
- ` @param ` detail a value parameter for a method or constructor, provide one
77
77
per parameter to the method/constructor.
@@ -118,7 +118,7 @@ If a comment is not provided for an entity at the current inheritance level, but
118
118
is supplied for the overridden entity at a higher level in the inheritance
119
119
hierarchy, the comment from the super-class will be used.
120
120
121
- Likewise if ` @param ` , ` @tparam ` , ` @return ` and other entity tags are ommitted
121
+ Likewise if ` @param ` , ` @tparam ` , ` @return ` and other entity tags are omitted
122
122
but available from a superclass, those comments will be used.
123
123
124
124
### Explicit
@@ -133,8 +133,8 @@ not necessary most of the time as Markdown styles may be used instead.
133
133
Some of the standard Markdown formatting available:
134
134
135
135
`monospace`
136
- `` italic text``
137
- ``` bold text```
136
+ '' italic text''
137
+ ''' bold text'''
138
138
__underline__
139
139
^superscript^
140
140
,,subscript,,
0 commit comments