Document collect_bounding_regions

rust-lang · bors · May 24, 2020 · May 19, 2020 · May 19, 2020 · May 19, 2020
commit 9754b3fc1d9d24bc1e65136e5798cc5a6d226a4f
diff --git a/src/librustc_infer/infer/lexical_region_resolve/mod.rs b/src/librustc_infer/infer/lexical_region_resolve/mod.rs
@@ -862,6 +862,17 @@ impl<'cx, 'tcx> LexicalResolver<'cx, 'tcx> {
         );
     }
 
+    /// Collects all regions that "bound" the variable `orig_node_idx` in the
+    /// given direction.
+    ///
+    /// If `dup_vec` is `Some` it's used to track duplicates between successive
+    /// calls of this function.
+    ///
+    /// The return tuple fields are:
+    /// - a list of all concrete regions bounding the given region.
+    /// - the set of all region variables bounding the given region.
+    /// - a `bool` that's true if the returned region variables overlap with
+    ///   those returned by a previous call for another region.
     fn collect_bounding_regions(
         &self,
         graph: &RegionGraph<'tcx>,