From 2690f2b1ebc73071400096705f86272d88c501ae Mon Sep 17 00:00:00 2001 From: Takeru Ohta Date: Wed, 14 Feb 2018 12:00:41 +0900 Subject: [PATCH] Add documentation --- src/error.rs | 6 ++++-- src/lib.rs | 27 +++++++++++++++++++++------ 2 files changed, 25 insertions(+), 8 deletions(-) diff --git a/src/error.rs b/src/error.rs index f794141..91cebba 100644 --- a/src/error.rs +++ b/src/error.rs @@ -1,12 +1,14 @@ use trackable::error::{ErrorKind as TrackableErrorKind, TrackableError}; +/// This crate specific `Error` type. #[derive(Debug, Clone)] pub struct Error(TrackableError); derive_traits_for_trackable_error_newtype!(Error, ErrorKind); -#[derive(Debug, Clone, Copy, PartialEq, Eq)] +/// Possible error kinds. +#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)] +#[allow(missing_docs)] pub enum ErrorKind { InvalidInput, - Other, } impl TrackableErrorKind for ErrorKind {} diff --git a/src/lib.rs b/src/lib.rs index ac537ed..a293a7a 100644 --- a/src/lib.rs +++ b/src/lib.rs @@ -1,18 +1,33 @@ +//! [HLS] m3u8 parser/generator. +//! +//! [HLS]: https://tools.ietf.org/html/rfc8216 +//! +//! # Examples +//! +//! TODO +#![warn(missing_docs)] #[macro_use] extern crate trackable; pub use error::{Error, ErrorKind}; +pub use master_playlist::MasterPlaylist; +pub use media_playlist::MediaPlaylist; -pub mod attribute; -pub mod master_playlist; -pub mod media_playlist; -pub mod media_segment; -pub mod string; +pub mod segment { + //! Media segment. + pub use super::media_segment::{MediaSegment, MediaSegmentBuilder}; +} pub mod tag; pub mod value; pub mod version; +mod attribute; mod error; -pub mod line; +mod line; +mod master_playlist; +mod media_playlist; +mod media_segment; +mod string; +/// This crate specific `Result` type. pub type Result = std::result::Result;