   return Hardware.NOT_AVAILABLE
 }
 
-/** This method returns the readable description of hardware string */
+
+/// This method returns the readable description of hardware string
+///
+/// - returns: readable description `String` of the device
+///
 public func hardwareDescription() -> String? {
   let hardware = hardwareString()
   if (hardware == "iPhone1,1")            { return "iPhone 2G" }

import Foundation
import UIKit

public enum Hardware: NSInteger {
  case NOT_AVAILABLE
  
  case IPHONE_2G
  case IPHONE_3G
  case IPHONE_3GS
  case IPHONE_4
  case IPHONE_4_CDMA
  case IPHONE_4S
  case IPHONE_5
  case IPHONE_5_CDMA_GSM
  case IPHONE_5C
  case IPHONE_5C_CDMA_GSM
  case IPHONE_5S
  case IPHONE_5S_CDMA_GSM
  case IPHONE_6_PLUS
  case IPHONE_6
  case IPHONE_6S
  case IPHONE_6S_PLUS


  case SIMULATOR
}

/// This method retruns the hardware type
///
///
/// - returns: raw `String` of device type
///
public func hardwareString() -> String {
  var name: [Int32] = [CTL_HW, HW_MACHINE]
  var size: Int = 2
