diff options
Diffstat (limited to 'src/liblibc')
| -rw-r--r-- | src/liblibc/lib.rs | 26 |
1 files changed, 12 insertions, 14 deletions
diff --git a/src/liblibc/lib.rs b/src/liblibc/lib.rs index 10610b70584..55f483682b7 100644 --- a/src/liblibc/lib.rs +++ b/src/liblibc/lib.rs @@ -329,20 +329,18 @@ pub mod types { // Standard types that are opaque or common, so are not per-target. pub mod common { pub mod c95 { - /** - Type used to construct void pointers for use with C. - - This type is only useful as a pointer target. Do not use it as a - return type for FFI functions which have the `void` return type in - C. Use the unit type `()` or omit the return type instead. - - For LLVM to recognize the void pointer type and by extension - functions like malloc(), we need to have it represented as i8* in - LLVM bitcode. The enum used here ensures this and prevents misuse - of the "raw" type by only having private variants.. We need two - variants, because the compiler complains about the repr attribute - otherwise. - */ + /// Type used to construct void pointers for use with C. + /// + /// This type is only useful as a pointer target. Do not use it as a + /// return type for FFI functions which have the `void` return type in + /// C. Use the unit type `()` or omit the return type instead. + /// + /// For LLVM to recognize the void pointer type and by extension + /// functions like malloc(), we need to have it represented as i8* in + /// LLVM bitcode. The enum used here ensures this and prevents misuse + /// of the "raw" type by only having private variants.. We need two + /// variants, because the compiler complains about the repr attribute + /// otherwise. #[repr(u8)] pub enum c_void { __variant1, |