Skip to content

Commit a060b64

Browse files
committed
Reorganize docs for wiki links
1 parent 0288354 commit a060b64

File tree

2 files changed

+7
-6
lines changed

2 files changed

+7
-6
lines changed

docs/docs/usage/scaladoc/docComments.md renamed to docs/docs/usage/scaladoc/linkingDocumentation.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
title: API Documentation
2+
title: Linking documentation
33
---
44

55
# {{ page.title }}

docs/docs/usage/scaladoc/scaladocDocstrings.md

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -121,8 +121,9 @@ Scaladoc provides two syntax parsers: `markdown` (default) or `wikidoc`.
121121
122122
#### Markdown
123123
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+
126127
127128
#### Wikidoc
128129
@@ -142,6 +143,8 @@ __underline__
142143
[[https://external.link External Link]], e.g. [[https://scala-lang.org Scala Language Site]]
143144
```
144145
146+
For more info about wiki links look at this [chapter](#linking-to-api)
147+
145148
Other formatting notes
146149
147150
- 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
179182
180183
Further information on the formatting and style recommendations can be found in Scala-lang scaladoc style guide.
181184
182-
183-
184185
## Linking to API
185186
186187
Scaladoc allows linking to API documentation with Wiki-style links. Linking to
187188
`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

Comments
 (0)