From: Niko Matsakis <niko@alum.mit.edu>
Date: Wed, 23 Mar 2016 08:21:02 +0000 (-0400)
Subject: Address nit: use doc-comments for fields of VarDecl
X-Git-Url: https://git.lizzy.rs/?a=commitdiff_plain;h=a2bab6f3e1f8b830b311e30a5a154a351a29e001;p=rust.git

Address nit: use doc-comments for fields of VarDecl
---

diff --git a/src/librustc/mir/repr.rs b/src/librustc/mir/repr.rs
index a1688e1464c..2931af2936f 100644
--- a/src/librustc/mir/repr.rs
+++ b/src/librustc/mir/repr.rs
@@ -156,11 +156,21 @@ pub enum BorrowKind {
 /// decl, a let, etc.
 #[derive(Clone, Debug, RustcEncodable, RustcDecodable)]
 pub struct VarDecl<'tcx> {
+    /// `let mut x` vs `let x`
     pub mutability: Mutability,
+
+    /// name that user gave the variable; not that, internally,
+    /// mir references variables by index
     pub name: Name,
+
+    /// type inferred for this variable (`let x: ty = ...`)
     pub ty: Ty<'tcx>,
-    pub scope: ScopeId, // scope in which variable was declared
-    pub span: Span, // span where variable was declared
+
+    /// scope in which variable was declared
+    pub scope: ScopeId,
+
+    /// span where variable was declared
+    pub span: Span,
 }
 
 /// A "temp" is a temporary that we place on the stack. They are