Skip to content

Commit 81935f3

Browse files
authored
Merge pull request #187 from CodaFi/docsense
Fixup the documentation for TargetData.align
2 parents fe4167c + e3845a3 commit 81935f3

File tree

1 file changed

+9
-7
lines changed

1 file changed

+9
-7
lines changed

Sources/LLVM/TargetData.swift

Lines changed: 9 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -173,13 +173,15 @@ public class TargetData {
173173
return cachedLayout
174174
}
175175

176-
/// Returns the next integer (mod 2**64) that is greater than or equal to
177-
/// \p Value and is a multiple of \p Align. \p Align must be non-zero.
178-
///
179-
/// If non-zero \p Skew is specified, the return value will be a minimal
180-
/// integer that is greater than or equal to \p Value and equal to
181-
/// \p Align * N + \p Skew for some integer N. If \p Skew is larger than
182-
/// \p Align, its value is adjusted to '\p Skew mod \p Align'.
176+
/// Returns the next integer (mod 2^64) that is greater than or equal to
177+
/// the given size value and is a multiple of the given alignment value.
178+
/// The alignment must be non-zero.
179+
///
180+
/// If a non-zero skew value is specified, the return value will be a minimal
181+
/// integer that is greater than or equal to the given size value and equal to
182+
/// `align * n + skew` for some integer `n`. If the given skew value is
183+
/// larger than the given alignment value, its value is adjusted to
184+
/// `skew mod alignment`.
183185
///
184186
/// Computes the next size value that is greater than or equal to the given
185187
/// value and is a multiple of the given alignment.

0 commit comments

Comments
 (0)