auto merge of #7690 : kevinmehall/rust/document-c_void, r=huonw

I added documentation for when to use and not to use `c_void`, since it tripped me up when I started. (See issue #7627)

1 files changed, 7 insertions, 0 deletions

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 {}