Skip to content

Commit 16a3517

Browse files
committed
Document SettingDependencies type
1 parent 2778835 commit 16a3517

File tree

1 file changed

+4
-0
lines changed

1 file changed

+4
-0
lines changed

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

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -69,6 +69,10 @@ object Settings:
6969
def validateSettingString(name: String): Unit =
7070
assert(settingCharacters.matches(name), s"Setting string $name contains invalid characters")
7171

72+
/** List of setting-value pairs that are required for another setting to be valid.
73+
* For example, `s = Setting(..., depends = List(YprofileEnabled -> true))`
74+
* means that `s` requires `YprofileEnabled` to be set to `true`.
75+
*/
7276
type SettingDependencies = List[(Setting[?], Any)]
7377

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

0 commit comments

Comments
 (0)