You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/docs/usage/scaladoc/scaladocDocstrings.md
+6-5Lines changed: 6 additions & 5 deletions
Original file line number
Diff line number
Diff line change
@@ -121,8 +121,9 @@ Scaladoc provides two syntax parsers: `markdown` (default) or `wikidoc`.
121
121
122
122
#### Markdown
123
123
124
-
Markdown uses commonmark flavour to parse docstring, however it can understand `wikidoc` links.
125
-
For more info about wiki links look at this [chapter](#linking-to-api)
124
+
Markdown uses commonmark flavour with extension of `wikidoc` links for referencing convenience.
125
+
Recent commonmark flavour rules can be found [here](https://commonmark.org/)
126
+
126
127
127
128
#### Wikidoc
128
129
@@ -142,6 +143,8 @@ __underline__
142
143
[[https://external.link External Link]], e.g. [[https://scala-lang.org Scala Language Site]]
143
144
```
144
145
146
+
For more info about wiki links look at this [chapter](#linking-to-api)
147
+
145
148
Other formatting notes
146
149
147
150
- Paragraphs are started with one (or more) blank lines. `*` in the margin for the comment is valid (and should be included) but the line should be blank otherwise.
@@ -179,10 +182,8 @@ More details on writing Scaladoc
179
182
180
183
Further information on the formatting and style recommendations can be found in Scala-lang scaladoc style guide.
181
184
182
-
183
-
184
185
## Linking to API
185
186
186
187
Scaladoc allows linking to API documentation with Wiki-style links. Linking to
187
188
`scala.collection.immutable.List` is as simple as
188
-
`[[scala.collection.immutable.List]]`. For more information on the exact syntax, see [doc comment documentation](./docComments.html#definition-links).
189
+
`[[scala.collection.immutable.List]]`. For more information on the exact syntax, see [doc comment documentation](./linkingDocumentation.html#definition-links).
0 commit comments