From 4b029823567a01d9bace0c1b0048fd4d680ea14b Mon Sep 17 00:00:00 2001 From: Ryan Johnson Date: Fri, 1 Nov 2024 11:18:59 -0700 Subject: [PATCH] doc comment fixes --- src/bindgen/config.rs | 11 ++++++----- 1 file changed, 6 insertions(+), 5 deletions(-) diff --git a/src/bindgen/config.rs b/src/bindgen/config.rs index a8fbb7ac..23901558 100644 --- a/src/bindgen/config.rs +++ b/src/bindgen/config.rs @@ -342,12 +342,13 @@ pub struct ExportConfig { /// Mangling configuration. pub mangle: MangleConfig, /// Whether to instantiate the monomorphs of template types used as function return values. This - /// is needed for C compatibility, because otherwise compilers warn (gcc/clang) or even reject - /// (MSVC) those function definitions. The compensation is made by emitting a single struct with - /// one field for each monomorphized type. The emitted wrapper struct's name can optionally be - /// overridden by [`return_value_monomorphs_struct_name`]. + /// is needed for C compatibility, because otherwise compilers warn (`-Wreturn-type-c-linkage` + /// on gcc/clang) or even reject (MSVC) those function definitions. The compensation is made by + /// emitting a single struct with one field for each monomorphized type. The emitted wrapper + /// struct's name can optionally be overridden by [`return_value_monomorphs_struct_name`]. pub instantiate_return_value_monomorphs: bool, - /// The struct name to use when [`instantiate_monomorphs`] is enabled, ignored otherwise. + /// Overrides the struct name to use when [`instantiate_return_value_monomorphs`] is enabled + /// (ignored otherwise). If not specified, the default is `__cbindgen_return_value_monomorphs`. pub return_value_monomorphs_struct_name: Option, }