SI-6626 make @throws tags create links to exceptions#4089
SI-6626 make @throws tags create links to exceptions#4089VladUreche merged 2 commits intoscala:2.11.xfrom
Conversation
There was a problem hiding this comment.
Right, those are pretty unclear; fixed.
e699fcb to
250551b
Compare
|
@gourlaysama, seems the new method prevents the presentation compiler from being compiled: fail - presentation/doc [compilation failed]% scalac doc/doc.scala
doc.scala:42: error: object creation impossible, since method linkName in trait MemberLookupBase of type (link: scala.tools.nsc.doc.base.LinkTo)String is not defined
new Global(settings, compilerReporter) with MemberLookupBase with CommentFactoryBase with doc.ScaladocGlobalTrait {
^(see https://scala-webapps.epfl.ch/jenkins/job/pr-scala-test/7400/console) Can you please address this? |
3af3360 to
f03c102
Compare
|
@VladUreche sorry about that. I should have asked for review after jenkins was finished. I just realized this will break scala-ide too, for the same reason as above: it needs to implement that method to do the right thing... |
In scaladoc, this turns exceptions in @throws tags into links (when it can find the target exception), instead of just showing the name.
- there is no need for explicit links with [[ and ]] - there is no need for explicit backquoting
f03c102 to
9d0d44c
Compare
|
LGTM! Now that the build passes, I can merge. Thanks @gourlaysama! |
…inks SI-6626 make @throws tags create links to exceptions
|
Hi, question about this change: it seems that we get a warning now whenever writing |
|
@lrytz: Yes, it's expected: https://github.com/scala/scala/pull/4089/files#diff-cf5321b0df0af2c25cec233dbb01cc20R352 Ifneedbe we can silence the warning. |
|
I think we should skip the warning for exception classes that are out of the project, it's not so nice to have warnings that you cannot get rid of. |
|
@gourlaysama, can you take care of this? Or should I do it? |
|
@VladUreche Yep I'll take that one. Warnings that aren't actionable are useless... |
In scaladoc, this turns exceptions in
@throwstags into links(when it can find the target exception), instead of just showing
the name.
Review by @VladUreche :)