From 663a9597b24f841f44e560e2478225353dbcec30 Mon Sep 17 00:00:00 2001 From: Kevin Mehall Date: Wed, 10 Jul 2013 08:53:49 -0400 Subject: [PATCH] Document std::libc::c_void. --- src/libstd/libc.rs | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/src/libstd/libc.rs b/src/libstd/libc.rs index 2518ba1a73d..32dd3264c03 100644 --- a/src/libstd/libc.rs +++ b/src/libstd/libc.rs @@ -186,6 +186,13 @@ 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. + */ pub enum c_void {} pub enum FILE {} pub enum fpos_t {}