diff options
| author | Janek Bogucki <janekdb@gmail.com> | 2016-02-20 20:29:38 +0000 |
|---|---|---|
| committer | Janek Bogucki <janekdb@gmail.com> | 2016-03-04 21:41:37 +0000 |
| commit | 687d3bb116ba50a1935bf7b526a06e99e0eb6952 (patch) | |
| tree | 8f4453151f9a5fac30dd55cd347033a6a8eaa6dc /src/scaladoc/scala | |
| parent | 969a541d34d2d4578c81cbb2f9e061101ac5ccd7 (diff) | |
| download | scala-687d3bb116ba50a1935bf7b526a06e99e0eb6952.tar.gz scala-687d3bb116ba50a1935bf7b526a06e99e0eb6952.tar.bz2 scala-687d3bb116ba50a1935bf7b526a06e99e0eb6952.zip | |
SI-6886: Deprecate -expand-all-types
This Scaladoc flag was added to assist with debugging and was not
intended to have general availability.
If an element requires a separate Scaladoc page add @documentable.
Diffstat (limited to 'src/scaladoc/scala')
| -rw-r--r-- | src/scaladoc/scala/tools/nsc/doc/Settings.scala | 6 |
1 files changed, 5 insertions, 1 deletions
diff --git a/src/scaladoc/scala/tools/nsc/doc/Settings.scala b/src/scaladoc/scala/tools/nsc/doc/Settings.scala index 8a341a92d5..de86acb6d6 100644 --- a/src/scaladoc/scala/tools/nsc/doc/Settings.scala +++ b/src/scaladoc/scala/tools/nsc/doc/Settings.scala @@ -14,6 +14,9 @@ import scala.language.postfixOps * @param printMsg A function that prints the string, without any extra boilerplate of error */ class Settings(error: String => Unit, val printMsg: String => Unit = println(_)) extends scala.tools.nsc.Settings(error) { + // TODO 2.13 Remove + private def removalIn213 = "This flag is scheduled for removal in 2.13. If you have a case where you need this flag then please report a bug." + /** A setting that defines in which format the documentation is output. ''Note:'' this setting is currently always * `html`. */ val docformat = ChoiceSetting ( @@ -199,10 +202,11 @@ class Settings(error: String => Unit, val printMsg: String => Unit = println(_)) "" ) + // TODO 2.13 Remove val docExpandAllTypes = BooleanSetting ( "-expand-all-types", "Expand all type aliases and abstract types into full template pages. (locally this can be done with the @template annotation)" - ) + ) withDeprecationMessage(removalIn213) val docGroups = BooleanSetting ( "-groups", |