enum BZFILE: document

trifectatechfoundation · Nov 8, 2024 · 76b9eed · 76b9eed
1 parent 045a193
commit 76b9eed
Showing 1 changed file with 13 additions and 0 deletions.
diff --git a/bzlib.rs b/bzlib.rs
@@ -460,6 +460,19 @@ impl<T> DSlice<T> {
     }
 }
 
+/// Abstract handle to a `.bz2` file.
+///
+/// This type is created by:
+///
+/// - [`BZ2_bzReadOpen`]
+/// - [`BZ2_bzWriteOpen`]
+/// - [`BZ2_bzopen`]
+///
+/// And destructed by:
+///
+/// - [`BZ2_bzReadClose`]
+/// - [`BZ2_bzWriteClose`]
+/// - [`BZ2_bzclose`]
 pub enum BZFILE {}
 
 #[allow(non_camel_case_types)]