SI-5795 empty scaladoc tags should be omitted from output#4427
Merged
lrytz merged 3 commits intoscala:2.11.xfrom Apr 9, 2015
Merged
SI-5795 empty scaladoc tags should be omitted from output#4427lrytz merged 3 commits intoscala:2.11.xfrom
lrytz merged 3 commits intoscala:2.11.xfrom
Conversation
Empty scaladoc tags used to completely break the HTML layout of classes and methods. See the difference between before [1] and after [2]. [1]: http://static.gourlaysama.net/img/scaladoc_t5795_before.png [2]: http://static.gourlaysama.net/img/scaladoc_t5795_after.png
Consider the following code: /** * @see * @deprecated */ object Foo The comment parser properly parsed the body of the 'see' tag as empty, but not the one of 'deprecated': it supposedly contains a single character, a newline '\n', which is wrong. This always happened to the last tag in the list; it is always appended a new line (whether empty or not), which breaks formatting (and things later on that test if a body is empty of not).
3f9adbc to
3183c2b
Compare
Empty scaladoc tags, like `@param`, `@return`, `@version`, etc. should
be omitted from the output when they have no meaning by themselves.
They are still parsed, for validation (warning that a tag doesn't
exist and so on), but are removed, if empty, when building the Comment.
The only ones that stay even when empty are `@deprecated`, so that the
class name can be striked-through ("Deprecated" also appears in the
header, even if there is no message with it), and `@throws`.
3183c2b to
293f7c0
Compare
Contributor
|
The IDE job abort issue should be resolved now (scala/scala-jenkins-infra#44). I hit rebuild. |
Contributor
Author
|
review by @VladUreche :) |
Contributor
|
LGTM, thanks @gourlaysama! |
Member
|
Nice! Thanks guys :) |
lrytz
added a commit
that referenced
this pull request
Apr 9, 2015
…rams SI-5795 empty scaladoc tags should be omitted from output
retronym
pushed a commit
to retronym/scala
that referenced
this pull request
Jun 24, 2019
The implicit scope of a.A includes package object a. Document this. Fixes scala#4427.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Empty scaladoc tags, like
@param,@return,@version, etc. shouldbe omitted from the output when they have no meaning by themselves.
They are still parsed, for validation (warning that a tag doesn't
exist and so on), but are removed, if empty, when building the Comment.
The only one that stays even when empty is
@deprecated, so that theclass name can be striked-through. "Deprecated" also appears in the
header, even if there is no message with it.
The first two commits fix two other tag-related bugs in scaladoc, found while fixing this one. See individual commit messages.