summaryrefslogtreecommitdiff
path: root/src/scaladoc
Commit message (Collapse)AuthorAgeFilesLines
* Typesafe -> Lightbend in more placesSeth Tisue2016-03-042-2/+2
|
* bump copyright year to 2016Seth Tisue2016-02-031-1/+1
|
* 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
* Fix some simple extra wordsEitan Adler2016-01-172-4/+4
| | | | The the word 'the' is often used twice. Fix that.
* Apply title case to Scaladoc buttons: By Inheritance & Show AllJanek Bogucki2015-12-151-2/+2
| | | | | The alternative choice was to change "Hide All" to "Hide all" to match existing capitalization but title case fits for this UI.
* Merge pull request #4860 from ↵Lukas Rytz2015-11-241-5/+5
|\ | | | | | | | | janekdb/2.11.x-scaladoc-fix-one-off-dot-restart-note Align DotRunner dot restart count with command option description
| * Align DotRunner dot restart count with command option descriptionJanek Bogucki2015-11-231-5/+5
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | This is the command option description, val docDiagramsDotRestart = IntSetting( "-diagrams-dot-restart", "The number of times to restart a malfunctioning dot process before disabling diagrams (default: 5)", 5, None, _ => None ) Prior to this change dot was restarted four times instead of five. Maybe the intention of the option was to allow a total number of attempts to be specified but with 5 restarts we need 6 attempts. The local var was renamed to reflect this.
* | Merge pull request #4849 from ↵Lukas Rytz2015-11-231-2/+2
|\ \ | | | | | | | | | | | | janekdb/2.11.x-remove-lagged-scaladoc-setttings-notes Remove notes about -doc-title and -doc-version not being used
| * | Remove notes about -doc-title and -doc-version not being usedJanek Bogucki2015-11-181-2/+2
| |/ | | | | | | | | | | | | | | | | | | | | | | | | Confirmed these options are used by editing build-ant-macros.xml and viewing the output, <scaladoc docRootContent="${src.dir}/@{project}/${@{project}.docroot}" destdir="${build-docs.dir}/@{project}" - doctitle="${@{project}.description}" + doctitle="${@{project}.description} - test-title" docfooter="epfl" - docversion="${version.number}" + docversion="${version.number} - test-version"
* | Merge pull request #4850 from ↵Lukas Rytz2015-11-231-1/+2
|\ \ | | | | | | | | | | | | janekdb/2.11.x-add-missing-scaladoc-commands-to-help-output Add two missed scaladoc commands into scaladoc specific help section
| * | Add two missed scaladoc commands into scaladoc specific help sectionJanek Bogucki2015-11-181-1/+2
| |/ | | | | | | | | | | | | | | | | | | | | | | Prior to this change these scaladoc options were buried in the scalac section of the help text, -doc-external-doc -implicits-sound-shadowing With this change the options are listed in the scaladoc section. This will make the commands easier to discover.
* / Refactor excluded qname test to be more data likeJanek Bogucki2015-11-201-11/+23
|/ | | | | | | This refactoring extracts data from code into a form which is closer to configuration data. This is a step change toward making this configurable.
* it's Scaladoc, not "ScalaDoc" or "Scala doc"Seth Tisue2015-11-122-3/+3
| | | | | renaming the existing ScalaDoc and ScalaDocReporter classes might break stuff, sadly, but at least we can fix the rest
* Merge pull request #4736 from gourlaysama/ticket/t9429Lukas Rytz2015-09-211-1/+11
|\ | | | | SI-9429 fix filtering in scaladoc after focusing on a package
| * SI-9429 fix filtering in scaladoc after focusing on a packageAntoine Gourlay2015-09-151-1/+11
| | | | | | | | | | | | | | | | | | | | The scaladoc left pane used to be refreshed too often until ce5cfd2 when it was changed to only refresh when the filter changed. This forgot one important case when it also must be refreshed: when entering the "focus on a single package" mode (and it has been broken ever since). This forces a refresh when focusing on a package, and makes sure all entities are displayed when filtering.
* | Merge pull request #4727 from SethTisue/unset-stray-execute-bitsSeth Tisue2015-09-1410-0/+0
|\ \ | | | | | | unset inappropriate execute bits
| * | unset inappropriate execute bitsSeth Tisue2015-09-0210-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
* / fix assorted typosSeth Tisue2015-08-281-1/+1
|/
* Fix typos in spec, docs and commentsMichał Pociecha2015-08-231-1/+1
|
* Merge pull request #4644 from SethTisue/copyright-2015Lukas Rytz2015-07-231-1/+1
|\ | | | | bump copyright year to 2015
| * bump copyright year to 2015Seth Tisue2015-07-171-1/+1
| | | | | | | | | | (just hitting the highlights here, not worrying yet about bumping the dates in every modified source file)
* | Merge pull request #4631 from janekdb/2.11.x-typos-t-vSeth Tisue2015-07-202-2/+2
|\ \ | | | | | | Fix 23 typos (t-v)
| * | Fix 23 typos (t-v)Janek Bogucki2015-07-152-2/+2
| |/
* / SI-9409 Scaladoc: remove link to nonexistent diagram docSeth Tisue2015-07-181-1/+0
|/
* 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.
generated by cgit v1.2.3 (git 2.39.1) at 2024-07-26 14:20:10 +0000