diff --git a/src/c_abi/mod.rs b/src/c_abi/mod.rs index 5bbb9e9..72b0a4b 100644 --- a/src/c_abi/mod.rs +++ b/src/c_abi/mod.rs @@ -1,3 +1,4 @@ +//! # Low level bindings to the c library from GROMACS #![allow(non_upper_case_globals, non_camel_case_types)] pub mod xdr_seek; diff --git a/src/iterator.rs b/src/iterator.rs index 5887ece..201dcf8 100644 --- a/src/iterator.rs +++ b/src/iterator.rs @@ -32,11 +32,10 @@ impl IntoIterator for TRRTrajectory { } } -/* -Iterator for trajectories. This iterator yields a Result -for each frame in the trajectory file and stops with yielding None once the -trajectory is finished. Also yields None after the first occurence of an error -*/ +/// Iterator for trajectories. +/// This iterator yields a Result for each frame in the +/// trajectory file and stops with yielding None once the trajectory is +/// EOF. Also yields None after the first occurrence of an error pub struct TrajectoryIterator { trajectory: T, item: Rc, diff --git a/src/lib.rs b/src/lib.rs index d3331c2..e296061 100644 --- a/src/lib.rs +++ b/src/lib.rs @@ -84,6 +84,7 @@ use std::io::SeekFrom; use std::os::raw::{c_float, c_int}; use std::path::{Path, PathBuf}; +/// File Mode for accessing trajectories. #[derive(Debug, Clone, PartialEq)] pub enum FileMode { Write, @@ -233,7 +234,7 @@ pub trait Trajectory { fn get_num_atoms(&mut self) -> Result; } -/// Read/Write XTC Trajectories +/// Handle to Read/Write XTC Trajectories pub struct XTCTrajectory { handle: XDRFile, precision: Cell, // internal mutability required for read method @@ -361,7 +362,7 @@ impl io::Seek for XTCTrajectory { } } -/// Read/Write TRR Trajectories +/// Handle to Read/Write TRR Trajectories pub struct TRRTrajectory { handle: XDRFile, num_atoms: Lazy>,