Rollup merge of #61686 - phansch:librustc_errors_docs, r=estebank

[rust.git] / src / librustc_errors / emitter.rs

diff --git a/src/librustc_errors/emitter.rs b/src/librustc_errors/emitter.rs
index 3bf477efe35f91f05eb08e4bedb02ba8cb596ed9..fca8298409a61f5add93a7a787e6c4f6ba04cda2 100644 (file)
--- a/src/librustc_errors/emitter.rs
+++ b/src/librustc_errors/emitter.rs
@@ -1,3 +1,12 @@
+//! The current rustc diagnostics emitter.
+//!
+//! An `Emitter` takes care of generating the output from a `DiagnosticBuilder` struct.
+//!
+//! There are various `Emitter` implementations that generate different output formats such as
+//! JSON and human readable output.
+//!
+//! The output types are defined in `librustc::session::config::ErrorOutputType`.
+
 use Destination::*;
 
 use syntax_pos::{SourceFile, Span, MultiSpan};