middle: comment -> doc comment

davidtwco · davidtwco · commit 2991a7c71539 · 2022-09-07T11:10:11.000+01:00
Drive-by change of a regular comment to a documentation comment on
`TyCtxt::is_suitable_region`.

Signed-off-by: David Wood &lt;david.wood@huawei.com&gt;
diff --git a/compiler/rustc_middle/src/ty/context.rs b/compiler/rustc_middle/src/ty/context.rs
@@ -1596,7 +1596,7 @@ impl<'tcx> TyCtxt<'tcx> {
         })
     }
 
-    // Returns the `DefId` and the `BoundRegionKind` corresponding to the given region.
+    /// Returns the `DefId` and the `BoundRegionKind` corresponding to the given region.
     pub fn is_suitable_region(self, region: Region<'tcx>) -> Option<FreeRegionInfo> {
         let (suitable_region_binding_scope, bound_region) = match *region {
             ty::ReFree(ref free_region) => {

Original file line number	Diff line number	Diff line change
`@@ -1596,7 +1596,7 @@ impl<'tcx> TyCtxt<'tcx> {`
`1596`	`1596`	`})`
`1597`	`1597`	`}`
`1598`	`1598`
`1599`		- // Returns the `DefId` and the `BoundRegionKind` corresponding to the given region.
	`1599`	+ /// Returns the `DefId` and the `BoundRegionKind` corresponding to the given region.
`1600`	`1600`	`pub fn is_suitable_region(self, region: Region<'tcx>) -> Option<FreeRegionInfo> {`
`1601`	`1601`	`let (suitable_region_binding_scope, bound_region) = match *region {`
`1602`	`1602`	`ty::ReFree(ref free_region) => {`