about summary refs log tree commit diff
diff options
context:
space:
mode:
authorNicholas Nethercote <n.nethercote@gmail.com>2024-01-05 10:49:35 +1100
committerNicholas Nethercote <n.nethercote@gmail.com>2024-01-05 10:49:35 +1100
commit453fface11dbe314fcdf1e0558ad084600c0b1f5 (patch)
tree43e96b20ec6742951992cdd029102e54f6927110
parentc4d63c7f760d23c2f5c509fa08a0b0afd34fd6fb (diff)
downloadrust-453fface11dbe314fcdf1e0558ad084600c0b1f5.tar.gz
rust-453fface11dbe314fcdf1e0558ad084600c0b1f5.zip
Add some comments to `Emitter`.
There are three functions only used for the JSON format.
-rw-r--r--compiler/rustc_errors/src/emitter.rs8
1 files changed, 5 insertions, 3 deletions
diff --git a/compiler/rustc_errors/src/emitter.rs b/compiler/rustc_errors/src/emitter.rs
index 3f0fd559b60..987832e6937 100644
--- a/compiler/rustc_errors/src/emitter.rs
+++ b/compiler/rustc_errors/src/emitter.rs
@@ -196,13 +196,15 @@ pub trait Emitter: Translate {
     fn emit_diagnostic(&mut self, diag: &Diagnostic);
 
     /// Emit a notification that an artifact has been output.
-    /// This is currently only supported for the JSON format,
-    /// other formats can, and will, simply ignore it.
+    /// Currently only supported for the JSON format.
     fn emit_artifact_notification(&mut self, _path: &Path, _artifact_type: &str) {}
 
+    /// Emit a report about future breakage.
+    /// Currently only supported for the JSON format.
     fn emit_future_breakage_report(&mut self, _diags: Vec<Diagnostic>) {}
 
-    /// Emit list of unused externs
+    /// Emit list of unused externs.
+    /// Currently only supported for the JSON format.
     fn emit_unused_externs(
         &mut self,
         _lint_level: rustc_lint_defs::Level,