Skip to content
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.

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

Fix doc indentation #1375

Merged
merged 2 commits into from
Jun 20, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
1 change: 1 addition & 0 deletions engine/src/builder.rs
Original file line number Diff line number Diff line change
Expand Up @@ -155,6 +155,7 @@ impl<CTX: BuilderContext> Builder<'_, CTX> {
/// * You've got usages scattered across files beyond that with the
/// `include_cpp` invocation
/// * You're using `use` statements to rename mods or items. If this
///
/// proves to be a promising or helpful direction, autocxx would be happy
/// to accept pull requests to remove some of these limitations.
pub fn auto_allowlist(mut self, do_it: bool) -> Self {
Expand Down
1 change: 1 addition & 0 deletions engine/src/conversion/analysis/fun/function_wrapper.rs
Original file line number Diff line number Diff line change
Expand Up @@ -80,6 +80,7 @@ impl RustConversionType {
/// * C++ wrapper function converts `std::unique_ptr<std::string>` to just
/// `std::string`
/// * Finally, the actual C++ API receives a `std::string` by value.
///
/// The implementation here is distributed across this file, and
/// `function_wrapper_rs` and `function_wrapper_cpp`.
/// TODO: we should make this into a single enum, with the Type as enum
Expand Down
3 changes: 2 additions & 1 deletion engine/src/conversion/analysis/fun/mod.rs
Original file line number Diff line number Diff line change
Expand Up @@ -715,7 +715,8 @@ impl<'a> FnAnalyzer<'a> {
/// to [cxx::UniquePtr]
/// * We'll need a Rust wrapper if we've got a C++ wrapper and it's a method.
/// * We may need wrappers if names conflict.
/// etc.
/// * etc.
///
/// The other major thing we do here is figure out naming for the function.
/// This depends on overloads, and what other functions are floating around.
/// The output of this analysis phase is used by both Rust and C++ codegen.
Expand Down
1 change: 1 addition & 0 deletions parser/src/config.rs
Original file line number Diff line number Diff line change
Expand Up @@ -354,6 +354,7 @@ impl IncludeCppConfig {
/// 1) As directives to bindgen
/// 2) After bindgen has generated code, to filter the APIs which
/// we pass to cxx.
///
/// This second pass may seem redundant. But sometimes bindgen generates
/// unnecessary stuff.
pub fn is_on_allowlist(&self, cpp_name: &str) -> bool {
Expand Down
2 changes: 2 additions & 0 deletions src/lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -375,6 +375,7 @@ macro_rules! subclass {
/// * the 'something else' can't be fully inspected by autocxx, possibly
/// becaue it relies on dependent qualified types or some other template
/// arrangement that bindgen cannot fully understand.
///
/// In such circumstances, autocxx normally has to err on the side of caution
/// and assume that some type within the 'something else' is itself a forward
/// declaration. That means, the opaque typedef won't be storable within
Expand Down Expand Up @@ -495,6 +496,7 @@ unsafe impl cxx::ExternType for c_char16_t {
/// If you come across a method, type or function which refers to this type,
/// it indicates that autocxx couldn't generate that binding. A documentation
/// comment should be attached indicating the reason.
#[allow(dead_code)]
pub struct BindingGenerationFailure {
_unallocatable: [*const u8; 0],
_pinned: core::marker::PhantomData<core::marker::PhantomPinned>,
Expand Down
Loading