Skip to content

Commit 933a994

Browse files
committed
Add doc comments in rustc_middle::mir
1 parent 3dcb616 commit 933a994

File tree

1 file changed

+4
-1
lines changed
  • compiler/rustc_middle/src/mir

1 file changed

+4
-1
lines changed

compiler/rustc_middle/src/mir/mod.rs

+4-1
Original file line numberDiff line numberDiff line change
@@ -1156,6 +1156,8 @@ impl BasicBlock {
11561156
///////////////////////////////////////////////////////////////////////////
11571157
// BasicBlockData
11581158

1159+
/// Data for a basic block, including a list of its statements.
1160+
///
11591161
/// See [`BasicBlock`] for documentation on what basic blocks are at a high level.
11601162
#[derive(Clone, Debug, TyEncodable, TyDecodable, HashStable, TypeFoldable, TypeVisitable)]
11611163
pub struct BasicBlockData<'tcx> {
@@ -1187,7 +1189,7 @@ impl<'tcx> BasicBlockData<'tcx> {
11871189
/// Accessor for terminator.
11881190
///
11891191
/// Terminator may not be None after construction of the basic block is complete. This accessor
1190-
/// provides a convenience way to reach the terminator.
1192+
/// provides a convenient way to reach the terminator.
11911193
#[inline]
11921194
pub fn terminator(&self) -> &Terminator<'tcx> {
11931195
self.terminator.as_ref().expect("invalid terminator state")
@@ -1394,6 +1396,7 @@ impl<O: fmt::Debug> fmt::Debug for AssertKind<O> {
13941396
///////////////////////////////////////////////////////////////////////////
13951397
// Statements
13961398

1399+
/// A statement in a basic block, including information about its source code.
13971400
#[derive(Clone, TyEncodable, TyDecodable, HashStable, TypeFoldable, TypeVisitable)]
13981401
pub struct Statement<'tcx> {
13991402
pub source_info: SourceInfo,

0 commit comments

Comments
 (0)