| Commit message (Collapse) | Author | Age | Files | Lines |
| |
|
| |
|
|
|
|
|
|
|
|
|
|
| |
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
|
|
|
|
| |
The the word 'the' is often used twice. Fix that.
|
|
|
|
|
| |
The alternative choice was to change "Hide All" to "Hide all" to match existing
capitalization but title case fits for this UI.
|
|\
| |
| |
| |
| | |
janekdb/2.11.x-scaladoc-fix-one-off-dot-restart-note
Align DotRunner dot restart count with command option description
|
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| | |
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.
|
|\ \
| | |
| | |
| | |
| | | |
janekdb/2.11.x-remove-lagged-scaladoc-setttings-notes
Remove notes about -doc-title and -doc-version not being used
|
| |/
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| | |
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"
|
|\ \
| | |
| | |
| | |
| | | |
janekdb/2.11.x-add-missing-scaladoc-commands-to-help-output
Add two missed scaladoc commands into scaladoc specific help section
|
| |/
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| | |
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.
|
|/
|
|
|
|
|
| |
This refactoring extracts data from code into a form which is closer to
configuration data.
This is a step change toward making this configurable.
|
|
|
|
|
| |
renaming the existing ScalaDoc and ScalaDocReporter classes might
break stuff, sadly, but at least we can fix the rest
|
|\
| |
| | |
SI-9429 fix filtering in scaladoc after focusing on a package
|
| |
| |
| |
| |
| |
| |
| |
| |
| |
| | |
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.
|
|\ \
| | |
| | | |
unset inappropriate execute bits
|
| |/
| |
| |
| |
| |
| |
| |
| |
| |
| | |
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
|
|/ |
|
| |
|
|\
| |
| | |
bump copyright year to 2015
|
| |
| |
| |
| |
| | |
(just hitting the highlights here, not worrying yet about bumping the
dates in every modified source file)
|
|\ \
| | |
| | | |
Fix 23 typos (t-v)
|
| |/ |
|
|/ |
|
| |
|
| |
|
|\
| |
| | |
Fix some typos (a-c)
|
| |
| |
| |
| |
| |
| | |
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.
|
| | |
|
|\ \
| | |
| | | |
Doc fixes
|
| |/ |
|
|/
|
|
|
|
|
|
| |
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.
|
|
|
|
|
|
|
|
|
|
| |
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
|
|
|
|
|
|
|
|
|
|
| |
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.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| |
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
|
|\
| |
| | |
[nomerge] SI-7601 Scaladoc: img elements must have an "alt" attribute
|
| |
| |
| |
| |
| |
| | |
This change makes Scaladoc's HTML valid a bit.
Backport of #4407 to 2.11.x
|
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| | |
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`.
|
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| | |
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).
|
|/
|
|
|
|
|
|
|
|
| |
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
|
|
|
|
| |
The selector has been wrong since 0c2614e.
|
|
|
|
|
|
|
|
| |
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.
|
|
|
|
|
|
| |
Tested on:
- Mac: FF35/Safari 8/Chrome 41
- Win: IE11
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| |
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.
|
| |
|
|
|
|
|
|
|
|
|
|
|
|
|
| |
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.
|
|
|
|
|
|
|
|
| |
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.
|
| |
|
|
|
|
|
|
|
|
|
|
|
| |
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.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| |
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.
|