Document modules in hdf5-sys

Author: mulimoen

hdf5-sys/src/h5.rs

@@ -1,3 +1,4 @@
+//! General purpose library functions
 use std::mem;
 
 pub use self::H5_index_t::*;

hdf5-sys/src/h5a.rs

@@ -1,3 +1,4 @@
+//! Creating and manipulating HDF5 attributes
 use std::mem;
 
 use crate::internal_prelude::*;

hdf5-sys/src/h5ac.rs

@@ -1,3 +1,4 @@
+//! Cache functions
 use std::mem;
 
 use crate::internal_prelude::*;

hdf5-sys/src/h5c.rs

@@ -1,3 +1,4 @@
+//! Cache functionality
 pub use self::H5C_cache_decr_mode::*;
 pub use self::H5C_cache_flash_incr_mode::*;
 pub use self::H5C_cache_incr_mode::*;

hdf5-sys/src/h5d.rs

@@ -1,3 +1,4 @@
+//! Creating and manipulating scientific datasets
 pub use self::H5D_alloc_time_t::*;
 pub use self::H5D_fill_time_t::*;
 pub use self::H5D_fill_value_t::*;

hdf5-sys/src/h5e.rs

@@ -1,3 +1,4 @@
+//! Functions for handling errors that occur within HDF5
 use std::mem;
 
 pub use self::H5E_direction_t::*;

hdf5-sys/src/h5f.rs

@@ -1,3 +1,4 @@
+//! Creating and manipulating HDF5 files
 use std::mem;
 
 pub use self::H5F_close_degree_t::*;

hdf5-sys/src/h5fd.rs

@@ -1,3 +1,4 @@
+//! File drivers
 use std::mem;
 
 pub use self::H5FD_file_image_op_t::*;

hdf5-sys/src/h5g.rs

@@ -1,3 +1,4 @@
+//! Creating and manipulating groups of objects inside an HDF5 file
 use std::mem;
 
 pub use self::H5G_storage_type_t::*;

hdf5-sys/src/h5i.rs

@@ -1,3 +1,4 @@
+//! Manipulating object identifiers and object names
 pub use self::H5I_type_t::*;
 
 use crate::internal_prelude::*;

hdf5-sys/src/h5l.rs

@@ -1,3 +1,4 @@
+//! Creating and manipulating links within an HDF5 group
 use std::mem;
 
 pub use self::H5L_type_t::*;

hdf5-sys/src/h5mm.rs

@@ -1,3 +1,4 @@
+//! Memory managment
 use crate::internal_prelude::*;
 
 pub type H5MM_allocate_t =

hdf5-sys/src/h5o.rs

@@ -1,3 +1,4 @@
+//! Manipulating objects in an HDF5 file
 use std::mem;
 
 pub use self::H5O_mcdt_search_ret_t::*;

hdf5-sys/src/h5p.rs

@@ -1,3 +1,4 @@
+//! Creating and manipulating property lists to control HDF5 library behaviour
 use crate::internal_prelude::*;
 
 use crate::h5ac::H5AC_cache_config_t;

hdf5-sys/src/h5pl.rs

@@ -1,3 +1,4 @@
+//! Programmatically controlling dynamically loaded plugins
 use crate::internal_prelude::*;
 
 #[cfg(hdf5_1_8_15)]

hdf5-sys/src/h5r.rs

@@ -1,3 +1,4 @@
+//! Creating and manipulating references to specific objects and data regions in an HDF5 file
 pub use self::H5R_type_t::*;
 
 use crate::internal_prelude::*;

hdf5-sys/src/h5s.rs

@@ -1,3 +1,4 @@
+//! Creating and manipulating dataspaces in which to store elements of a dataset
 pub use self::H5S_class_t::*;
 pub use self::H5S_sel_type::*;
 pub use self::H5S_seloper_t::*;

hdf5-sys/src/h5t.rs

@@ -1,3 +1,4 @@
+//! Creating and manipulating datatypes which describe elements of a dataset
 use std::mem;
 
 pub use self::H5T_bkg_t::*;

hdf5-sys/src/h5vl.rs

@@ -1,3 +1,4 @@
+//! Using the Virtual Object Layer
 #![cfg(hdf5_1_12_0)]
 use crate::internal_prelude::*;
 

hdf5-sys/src/h5z.rs

@@ -1,3 +1,4 @@
+//! Configuring filters that process data during I/O operation
 use std::mem;
 
 pub use self::H5Z_EDC_t::*;

hdf5-sys/src/lib.rs

@@ -1,3 +1,4 @@
+//! Rust bindings to the `hdf5` library for reading and writing data to and from storage
 #![allow(non_camel_case_types, non_snake_case, dead_code, deprecated)]
 #![cfg_attr(feature = "cargo-clippy", allow(clippy::unreadable_literal))]
 #![cfg_attr(feature = "cargo-clippy", allow(clippy::missing_safety_doc))]