summaryrefslogtreecommitdiff
path: root/src/scaladoc
Commit message (Collapse)AuthorAgeFilesLines
* Fix 27 typos (p-r)Janek Bogucki2015-06-306-7/+7
|
* Fix 36 typos (d-f)Janek Bogucki2015-06-212-2/+2
|
* Merge pull request #4559 from janekdb/2.11.x-scaladoc-2Seth Tisue2015-06-184-9/+9
|\ | | | | Fix some typos (a-c)
| * Fix another several typosMichał Pociecha2015-06-184-6/+6
| | | | | | | | | | | | I just used text search to check whether there are no more typos like these corrected by janekdb, and by the way fixed also some other ones which I saw.
| * Fix some typos (a-c)Janek Bogucki2015-06-182-3/+3
| |
* | Merge pull request #4539 from vsalvis/vsalvis-docfixesSeth Tisue2015-06-181-1/+0
|\ \ | | | | | | Doc fixes
| * | SI-6131 doc: remove broken show member link from all scaladoc pagesvsalvis2015-06-171-1/+0
| |/
* / SI-9354 ScalaDoc members added via by-name viewSom Snytt2015-06-141-2/+6
|/ | | | | | | | Eligible views were looked up by exact from type without including the by-name dodge. By-name views are now included without consideration whether ScalaDoc processes possible duplicates correctly.
* SI-9144 Scaladoc: Make generated HTML files POSIX-compatible text filesKato Kazuyoshi2015-05-271-0/+1
| | | | | | | | | | According POSIX, every text file contains characters organized into zero or more lines [1], and every line must be terminated by "\n" [2]. This change makes Scaladoc's HTML files POSIX-compatible text files. [1] http://pubs.opengroup.org/onlinepubs/9699919799/basedefs/V1_chap03.html#tag_03_397 [2] http://pubs.opengroup.org/onlinepubs/9699919799/basedefs/V1_chap03.html#tag_03_206
* Remove unused, mostly commented out doc/html/page/Source.scalaMichał Pociecha2015-05-021-127/+0
| | | | | | | | | | This file seems to be some early, unfinished draft. It's unused and mostly commented out. De facto it hasn't been changed since this version: https://github.com/scala/scala/blob/d9e3dde6d6d18b9a93e7566447cc3ee342f033d5/src/compiler/scala/tools/nsc/doc/html/page/Source.scala Just in meantime someone updated imports, moved it to other package etc. but nothing more.
* SI-4476 add an index of deprecated members to scaladocAntoine Gourlay2015-04-225-3/+74
| | | | | | | | | | | | | | | | The deprecated list is only emitted if there actually are deprecated members; same for the link in the left sidebar. We just build on the existing index support, with an additional method to avoid having to go through the whole index if we won't generate the page anyway. The deprecated list page itself is completely identical to the normal index pages, except we don't strike through any entry (there are *all* deprecated already). There is just about enough space in the left sidebar for the deprecated link, see [1], and [2] for when there are no deprecated members. [1]: http://static.gourlaysama.net/img/scaladoc-deprecated.png [2]: http://static.gourlaysama.net/img/scaladoc-deprecated-empty.png
* Merge pull request #4428 from kzys/7601-img-alt-211Lukas Rytz2015-04-092-17/+36
|\ | | | | [nomerge] SI-7601 Scaladoc: img elements must have an "alt" attribute
| * [nomerge] SI-7601 Scaladoc: img elements must have an "alt" attributeKato Kazuyoshi2015-04-022-17/+36
| | | | | | | | | | | | This change makes Scaladoc's HTML valid a bit. Backport of #4407 to 2.11.x
* | 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).
* | fix Scaladoc html display when there are empty tagsAntoine Gourlay2015-04-021-0/+2
|/ | | | | | | | | | 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
* [nomerge] SI-8940 Scaladoc: Fix "Order by Alphabetical" buttonKato Kazuyoshi2015-04-011-1/+1
| | | | The selector has been wrong since 0c2614e.
* SI-9038 fix scaladoc syntax highlightning to leave unicode aloneAntoine Gourlay2015-03-261-17/+17
| | | | | | | | Syntax highlightning in code blocks used to manipulate the raw bytes of a String, converting them to chars when needed, which breaks Unicode surrogate pairs. Using a char array instead of a byte array will leave them alone.
* Scaladoc js location synch more robustAdriaan Moors2015-02-201-1/+1
| | | | | | Tested on: - Mac: FF35/Safari 8/Chrome 41 - Win: IE11
* SI-9164 Fix thread safety of Scaladoc diagram generatorJason Zaugg2015-02-195-40/+18
| | | | | | | | | | | | | | In a bug reminiscent of SI-7603 / ab8a223, when running multiple instances of Scaladoc in one JVM/classloader, we are exposed to race conditions in unprotected mutable state in a top-level object. This commit moves that state into the `Universe` object, which corresponds to a single Scaladoc instance. It also removes a little premature abstraction from the code. Note: the statistics code is still not thread safe, but this is no worse than the compiler itself, and not a real problem, as they are only enabled begind a `-Y` option.
* SI-9148: Appends companion type to link tooltipsJustinPihony2015-02-122-3/+15
|
* Fix many typos in docs and commentsmpociecha2014-12-143-3/+3
| | | | | | | | | | | | | This commit corrects many typos found in scaladocs, comments and documentation. It should reduce a bit number of PRs which fix one typo. There are no changes in the 'real' code except one corrected name of a JUnit test method and some error messages in exceptions. In the case of typos in other method or field names etc., I just skipped them. Obviously this commit doesn't fix all existing typos. I just generated in IntelliJ the list of potential typos and looked through it quickly.
* SI-9006 Scaladoc: explicit companion and package linksDick Wall2014-11-263-1/+35
| | | | | | | | The existing navigation mechanisms have proved hard to discover for newcomers to Scaladoc. This commit adds textual links in the navigation bar to the docs of the companion (if defined) and to those of the enclosing package.
* No list of subclasses for Any in scaladoc, it's useless.Antoine Gourlay2014-11-151-1/+1
|
* SI-8948 resurrect the scaladoc for Any/AnyRef/Nothing/Null.Antoine Gourlay2014-11-151-1/+2
| | | | | | | | | | | They disappeared in dc1cd96 when `scala.tools.nsc.doc.DocParser` lost its `override def forScaladoc = true`, which used to trigger whether to parse `DocDef` nodes. This was deprecated in favor of a custom global when scaladoc was modularized out (#2226), but `DocParser` didn't get it since it didn't override `forScaladoc` anymore... I added back `forScaladoc` in `DocParser` for consistency with `ScaladocGlobal`, although it doesn't do anything anymore.
* SI-5730 hide constructors of sealed abstract classes in scaladocAntoine Gourlay2014-11-071-2/+4
| | | | | | | | | | | | | | Sealed abstract classes (like `List`) have a primary constructor, public by default. It can never be called by external code but it shows up in the scaladoc as a nice `new List()` construtor... If a class is only abstract, the constructor is still useful because people can subclass and call it. If it is only sealed (i.e. effectively final), then it is the normal constructor of a final class. But sealed *and* abstract makes documenting the constructor useless. This should remove the misleading constructors of `List`, `Double`, `Option` and others from the scaladoc.
* SI-6626 make @throws tags create links to exceptionsAntoine Gourlay2014-11-053-5/+23
| | | | | | In scaladoc, this turns exceptions in @throws tags into links (when it can find the target exception), instead of just showing the name.
* Make Scaladoc actually exit with non-zero exit code in case of errors,David Turner2014-10-041-9/+11
| | | | as its docs say it does.
* 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.
* | Merge remote-tracking branch 'upstream/2.11.x' into backportsLukas Rytz2014-08-261-3/+4
|\ \ | | | | | | | | | | | | Conflicts: src/library/scala/util/matching/Regex.scala
| * | Regularize `comment` hook methodAdriaan Moors2014-07-171-3/+4
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | This is currently pretty borken, but let's at least not clutter innocent interfaces with this functionality. Moved `comment` (as `signalParsedDocComment`) next to the other hook methods in `Global`. For now, it calls the old `reporter.comment` hook method. As soon as the IDE is refactored to receive comments properly, the deprecated `Reporter#comment` method can be removed.
* | | [backport] Rewrite explanation of doc-source-url option more clearly, and ↵Masato Sogame2014-08-111-1/+1
| | | | | | | | | | | | | | | | | | fix encoding to show euro-sign correctly. (cherry picked from commit 13054daa658484df30b71447dbe684f475537252)
* | | [backport] Update javadoc tag to new scaladoc tags.Masato Sogame2014-08-112-11/+12
|/ / | | | | | | (cherry picked from commit 68b16a0992877b4ebbb7c967804edbb72c05ceb5)
* | Merge pull request #3792 from som-snytt/issue/8525Lukas Rytz2014-07-161-1/+1
|\ \ | | | | | | SI-8525 -Xlint:nowarn-missing-interpolator
| * | SI-8525 No anonymous lintSom Snytt2014-07-101-1/+1
| | | | | | | | | | | | | | | | | | | | | | | | | | | Turn anonymous references to `settings.lint` into named settings. After that, trust to Adriaan to make them filterable. There are a few remaining top-level -Y lint warnings that are deprecated.
* | | Merge pull request #3883 from gourlaysama/wip/t8557Vlad Ureche2014-07-152-2/+2
|\ \ \ | |/ / |/| | SI-8557 make scaladoc normalize paths of external jars.
| * | SI-8557 make scaladoc normalize paths of external jars.Antoine Gourlay2014-07-152-2/+2
| | | | | | | | | | | | | | | | | | Scaladoc compares (string representations of) the paths from -doc-external-doc and the paths form `sym.underlyingSource`. We now normalize on both ends before comparing them.
* | | Rip out reporting indirection from CompilationUnitAdriaan Moors2014-07-041-3/+3
| |/ |/| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Inline the forwarders from CompilationUnit, which should not affect behavior. Since all forwarders lead to global.reporter, don't first navigate to a compilation unit, only to then forward back to global.reporter. The cleanup in the previous commits revealed a ton of confusion regarding how to report an error. This was a mechanical search/replace, which has low potential for messing things up, since the list of available methods are disjoint between `reporter` and `currentRun.reporting`. The changes involving `typer.context` were done previously. Essentially, there are three ways to report: - via typer.context, so that reporting can be silenced (buffered) - via global.currentRun.reporting, which summarizes (e.g., deprecation) - via global.reporter, which is (mostly) stateless and straightforward. Ideally, these should all just go through `global.currentRun.reporting`, with the typing context changing that reporter to buffer where necessary. After the refactor, these are the ways in which we report (outside of typer): - reporter.comment - reporter.echo - reporter.error - reporter.warning - currentRun.reporting.deprecationWarning - currentRun.reporting.incompleteHandled - currentRun.reporting.incompleteInputError - currentRun.reporting.inlinerWarning - currentRun.reporting.uncheckedWarning Before: - c.cunit.error - c.enclosingUnit.deprecationWarning - context.unit.error - context.unit.warning - csymCompUnit.warning - cunit.error - cunit.warning - currentClass.cunit.warning - currentIClazz.cunit.inlinerWarning - currentRun.currentUnit.error - currentRun.reporting - currentUnit.deprecationWarning - currentUnit.error - currentUnit.warning - getContext.unit.warning - getCurrentCUnit.error - global.currentUnit.uncheckedWarning - global.currentUnit.warning - global.reporter - icls.cunit.warning - item.cunit.warning - reporter.comment - reporter.echo - reporter.error - reporter.warning - reporting.deprecationWarning - reporting.incompleteHandled - reporting.incompleteInputError - reporting.inlinerWarning - reporting.uncheckedWarning - typer.context.unit.warning - unit.deprecationWarning - unit.echo - unit.error - unit.incompleteHandled - unit.incompleteInputError - unit.uncheckedWarning - unit.warning - v1.cunit.warning All these methods ended up calling a method on `global.reporter` or on `global.currentRun.reporting` (their interfaces are disjoint). Also clean up `TypeDiagnostics`: inline nearly-single-use private methods.
* | SI-8292 report error when scaladoc fails to find doclet.Antoine Gourlay2014-07-011-3/+3
| |
* | 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.
* | SI-8591 Scaladoc: Problem with scrolling under Safari on iOSMarcin Kubala2014-05-161-0/+1
|/
* Merge pull request #3685 from VladUreche/issue/8514-masterJason Zaugg2014-04-211-3/+0
|\ | | | | SI-8514 Remove scaladoc html inconsistencies
| * SI-8514 Remove scaladoc html inconsistenciesVlad Ureche2014-04-181-3/+0
| | | | | | | | Some classes only got inline comments instead of getting the full comment.
* | SI-8144 permalinks in scaladocMarcin Kubala2014-03-147-49/+168
|/
* SI-8407 "symbol not found" in Scaladoc use cases: warning onlyJason Zaugg2014-03-131-1/+1
| | | | | | | | | | | | | | | The refactoring in aedec1980 mistakenly used the non-silent typer to typecheck the use cases. It temptingly had the desired type (`ScalaDocAnalyzer`), but sadly the wrong properties (it will report errors, rather than buffer.) This meant that "symbol not found" errors in use cases would prevent Scaladoc generation. This commit introduces a little downcast on the silent typer. A more principled approach would be to go through the rigmarole of the virtual class pattern for `Analzyer.Typer`, but that will have to remain work for another day.
* Fix typo in log message.Daniel Darabos2014-03-031-1/+1
|
* SI-8229 Source compatible name for implicit any2stringaddJason Zaugg2014-02-181-1/+1
| | | | | | | | | | To support the established pattern for disabling it for an compilation unit. Update scaladoc's knowledge of our "typeclasses". Leave a `private[scala]` version of `StringAdd` (public in bytecode) to ensure binary compatibility with 2.11.0-M8 for partest.
* SI-4014 Scaladoc omits @authorKonstantin Fedorov2014-02-022-2/+15
|
generated by cgit v1.2.3 (git 2.39.1) at 2024-07-15 13:10:56 +0000