Bug 1825565 - Fix nsstring rust doc warnings r=emilio DONTBUILD

Differential Revision: https://phabricator.services.mozilla.com/D174121
This commit is contained in:
Manuel Bucher 2023-03-30 15:00:27 +00:00
Родитель 3e41106efa
Коммит c69d4c6ee0
1 изменённых файлов: 8 добавлений и 8 удалений

Просмотреть файл

@ -25,12 +25,12 @@
//! Use `*{const,mut} nsA[C]String` (`{const,} nsA[C]String*` in C++) for
//! function arguments passed across the rust/C++ language boundary.
//!
//! There is currently no Rust equivalent to nsAuto[C]String. Implementing a
//! There is currently no Rust equivalent to `nsAuto[C]String`. Implementing a
//! type that contains a pointer to an inline buffer is difficult in Rust due
//! to its move semantics, which require that it be safe to move a value by
//! copying its bits. If such a type is genuinely needed at some point,
//! https://bugzilla.mozilla.org/show_bug.cgi?id=1403506#c6 has a sketch of how
//! to emulate it via macros.
//! <https://bugzilla.mozilla.org/show_bug.cgi?id=1403506#c6> has a sketch of
//! how to emulate it via macros.
//!
//! # String Types
//!
@ -346,13 +346,13 @@ macro_rules! define_string_types {
begin_writing = $begin_writing: ident, $fallible_begin_writing: ident;
start_bulk_write = $start_bulk_write: ident;
} => {
/// The representation of a ns[C]String type in C++. This type is
/// used internally by our definition of ns[C]String to ensure layout
/// compatibility with the C++ ns[C]String type.
/// The representation of a `ns[C]String` type in C++. This type is
/// used internally by our definition of `ns[C]String` to ensure layout
/// compatibility with the C++ `ns[C]String` type.
///
/// This type may also be used in place of a C++ ns[C]String inside of
/// This type may also be used in place of a C++ `ns[C]String` inside of
/// struct definitions which are shared with C++, as it has identical
/// layout to our ns[C]String type.
/// layout to our `ns[C]String` type.
///
/// This struct will leak its data if dropped from rust. See the module
/// documentation for more information on this type.