Skip to content

Commit dc10c53

Browse files
committed
Document SettingDependencies type
1 parent 592a892 commit dc10c53

File tree

1 file changed

+4
-0
lines changed

1 file changed

+4
-0
lines changed

compiler/src/dotty/tools/dotc/config/Settings.scala

+4
Original file line numberDiff line numberDiff line change
@@ -73,6 +73,10 @@ object Settings:
7373
def validateSettingString(name: String): Unit =
7474
assert(settingCharacters.matches(name), s"Setting string $name contains invalid characters")
7575

76+
/** List of setting-value pairs that are required for another setting to be valid.
77+
* For example, `s = Setting(..., depends = List(YprofileEnabled -> true))`
78+
* means that `s` requires `YprofileEnabled` to be set to `true`.
79+
*/
7680
type SettingDependencies = List[(Setting[?], Any)]
7781

7882
case class Setting[T: ClassTag] private[Settings] (

0 commit comments

Comments
 (0)