lint for warning missing documentation

This change also includes the fixes for currently missing documentation
and crate level documentation.

Author: 9prady9

src/defines.rs

@@ -339,24 +339,37 @@ pub enum HomographyType {
 #[repr(C)]
 #[derive(Clone, Copy, Debug, PartialEq)]
 pub enum MarkerType {
+    /// No marker
     NONE     = 0,
+    /// Pointer marker
     POINT    = 1,
+    /// Hollow circle marker
     CIRCLE   = 2,
+    /// Hollow Square marker
     SQUARE   = 3,
+    /// Hollow Triangle marker
     TRIANGLE = 4,
+    /// Cross-hair marker
     CROSS    = 5,
+    /// Plus symbol marker
     PLUS     = 6,
+    /// Start symbol marker
     STAR     = 7
 }
 
 /// Image moment types
 #[repr(C)]
 #[derive(Clone, Copy, Debug, PartialEq)]
 pub enum MomentType {
+    /// Central moment of order (0 + 0)
     M00 = 1,    // 1<<0
+    /// Central moment of order (0 + 1)
     M01 = 2,    // 1<<1
+    /// Central moment of order (1 + 0)
     M10 = 4,    // 1<<2
+    /// Central moment of order (1 + 1)
     M11 = 8,    // 1<<3
+    /// All central moments of order (0,0), (0,1), (1,0) and (1,1)
     FIRST_ORDER = 1<<0 | 1<<1 | 1<<2 | 1<<3
 }
 
@@ -378,9 +391,13 @@ pub enum SparseFormat {
 #[repr(C)]
 #[derive(Clone, Copy, Debug, PartialEq)]
 pub enum BinaryOp {
+    /// Addition operation
     ADD = 0,
+    /// Multiplication operation
     MUL = 1,
+    /// Minimum operation
     MIN = 2,
+    /// Maximum operation
     MAX = 3
 }
 
@@ -396,9 +413,13 @@ pub enum RandomEngineType {
     MERSENNE_GP11213    = 300
 }
 
+/// Default Philon RandomEngine that points to [PHILOX_4X32_10](./enum.RandomEngineType.html)
 pub const PHILOX   : RandomEngineType = RandomEngineType::PHILOX_4X32_10;
+/// Default Threefry RandomEngine that points to [THREEFRY_2X32_16](./enum.RandomEngineType.html)
 pub const THREEFRY : RandomEngineType = RandomEngineType::THREEFRY_2X32_16;
+/// Default Mersenne RandomEngine that points to [MERSENNE_GP11213](./enum.RandomEngineType.html)
 pub const MERSENNE : RandomEngineType = RandomEngineType::MERSENNE_GP11213;
+/// Default RandomEngine that defaults to [PHILOX](./constant.PHILOX.html)
 pub const DEFAULT_RANDOM_ENGINE : RandomEngineType = PHILOX;
 
 /// Scalar value types

src/dim4.rs

@@ -84,7 +84,7 @@ impl Dim4 {
         }
     }
 
-    // Get the dimensions as a slice of 4 values
+    /// Get the dimensions as a slice of 4 values
     pub fn get(&self) -> &[u64; 4] {
         &self.dims
     }

src/error.rs

@@ -4,11 +4,14 @@ use std::error::Error;
 use std::marker::{Send, Sync};
 use std::sync::RwLock;
 
+/// Signature of callback function to be called to handle errors
 pub type ErrorCallback = Fn(AfError);
 
 /// Wrap ErrorCallback function pointer inside a structure
 /// to enable implementing Send, Sync traits on it.
 pub struct Callback<'cblifetime> {
+    ///Reference to a valid error callback function
+    ///Make sure this callback stays relevant throughout the lifetime of application.
     pub cb: &'cblifetime ErrorCallback,
 }
 
@@ -60,6 +63,7 @@ pub fn register_error_handler(cb_value: Callback<'static>) {
     *gaurd.deref_mut() = cb_value;
 }
 
+/// Default error handling callback provided by ArrayFire crate
 pub fn handle_error_general(error_code: AfError) {
     match error_code {
         AfError::SUCCESS => {}, /* No-op */

src/index.rs

@@ -68,6 +68,7 @@ impl<T: Copy> Indexable for Seq<T> where c_double: From<T> {
 
 impl Indexer {
     #[allow(unused_mut)]
+    /// Create a new Indexer object and set the dimension specific index objects later
     pub fn new() -> Indexer {
         unsafe {
             let mut temp: i64 = 0;

src/lib.rs

@@ -1,6 +1,26 @@
+//! ArrayFire is a high performance software library for parallel computing with
+//! an easy-to-use API. ArrayFire abstracts away much of the details of
+//! programming parallel architectures by providing a high-level container object,
+//! the [Array](./struct.Array.html), that represents data stored on a CPU, GPU, FPGA,
+//! or other type of accelerator. This abstraction permits developers to write
+//! massively parallel applications in a high-level language where they need
+//! not be concerned about low-level optimizations that are frequently required to
+//! achieve high throughput on most parallel architectures.
+
+//! This crate provides Rust bindings for the ArrayFire library. Given below table shows the rust bindings compatability with ArrayFire upstream.  If you find any bugs, please report them on [github](https://github.com/arrayfire/arrayfire-rust/issues).
+//!
+//!
+//! | ArrayFire Upstream | Rust Crate |
+//! |:------------------:|:---------------:|
+//! | 3.3.x | 3.3.x |
+//! | 3.4.x | 3.4.x |
+//!
+//! Only, Major & Minor version numbers need to match.
+
 #![doc(html_logo_url = "http://www.arrayfire.com/logos/arrayfire_logo_symbol.png",
        html_favicon_url = "http://www.rust-lang.org/favicon.ico",
        html_root_url = "http://arrayfire.com/docs/rust")]
+#![warn(missing_docs)]
 
 #[macro_use]
 extern crate lazy_static;

src/util.rs

@@ -153,6 +153,7 @@ impl From<i32> for ColorMap {
 /// - u16
 ///
 pub trait HasAfEnum {
+    /// Return trait implmentors corresponding [DType](./enum.DType.html)
     fn get_af_dtype() -> DType;
 }