Commit 2e3cc7b
authored
Fix some of the scaladoc links (#295)
* Fix some of the scaladoc links
If ones removes the line `Compile / doc / sources := Nil,` from the
build and run `sbt doc` one get warnings like:
```
[warn] -- Warning: modules/deriving/src/main/scala/shapeless3/deriving/kinds.scala:66:7
[warn] 66 | type Kind[M <: Mirror, O <: Up] = (M of O) { type Kind = self.type }
[warn] | ^
[warn] | Couldn't resolve a member for the given link query: Mirror
```
Based on the dicussion in scala/scala3#20028
my understanding is that this means that scaldoc can not resolve the
existing link.
The reason I want to fix this is that it will also show up for users
implementing custom `Kinds`. E.g in some private project where I extends
Kind I get warnings like this in my scaladoc:
```
[warn] -- Warning: modules/deriving/src/main/scala/shapeless3/deriving/kinds.scala:66:7
[warn] Couldn't resolve a member for the given link query: Mirror
```
(the error changed slighlty in the latest Scala 3 version). Since I
don't think this is solvable for a user I suggest that we just make the
links absolute which seems to solve the warnings.
* No longer exclude all sources from scaladoc
* Fix shapeless.Annotations links1 parent 8e75af7 commit 2e3cc7b
File tree
3 files changed
+12
-13
lines changed- modules/deriving/src/main/scala/shapeless3/deriving
3 files changed
+12
-13
lines changed| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
141 | 141 | | |
142 | 142 | | |
143 | 143 | | |
144 | | - | |
145 | 144 | | |
146 | 145 | | |
147 | 146 | | |
| |||
Lines changed: 3 additions & 3 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
153 | 153 | | |
154 | 154 | | |
155 | 155 | | |
156 | | - | |
| 156 | + | |
157 | 157 | | |
158 | 158 | | |
159 | 159 | | |
| |||
211 | 211 | | |
212 | 212 | | |
213 | 213 | | |
214 | | - | |
| 214 | + | |
215 | 215 | | |
216 | 216 | | |
217 | 217 | | |
| |||
267 | 267 | | |
268 | 268 | | |
269 | 269 | | |
270 | | - | |
| 270 | + | |
271 | 271 | | |
272 | 272 | | |
273 | 273 | | |
| |||
Lines changed: 9 additions & 9 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
55 | 55 | | |
56 | 56 | | |
57 | 57 | | |
58 | | - | |
| 58 | + | |
59 | 59 | | |
60 | 60 | | |
61 | 61 | | |
62 | 62 | | |
63 | 63 | | |
64 | 64 | | |
65 | | - | |
| 65 | + | |
66 | 66 | | |
67 | 67 | | |
68 | | - | |
| 68 | + | |
69 | 69 | | |
70 | 70 | | |
71 | | - | |
| 71 | + | |
72 | 72 | | |
73 | 73 | | |
74 | | - | |
| 74 | + | |
75 | 75 | | |
76 | 76 | | |
77 | 77 | | |
78 | 78 | | |
79 | 79 | | |
80 | | - | |
| 80 | + | |
81 | 81 | | |
82 | 82 | | |
83 | 83 | | |
| |||
126 | 126 | | |
127 | 127 | | |
128 | 128 | | |
129 | | - | |
| 129 | + | |
130 | 130 | | |
131 | 131 | | |
132 | 132 | | |
133 | 133 | | |
134 | | - | |
| 134 | + | |
135 | 135 | | |
136 | 136 | | |
137 | 137 | | |
138 | | - | |
| 138 | + | |
139 | 139 | | |
140 | 140 | | |
141 | 141 | | |
| |||
0 commit comments