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: scala3/scaladoc.md
+8-9Lines changed: 8 additions & 9 deletions
Original file line number
Diff line number
Diff line change
@@ -7,9 +7,9 @@ The new Scala version 3 comes with a completely new implementation of the docume
7
7
In this article you can find highlights of new features that are or will be introduced to Scaladoc.
8
8
For general reference, visit [Scaladoc manual](https://dotty.epfl.ch/docs/usage/scaladoc/)
9
9
10
-
# New features
10
+
##New features
11
11
12
-
## Markdown syntax
12
+
###Markdown syntax
13
13
14
14
The biggest change introduced in the new version of Scaladoc is the change of the default language for docstrings. So far Scaladoc only supported Wikidoc syntax.
15
15
The new Scaladoc can still parse legacy `Wikidoc` syntax, however Markdown has been chosen as a primary language for formatting comments.
@@ -18,7 +18,7 @@ To switch back to `Wikidoc` one can pass a global flag before running the `doc`
18
18
For more information on how to use the full power of docstings, check out [Scaladoc docstrings][scaladoc-docstrings]
19
19
20
20
21
-
## Static site
21
+
###Static site
22
22
23
23
Scaladoc also provides an easy way for creating **static sites** for both documentation and blog posts in the similar way as Jekyll does.
24
24
Thanks to this feature, you can store your documentation along-side with the generated Scaladoc API in a very convenient way.
@@ -27,23 +27,23 @@ For more information on how to configure the generation of static sites check ou
Blog posts are a specific type of static sites. In the Scaladoc manual you can find additional information about how to work with [blog posts][built-in-blog].
The following features are currently (May 2021) not stable to be released with scaladoc, however we are happy to hear your feedback. Each feature has its own thread at scala-lang contributors site, where you can share your opinions.
45
45
46
-
## Snippets compiler
46
+
###Snippets compiler
47
47
48
48
One of the experimental features of Scaladoc will be a snippets compiler. This tool will allow you to compile snippets that you attach to your docstring
49
49
to check that they actually behave as intended, e. g. compile or throw some exception. The feature is very similar to `tut` or `mdoc` tools,
@@ -54,7 +54,7 @@ For more information you can follow this [thread](https://contributors.scala-lan
Haskell programmers are probably familiar with [Hoogle](https://hoogle.haskell.org/) - a documentation search engine that allows you to find functions by their signatures rather than their symbolic names. Since many Scala developers are also functional programming fans, we decided to add a similar functionality to Scaladoc.
60
60
@@ -67,7 +67,6 @@ This feature is provided by [Inkuire](https://github.com/VirtusLab/Inkuire) sear
67
67
Note that this feature is still in development, so it can be subject to considerable change.
68
68
If You encounter a bug or have an idea for improvement don't hesitate to create an issue on [Inkuire](https://github.com/VirtusLab/Inkuire/issues/new) or [dotty](https://github.com/lampepfl/dotty/issues/new).
69
69
70
-
### How it works
71
70
72
71
Using this feature allows to find `def`s and `val`s from the documented code.
0 commit comments