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
A mapping is of the form '\<regex>::\[scaladoc3|scaladoc|javadoc]::\<path>'. You can supply several mappings, separated by commas, as shown in the example.
84
+
A mapping is of the form `<regex>::[scaladoc3|scaladoc|javadoc]::<path>`. You can supply several mappings, separated by commas, as shown in the example.
Valid values are of the form: `\[github|twitter|gitter|discord]::link`. Scaladoc also supports `custom::link::white_icon_name::black_icon_name`. In this case icons must be present in `images/` directory.
92
+
Valid values are of the form: `[github|twitter|gitter|discord]::link`. Scaladoc also supports `custom::link::white_icon_name::black_icon_name`. In this case icons must be present in `images/` directory.
94
93
95
94
##### -skip-by-id
96
95
@@ -157,9 +156,9 @@ where `path` is a prefix of the path to source files where snippets are located
157
156
If the path is not present, the argument will be used as the default for all unmatched paths.
158
157
159
158
Available flags:
160
-
compile - Enables snippet checking.
161
-
nocompile - Disables snippet checking.
162
-
fail - Enables snippet checking, asserts that snippet doesn't compile.
159
+
-compile - Enables snippet checking.
160
+
-nocompile - Disables snippet checking.
161
+
-fail - Enables snippet checking, asserts that snippet doesn't compile.
163
162
164
163
The fail flag comes in handy for snippets that present that some action would eventually fail during compilation, e. g. [Opaques page]({{ site.scala3ref }}/other-new-features/opaques.html)
165
164
@@ -169,9 +168,9 @@ Example usage:
169
168
170
169
Which means:
171
170
172
-
all snippets in files under directory `my/path/nc` should not be compiled at all
173
-
all snippets in files under directory `my/path/f` should fail during compilation
174
-
all other snippets should compile successfully
171
+
-all snippets in files under directory `my/path/nc` should not be compiled at all
172
+
-all snippets in files under directory `my/path/f` should fail during compilation
0 commit comments