diff options
| author | Kevin Mehall <km@kevinmehall.net> | 2013-07-10 08:53:49 -0400 |
|---|---|---|
| committer | Kevin Mehall <km@kevinmehall.net> | 2013-07-10 08:55:14 -0400 |
| commit | 663a9597b24f841f44e560e2478225353dbcec30 (patch) | |
| tree | 752c1e9e0380b6cb424cb18ccb86c533f1414b45 | |
| parent | 8fa09736efcd100ec675a2fe0e29906607996485 (diff) | |
| download | rust-663a9597b24f841f44e560e2478225353dbcec30.tar.gz rust-663a9597b24f841f44e560e2478225353dbcec30.zip | |
Document std::libc::c_void.
| -rw-r--r-- | src/libstd/libc.rs | 7 |
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 {} |
