Skip to content

Commit c7d1ca1

Browse files
authored
transpile: some doc improvements from #1306 (#1336)
* Split out of #1306.
2 parents e645d39 + 868d133 commit c7d1ca1

File tree

1 file changed

+5
-2
lines changed
  • c2rust-transpile/src/c_ast

1 file changed

+5
-2
lines changed

c2rust-transpile/src/c_ast/mod.rs

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -601,8 +601,8 @@ impl TypedAstContext {
601601
}
602602
}
603603

604-
// Pessimistically try to check if an expression doesn't return. If it does, or we can't tell
605-
/// that it doesn't, return `false`.
604+
/// Pessimistically try to check if an expression doesn't return.
605+
/// If it does, or we can't tell that it doesn't, return `false`.
606606
pub fn expr_diverges(&self, expr_id: CExprId) -> bool {
607607
let func_id = match self.index(expr_id).kind {
608608
CExprKind::Call(_, func_id, _) => func_id,
@@ -1186,6 +1186,9 @@ pub enum OffsetOfKind {
11861186

11871187
/// Represents an expression in C (6.5 Expressions)
11881188
///
1189+
/// This is modeled on Clang's APIs, so where documentation
1190+
/// is lacking here, look at Clang.
1191+
///
11891192
/// We've kept a qualified type on every node since Clang has this information available, and since
11901193
/// the semantics of translations of certain constructs often depend on the type of the things they
11911194
/// are given.

0 commit comments

Comments
 (0)