Skip to content

Commit 7afecdf

Browse files
committed
Doc formatting.
1 parent 037f3af commit 7afecdf

File tree

5 files changed

+6
-1
lines changed

5 files changed

+6
-1
lines changed

engine/src/builder.rs

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -155,6 +155,7 @@ impl<CTX: BuilderContext> Builder<'_, CTX> {
155155
/// * You've got usages scattered across files beyond that with the
156156
/// `include_cpp` invocation
157157
/// * You're using `use` statements to rename mods or items. If this
158+
///
158159
/// proves to be a promising or helpful direction, autocxx would be happy
159160
/// to accept pull requests to remove some of these limitations.
160161
pub fn auto_allowlist(mut self, do_it: bool) -> Self {

engine/src/conversion/analysis/fun/function_wrapper.rs

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -80,6 +80,7 @@ impl RustConversionType {
8080
/// * C++ wrapper function converts `std::unique_ptr<std::string>` to just
8181
/// `std::string`
8282
/// * Finally, the actual C++ API receives a `std::string` by value.
83+
///
8384
/// The implementation here is distributed across this file, and
8485
/// `function_wrapper_rs` and `function_wrapper_cpp`.
8586
/// TODO: we should make this into a single enum, with the Type as enum

engine/src/conversion/analysis/fun/mod.rs

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -715,7 +715,8 @@ impl<'a> FnAnalyzer<'a> {
715715
/// to [cxx::UniquePtr]
716716
/// * We'll need a Rust wrapper if we've got a C++ wrapper and it's a method.
717717
/// * We may need wrappers if names conflict.
718-
/// etc.
718+
/// * etc.
719+
///
719720
/// The other major thing we do here is figure out naming for the function.
720721
/// This depends on overloads, and what other functions are floating around.
721722
/// The output of this analysis phase is used by both Rust and C++ codegen.

parser/src/config.rs

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -354,6 +354,7 @@ impl IncludeCppConfig {
354354
/// 1) As directives to bindgen
355355
/// 2) After bindgen has generated code, to filter the APIs which
356356
/// we pass to cxx.
357+
///
357358
/// This second pass may seem redundant. But sometimes bindgen generates
358359
/// unnecessary stuff.
359360
pub fn is_on_allowlist(&self, cpp_name: &str) -> bool {

src/lib.rs

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -375,6 +375,7 @@ macro_rules! subclass {
375375
/// * the 'something else' can't be fully inspected by autocxx, possibly
376376
/// becaue it relies on dependent qualified types or some other template
377377
/// arrangement that bindgen cannot fully understand.
378+
///
378379
/// In such circumstances, autocxx normally has to err on the side of caution
379380
/// and assume that some type within the 'something else' is itself a forward
380381
/// declaration. That means, the opaque typedef won't be storable within

0 commit comments

Comments
 (0)