Skip to content

Commit 459bc95

Browse files
committed
Add documentation about the ioctl documentation feature
1 parent e0ed221 commit 459bc95

File tree

1 file changed

+10
-0
lines changed

1 file changed

+10
-0
lines changed

src/sys/ioctl/mod.rs

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -97,6 +97,16 @@
9797
//! Most `ioctl`s have no or little documentation. You'll need to scrounge through
9898
//! the source to figure out what they do and how they should be used.
9999
//!
100+
//! How do I document the generated functions?
101+
//! ==========================================
102+
//!
103+
//! ```
104+
//! ioctl! {
105+
//! /// This is a binding to the blkgetsize64 ioctl
106+
//! read blkgetsize64 with 0x12, 114; u64
107+
//! }
108+
//! ```
109+
//!
100110
#[cfg(any(target_os = "linux", target_os = "android"))]
101111
#[path = "platform/linux.rs"]
102112
#[macro_use]

0 commit comments

Comments
 (0)