Add some missing docs and bump version to 0.1.2

behnam · behnam · commit ff16df12ede9 · 2017-06-20T14:53:58.000-06:00
diff --git a/Cargo.toml b/Cargo.toml
@@ -1,6 +1,6 @@
 [package]
 name = "unic"
-version = "0.1.1"
+version = "0.1.2"
 authors = ["The UNIC Project Developers"]
 homepage = "https://github.com/behnam/rust-unic/"
 repository = "https://github.com/behnam/rust-unic/"
@@ -13,10 +13,10 @@ readme = "README.md"
 [workspace]
 
 [dependencies]
-unic-ucd = { path = "components/ucd/", version = "0.1.1" }
+unic-ucd = { path = "components/ucd/", version = "0.1.2" }
 unic-bidi = { path = "components/bidi/", version = "0.1.0" }
-unic-idna = { path = "components/idna/", version = "0.1.1" }
-unic-normal = { path = "components/normal/", version = "0.1.0" }
+unic-idna = { path = "components/idna/", version = "0.1.0" }
+unic-normal = { path = "components/normal/", version = "0.1.2" }
 
 [features]
 default = []
diff --git a/README.md b/README.md
@@ -5,6 +5,7 @@ https://github.com/behnam/rust-unic
 [![Travis](https://img.shields.io/travis/behnam/rust-unic.svg)](https://travis-ci.org/behnam/rust-unic/)
 [![Crates.io](https://img.shields.io/crates/v/unic.svg)](https://crates.io/crates/unic)
 [![Documentation](https://docs.rs/unic/badge.svg)](https://docs.rs/unic/)
+[![Unicode-9.0.0](https://img.shields.io/badge/unicode-9.0.0-red.svg)](http://www.unicode.org/versions/Unicode9.0.0/)
 
 **UNIC** is a project to develop components for the Rust programming language
 to provide high-quality and easy-to-use crates for Unicode
diff --git a/components/bidi/src/level.rs b/components/bidi/src/level.rs
@@ -33,7 +33,10 @@ use unic_ucd_bidi::BidiClass;
 #[cfg_attr(feature = "with_serde", derive(Serialize, Deserialize))]
 pub struct Level(u8);
 
+/// LTR level with smallest number value (0).
 pub const LTR_LEVEL: Level = Level(0);
+
+/// RTL level with smallest number value (0).
 pub const RTL_LEVEL: Level = Level(1);
 
 const MAX_DEPTH: u8 = 125;
@@ -191,6 +194,7 @@ impl Level {
         }
     }
 
+    /// Create a `Vec<Level>` from a slice of `u8` numbers
     pub fn vec(v: &[u8]) -> Vec<Level> {
         v.iter().map(|&x| x.into()).collect()
     }
diff --git a/components/bidi/src/lib.rs b/components/bidi/src/lib.rs
@@ -10,12 +10,13 @@
 // except according to those terms.
 
 
-#![forbid(unsafe_code)]
-
+#![forbid(unsafe_code, missing_docs)]
 
 //! # UNIC — Unicode Bidirectional Algorithm
 //!
-//! This UNIC component implements algorithms from [Unicode® Standard Annex #9 - Unicode
+//! A component of [`unic`: Unicode and Internationalization Crates for Rust](/unic/).
+//!
+//! This UNIC component implements algorithms from [Unicode Standard Annex #9 - Unicode
 //! Bidirectional Algorithm](http://unicode.org/reports/tr9/), a.k.a.  *UBA*, used for display of
 //! mixed right-to-left and left-to-right text.  It is written in safe Rust, compatible with the
 //! current stable release.
diff --git a/components/idna/punycode/src/lib.rs b/components/idna/punycode/src/lib.rs
@@ -9,6 +9,14 @@
 // option. This file may not be copied, modified, or distributed
 // except according to those terms.
 
+
+#![deny(unsafe_code)]
+#![forbid(missing_docs)]
+
+//! # UNIC — IDNA — Punycode (RFC 3492)
+//!
+//! A component of [`unic`: Unicode and Internationalization Crates for Rust](/unic/).
+//!
 //! Implementation of Punycode ([RFC 3492](http://tools.ietf.org/html/rfc3492)) algorithm.
 //!
 //! Since Punycode fundamentally works on Unicode Code-Points,
@@ -150,6 +158,7 @@ pub fn encode_str(input: &str) -> Option<String> {
 ///
 /// Return None on overflow, which can only happen on inputs that would take more than
 /// 63 encoded bytes, the DNS limit on domain name labels.
+#[allow(unsafe_code)]
 pub fn encode(input: &[char]) -> Option<String> {
     // Handle "basic" (ASCII) code points. They are encoded as-is.
     let output_bytes = input
diff --git a/components/idna/src/lib.rs b/components/idna/src/lib.rs
@@ -9,9 +9,15 @@
 // option. This file may not be copied, modified, or distributed
 // except according to those terms.
 
+
+#![forbid(unsafe_code)]
+#![deny(missing_docs)]
+
 //! # UNIC — Unicode IDNA Compatibility Processing
 //!
-//! This UNIC component implements algorithms from [Unicode® Technical Standard #46 - Unicode IDNA
+//! A component of [`unic`: Unicode and Internationalization Crates for Rust](/unic/).
+//!
+//! This UNIC component implements algorithms from [Unicode Technical Standard #46 - Unicode IDNA
 //! Compatibility Processing](http://unicode.org/reports/tr46/).
 //!
 //! Quoting from [UTS #46’s introduction](http://www.unicode.org/reports/tr46/#Introduction):
@@ -67,8 +73,10 @@ pub const PKG_NAME: &'static str = env!("CARGO_PKG_NAME");
 pub const PKG_DESCRIPTION: &'static str = env!("CARGO_PKG_DESCRIPTION");
 
 
+/// Prefix used in Punycode encoding.
 pub static PUNYCODE_PREFIX: &'static str = "xn--";
 
+
 fn map_char(codepoint: char, flags: Flags, output: &mut String, errors: &mut Vec<Error>) {
     match *find_char(codepoint) {
         Mapping::Valid => output.push(codepoint),
@@ -360,13 +368,16 @@ fn processing(domain: &str, flags: Flags, errors: &mut Vec<Error>) -> String {
     validated
 }
 
+/// Optional settings for processing and conversion algorithms.
 #[derive(Copy, Clone)]
+#[allow(missing_docs)]
 pub struct Flags {
     pub use_std3_ascii_rules: bool,
     pub transitional_processing: bool,
     pub verify_dns_length: bool,
 }
 
+/// Error types recorded during UTS #46 processing.
 #[derive(PartialEq, Eq, Clone, Copy, Debug)]
 enum Error {
     PunycodeError,
diff --git a/components/normal/Cargo.toml b/components/normal/Cargo.toml
@@ -1,6 +1,6 @@
 [package]
 name = "unic-normal"
-version = "0.1.0"
+version = "0.1.2"
 authors = ["The UNIC Project Developers"]
 homepage = "https://github.com/behnam/rust-unic/"
 repository = "https://github.com/behnam/rust-unic/"
@@ -11,4 +11,4 @@ categories = ["parsing", "rendering", "encoding", "development-tools"]
 readme = "README.md"
 
 [dependencies]
-unic-ucd-normal = { path = "../ucd/normal/", version = "0.1" }
+unic-ucd-normal = { path = "../ucd/normal/", version = "0.1.2" }
diff --git a/components/normal/src/lib.rs b/components/normal/src/lib.rs
@@ -1,18 +1,22 @@
-// Copyright 2012-2015 The Rust Project Developers. See the COPYRIGHT
-// file at the top-level directory of this distribution and at
-// http://rust-lang.org/COPYRIGHT.
+// Copyright 2012-2015 The Rust Project Developers.
+// Copyright 2017 The UNIC Project Developers.
+//
+// See the COPYRIGHT file at the top-level directory of this distribution.
 //
 // Licensed under the Apache License, Version 2.0 <LICENSE-APACHE or
 // http://www.apache.org/licenses/LICENSE-2.0> or the MIT license
 // <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your
 // option. This file may not be copied, modified, or distributed
 // except according to those terms.
 
+
 #![forbid(unsafe_code, missing_docs)]
 
 //! # UNIC — Unicode Normalization Forms
 //!
-//! This UNIC component implements algorithms from [Unicode® Standard Annex #15 - Unicode
+//! A component of [`unic`: Unicode and Internationalization Crates for Rust](/unic/).
+//!
+//! This UNIC component implements algorithms from [Unicode Standard Annex #15 - Unicode
 //! Normalization Forms](http://unicode.org/reports/tr15/).
 //!
 //! ```rust
diff --git a/components/ucd/Cargo.toml b/components/ucd/Cargo.toml
@@ -1,6 +1,6 @@
 [package]
 name = "unic-ucd"
-version = "0.1.1"
+version = "0.1.2"
 authors = ["The UNIC Project Developers"]
 homepage = "https://github.com/behnam/rust-unic/"
 repository = "https://github.com/behnam/rust-unic/"
@@ -12,5 +12,5 @@ readme = "README.md"
 [dependencies]
 unic-ucd-core = { path = "core/", version = "0.1.1" }
 unic-ucd-bidi = { path = "bidi/", version = "0.1.1" }
-unic-ucd-normal = { path = "normal/", version = "0.1.1" }
+unic-ucd-normal = { path = "normal/", version = "0.1.2" }
 unic-ucd-utils = { path = "utils/", version = "0.1.1" }
diff --git a/components/ucd/bidi/src/lib.rs b/components/ucd/bidi/src/lib.rs
@@ -11,7 +11,12 @@
 
 
 #![forbid(unsafe_code)]
+#![deny(missing_docs)]
 
+//! # UNIC — UCD — Bidi
+//!
+//! A component of [`unic`: Unicode and Internationalization Crates for Rust](/unic/).
+//!
 //! Accessor for `Bidi_Class` property from Unicode Character Database (UCD)
 
 
diff --git a/components/ucd/bidi/src/tables/mod.rs b/components/ucd/bidi/src/tables/mod.rs
@@ -20,6 +20,7 @@ pub const UNICODE_VERSION: (u64, u64, u64) = include!("unicode_version.rsv");
 /// * http://www.unicode.org/reports/tr9/#Bidirectional_Character_Types
 /// * http://www.unicode.org/reports/tr44/#Bidi_Class_Values
 #[derive(Clone, Copy, Debug, PartialEq, Eq)]
+#[allow(missing_docs)]
 // Compare with `bidi_class_type.rsv`
 pub enum BidiClass {
     AL,
diff --git a/components/ucd/bidi/src/traits.rs b/components/ucd/bidi/src/traits.rs
@@ -12,10 +12,19 @@
 use super::{bidi_class, BidiClass, is_explicit, is_rtl};
 
 
+/// Methods for bidi properties of character types.
 pub trait BidiChar {
+
+    /// Get `BidiClass` of the character.
     fn bidi_class(self) -> BidiClass;
+
+    /// Whether the character is an *explicit* bidi formatting character.
     fn is_explicit(self) -> bool;
+
+    /// Whether the character has *left-to-right* (LTR) bidi directionality.
     fn is_ltr(self) -> bool;
+
+    /// Whether the character has *right-to-left* (RTL) bidi directionality.
     fn is_rtl(self) -> bool;
 }
 
@@ -42,9 +51,16 @@ impl BidiChar for char {
 }
 
 
+/// Methods for bidi properties of string types.
 pub trait BidiStr {
+
+    /// Whether the string has any *explicit* bidi formatting character.
     fn has_explicit(&self) -> bool;
+
+    /// Whether the string has any character with *left-to-right* (LTR) bidi directionality.
     fn has_ltr(&self) -> bool;
+
+    /// Whether the string has any character with *right-to-left* (RTL) bidi directionality.
     fn has_rtl(&self) -> bool;
 }
 
diff --git a/components/ucd/core/src/lib.rs b/components/ucd/core/src/lib.rs
@@ -9,8 +9,12 @@
 // except according to those terms.
 
 
-#![forbid(unsafe_code)]
+#![forbid(unsafe_code, missing_docs)]
 
+//! # UNIC — UCD — Core
+//!
+//! A component of [`unic`: Unicode and Internationalization Crates for Rust](/unic/).
+//!
 //! Core create indicating the version of Unicode Character Database.
 
 
diff --git a/components/ucd/normal/Cargo.toml b/components/ucd/normal/Cargo.toml
@@ -1,6 +1,6 @@
 [package]
 name = "unic-ucd-normal"
-version = "0.1.1"
+version = "0.1.2"
 authors = ["The UNIC Project Developers"]
 homepage = "https://github.com/behnam/rust-unic/"
 repository = "https://github.com/behnam/rust-unic/"
@@ -9,4 +9,4 @@ keywords = ["text", "unicode"]
 description = "UNIC - Unicode Character Database - Normalization Properties"
 
 [dependencies]
-unic-ucd-core = { path = "../core/", version = "0.1.1" }
+unic-ucd-core = { path = "../core/", version = "0.1.0" }
diff --git a/components/ucd/normal/src/lib.rs b/components/ucd/normal/src/lib.rs
@@ -9,8 +9,13 @@
 // except according to those terms.
 
 
-//! Functions for computing canonical and compatible decompositions for Unicode characters.
+#![deny(unsafe_code)]
+#![forbid(missing_docs)]
 
+//! # UNIC — UCD — Normalization
+//!
+//! A component of [`unic`: Unicode and Internationalization Crates for Rust](/unic/).
+//!
 //! Unicode character properties for composition and decomposition.
 //!
 //! ```rust
@@ -28,8 +33,7 @@ mod tables;
 mod hangul;
 
 pub use tables::UNICODE_VERSION;
-pub use tables::{canonical_decomposition, compatibility_decomposition, composition,
-                 canonical_combining_class};
+pub use tables::{canonical_decomposition, compatibility_decomposition, canonical_composition, canonical_combining_class};
 pub use tables::is_combining_mark;
 
 use std::cmp::Ordering::{Equal, Less, Greater};
@@ -107,7 +111,7 @@ fn d<F>(c: char, i: &mut F, k: bool)
 /// for more information.
 pub fn compose(a: char, b: char) -> Option<char> {
     hangul::compose(a, b).or_else(
-        || match composition(a) {
+        || match canonical_composition(a) {
             None => None,
             Some(candidates) => {
                 match candidates.binary_search_by(
diff --git a/components/ucd/normal/src/tables/mod.rs b/components/ucd/normal/src/tables/mod.rs
@@ -49,14 +49,16 @@ fn bsearch_lookup_table<T>(
 const CANONICAL_COMPOSITION_LOOKUP: &'static [(char, Slice)] = include!("canonical_composition_lookup.rsv");
 const CANONICAL_COMPOSITION_VALUES: &'static [(char, char)] = include!("canonical_composition_values.rsv");
 
-pub fn composition(c: char) -> Option<&'static ([(char, char)])> {
+/// Canonical Composition of the character.
+pub fn canonical_composition(c: char) -> Option<&'static ([(char, char)])> {
     bsearch_lookup_table(c, CANONICAL_COMPOSITION_LOOKUP, CANONICAL_COMPOSITION_VALUES)
 }
 
 // == Canonical Decomposition (D) ==
 const CANONICAL_DECOMPOSITION_LOOKUP: &'static [(char, Slice)] = include!("canonical_decomposition_lookup.rsv");
 const CANONICAL_DECOMPOSITION_VALUES: &'static [char] = include!("canonical_decomposition_values.rsv");
 
+/// Canonical Decomposition of the character.
 pub fn canonical_decomposition(c: char) -> Option<&'static [char]> {
     bsearch_lookup_table(c, CANONICAL_DECOMPOSITION_LOOKUP, CANONICAL_DECOMPOSITION_VALUES)
 }
@@ -65,6 +67,7 @@ pub fn canonical_decomposition(c: char) -> Option<&'static [char]> {
 const COMPATIBILITY_DECOMPOSITION_LOOKUP: &'static [(char, Slice)] = include!("compatibility_decomposition_lookup.rsv");
 const COMPATIBILITY_DECOMPOSITION_VALUES: &'static [char] = include!("compatibility_decomposition_values.rsv");
 
+/// Compatibility Decomposition of the character.
 pub fn compatibility_decomposition(c: char) -> Option<&'static [char]> {
     bsearch_lookup_table(c, COMPATIBILITY_DECOMPOSITION_LOOKUP, COMPATIBILITY_DECOMPOSITION_VALUES)
 }
diff --git a/components/ucd/src/lib.rs b/components/ucd/src/lib.rs
@@ -9,12 +9,14 @@
 // except according to those terms.
 
 
-#![forbid(unsafe_code)]
+#![forbid(unsafe_code, missing_docs)]
 
 //! # UNIC — Unicode Character Database
 //!
-//!  This UNIC component provides access to character properties as defined in the [Unicode®
-//!  Standard Annex #44 - Unicode Character Database](http://unicode.org/reports/tr44/).
+//! A component of [`unic`: Unicode and Internationalization Crates for Rust](/unic/).
+//!
+//! This UNIC component provides access to character properties as defined in the [Unicode
+//! Standard Annex #44 - Unicode Character Database](http://unicode.org/reports/tr44/).
 
 
 pub extern crate unic_ucd_core as core;
diff --git a/components/ucd/utils/src/lib.rs b/components/ucd/utils/src/lib.rs
@@ -9,11 +9,16 @@
 // except according to those terms.
 
 
-#![forbid(unsafe_code)]
+#![forbid(unsafe_code, missing_docs)]
 
+//! # UNIC — UCD — Utils
+//!
+//! A component of [`unic`: Unicode and Internationalization Crates for Rust](/unic/).
+//!
 //! Utilities for working with Unicode Code Points
 //!
-//! Definitions:
+//! ## Definitions
+//!
 //! * [**Unicode Code Point**](http://unicode.org/glossary/#code_point)
 //! * [**Unicode Scalar Value**](http://unicode.org/glossary/#unicode_scalar_value)
 
diff --git a/src/lib.rs b/src/lib.rs
@@ -11,7 +11,7 @@
 
 #![forbid(unsafe_code)]
 
-//! # UNIC: Unicode and Internationalization Crates for RUST
+//! # UNIC: Unicode and Internationalization Crates for Rust
 //!
 //! The `unic` super-crate (this) is a collection of all UNIC components, providing
 //! an easy way of access to all functionalities, when all or many are needed,
@@ -20,13 +20,13 @@
 //!
 //! ## Components
 //!
-//! -   [`unic::ucd`](../components/ucd): Unicode Character Database.
+//! -   [`ucd`](/unic_ucd): Unicode Character Database.
 //!
-//! -   [`unic::bidi`](../components/bidi): Unicode Bidirectional Algorithm (USA\#9).
+//! -   [`bidi`](/unic_bidi): Unicode Bidirectional Algorithm (USA\#9).
 //!
-//! -   [`unic::normal`](../components/normal): Unicode Normalization Forms (USA\#15).
+//! -   [`normal`](/unic_normal): Unicode Normalization Forms (USA\#15).
 //!
-//! -   [`unic::idna`](../components/idna): Unicode IDNA Compatibility Processing (UTS\#46).
+//! -   [`idna`](/unic_idna): Unicode IDNA Compatibility Processing (UTS\#46).
 
 pub extern crate unic_bidi as bidi;
 pub extern crate unic_idna as idna;

Original file line number	Diff line number	Diff line change
`@@ -33,7 +33,10 @@ use unic_ucd_bidi::BidiClass;`
`33`	`33`	`#[cfg_attr(feature = "with_serde", derive(Serialize, Deserialize))]`
`34`	`34`	`pub struct Level(u8);`
`35`	`35`
	`36`	`+/// LTR level with smallest number value (0).`
`36`	`37`	`pub const LTR_LEVEL: Level = Level(0);`
	`38`	`+`
	`39`	`+/// RTL level with smallest number value (0).`
`37`	`40`	`pub const RTL_LEVEL: Level = Level(1);`
`38`	`41`
`39`	`42`	`const MAX_DEPTH: u8 = 125;`
`@@ -191,6 +194,7 @@ impl Level {`
`191`	`194`	`}`
`192`	`195`	`}`
`193`	`196`
	`197`	+ /// Create a `Vec<Level>` from a slice of `u8` numbers
`194`	`198`	`pub fn vec(v: &[u8]) -> Vec<Level> {`
`195`	`199`	`v.iter().map(\|&x\| x.into()).collect()`
`196`	`200`	`}`