Hides FFIConverterTypes from cargo doc

name1e5s · Nov 26, 2021 · c9a7d19 · c9a7d19
1 parent adfa195
commit c9a7d19
Show file tree

Hide file tree

Showing 4 changed files with 5 additions and 0 deletions.
diff --git a/uniffi_bindgen/src/scaffolding/templates/EnumTemplate.rs b/uniffi_bindgen/src/scaffolding/templates/EnumTemplate.rs
@@ -7,6 +7,7 @@
 // public so other crates can refer to it via an `[External='crate'] typedef`
 #}
 
+#[doc(hidden)]
 pub struct {{ e.type_()|ffi_converter_name }};
 
 #[doc(hidden)]

diff --git a/uniffi_bindgen/src/scaffolding/templates/ErrorTemplate.rs b/uniffi_bindgen/src/scaffolding/templates/ErrorTemplate.rs
@@ -7,6 +7,7 @@
 // public so other crates can refer to it via an `[External='crate'] typedef`
 #}
 
+#[doc(hidden)]
 pub struct {{ e.type_()|ffi_converter_name }};
 
 #[doc(hidden)]

diff --git a/uniffi_bindgen/src/scaffolding/templates/ExternalTypesTemplate.rs b/uniffi_bindgen/src/scaffolding/templates/ExternalTypesTemplate.rs
@@ -21,6 +21,7 @@ trait UniffiCustomTypeWrapper {
 {%- endif -%}
 
 // Type `{{ name }}` wraps a `{{ prim.canonical_name() }}`
+#[doc(hidden)]
 pub struct FfiConverterType{{ name }};
 
 unsafe impl uniffi::FfiConverter for FfiConverterType{{ name }} {

diff --git a/uniffi_bindgen/src/scaffolding/templates/RecordTemplate.rs b/uniffi_bindgen/src/scaffolding/templates/RecordTemplate.rs
@@ -7,6 +7,8 @@
 // We define a unit-struct to implement the trait to sidestep Rust's orphan rule (ADR-0006). It's
 // public so other crates can refer to it via an `[External='crate'] typedef`
 #}
+
+#[doc(hidden)]
 pub struct {{ rec.type_()|ffi_converter_name }};
 
 #[doc(hidden)]