summaryrefslogtreecommitdiff
path: root/src/scaladoc/scala/tools/nsc/doc/base/CommentFactoryBase.scala
Commit message (Collapse)AuthorAgeFilesLines
* SI-9752 never ignore blank lines when parsing code blocks (#5125)Antoine Gourlay2016-05-021-1/+1
| | | | | The default behavior when parsing the content of a tag text (like after `@example`) was to ignore empty lines. That's fine, except when we are in the middle of a code block, where preserving formatting matters.
* Add doc annotation `@shortDescription` to enable explicit synopsisFelix Mulder2016-02-221-3/+9
| | | | | | | | Entities with this annotation will be able to control what is shown in the method summary on entity pages as well as the hover text on search results. Review: @VladUreche
* SI-9620: add doc annotation to hide specific conversionsFelix Mulder2016-02-091-31/+45
| | | | | | | | | | | This commit will introduce the doc annotation `@hideImplicitConversion`. By specifying which conversions to hide, the user can "toggle" which conversions are kept in the parsed entity. This implementation is a better workaround than hardcoding which ones to ignore when running scaladoc. Review: @VladUreche
* Trim complexity in CommentFactoryBaseJanek Bogucki2016-01-251-18/+16
| | | | | | | | | | 1. Replace option handling with library call 2. Remove NumberFormatException catch presumed to be copy/paste legacy 3. It's Scaladoc 4. Parse trailing whitespace regex once instead of per line 5. Use string interpolation where it improves readability 6. Add missed alternative to block grammar production rule 7. Add regression test for tag requirement warnings
* unset inappropriate execute bitsSeth Tisue2015-09-021-0/+0
| | | | | | | | | | I imagine these date back to old Subversion days and are probably the result of inadvertent commits from Windows users with vcs client configs. having the bit set isn't really harmful most of the time, but it's just not right, and it makes the files stand out in directory listings for no reason
* SI-5795 empty scaladoc tags should be omitted from outputAntoine Gourlay2015-04-021-8/+8
| | | | | | | | | | | | 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`.
* fix scaladoc issue with parsing of empty tagsAntoine Gourlay2015-04-021-7/+10
| | | | | | | | | | | | | | | | | | 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).
* SI-6626 make @throws tags create links to exceptionsAntoine Gourlay2014-11-051-1/+17
| | | | | | In scaladoc, this turns exceptions in @throws tags into links (when it can find the target exception), instead of just showing the name.
* Merge pull request #3951 from pawel-wiejacha/2.11.x_SI-8810_fixGrzegorz Kossakowski2014-09-031-42/+8
|\ | | | | scaladoc: fixed code block indentation normalization
| * SI-8810 scaladoc: fixed code block indentation normalizationPaweł Wiejacha2014-09-031-42/+8
| |
* | SI-8113 allow a newline between a link target and titleAntoine Gourlay2014-09-031-2/+6
| | | | | | | | | | | | | | | | | | | | | | | | | | Parsing "[[http://foo.bar link title]]" stops at the first whitespace. This breaks pretty badly in: [[http://foo.bar link title]] It stops after "link", interprets what it parsed as a link to a member, obviously fails, and then just ouputs "title". It should at least return a proper error, or, even better, just allow a newline between the target and title. I went for the latter.
* | [backport] Update javadoc tag to new scaladoc tags.Masato Sogame2014-08-111-11/+11
|/ | | | (cherry picked from commit 68b16a0992877b4ebbb7c967804edbb72c05ceb5)
* SI-8672 Better end-of-sentence detection for ScaladocJason Zaugg2014-06-201-1/+11
| | | | | | | | | The first sentence of a Scaladoc comment is parsed as the summary. However, this was breaking of the sentence at the first `.`, even if that was immediately followed by another character. This commit only considers a period followed by whitespace, EOL or EOF as the end of a sentence.
* Cull extraneous whitespace.Paul Phillips2013-09-181-3/+0
| | | | | | | | | | | | | | | | | | | | | One last flurry with the broom before I leave you slobs to code in your own filth. Eliminated all the trailing whitespace I could manage, with special prejudice reserved for the test cases which depended on the preservation of trailing whitespace. Was reminded I cannot figure out how to eliminate the trailing space on the "scala> " prompt in repl transcripts. At least reduced the number of such empty prompts by trimming transcript code on the way in. Routed ConsoleReporter's "printMessage" through a trailing whitespace stripping method which might help futureproof against the future of whitespace diseases. Deleted the up-to-40 lines of trailing whitespace found in various library files. It seems like only yesterday we performed whitespace surgery on the whole repo. Clearly it doesn't stick very well. I suggest it would work better to enforce a few requirements on the way in.
* Improve code style in the Scaladoc implementation.Eugene Vigdorchik2013-05-161-7/+7
| | | | | | | | It fixes the following inefficiences or code style violations: - Explicit asInstanceOf calls. - Boxing symbols instead of using plain NoSymbol. - Matching `this` instead of late-binding.
* Eliminate a bunch of -Xlint warnings.Paul Phillips2013-03-121-1/+0
| | | | | | Mostly unused private code, unused imports, and points where an extra pair of parentheses is necessary for scalac to have confidence in our intentions.
* Moved scaladoc sources into separate directory.Paul Phillips2013-03-091-0/+936
This change is not externally visible. It moves the scaladoc sources into src/scaladoc and adds an ant target for building them. The compilation products are still packaged into scala-compiler.jar as before, but with a small change to build.xml a separate jar can be created instead.