Skip to content

transpile: some doc improvements from #1306 #1336

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Aug 21, 2025
Merged

transpile: some doc improvements from #1306 #1336

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
6669e05
transpile: fix doc comment for `fn TypedAstContext::expr_diverges`
kkysen Aug 21, 2025
868d133
transpile: clarify in `enum CExprKind` docs that it's modeled on Clan…
kkysen Aug 21, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 5 additions & 2 deletions c2rust-transpile/src/c_ast/mod.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -601,8 +601,8 @@ impl TypedAstContext {
}
}

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

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