docs(hotspot): remove unecessary doc tags

This commit is contained in:
Ibby 2016-10-05 22:46:22 -04:00
parent 2bdd3a3868
commit d79d62bfa0

View File

@ -217,27 +217,27 @@ export class Hotspot {
export interface ConnectionInfo { export interface ConnectionInfo {
/** /**
* @property {string} SSID * SSID
* The service set identifier (SSID) of the current 802.11 network. * The service set identifier (SSID) of the current 802.11 network.
*/ */
SSID: string; SSID: string;
/** /**
* @property {string} BSSID * BSSID
* The basic service set identifier (BSSID) of the current access point. * The basic service set identifier (BSSID) of the current access point.
*/ */
BSSID: string; BSSID: string;
/** /**
* @property {string} linkSpeed * linkSpeed
* The current link speed in Mbps * The current link speed in Mbps
*/ */
linkSpeed: string; linkSpeed: string;
/** /**
* @property {string} IPAddress * IPAddress
* The IP Address * The IP Address
*/ */
IPAddress: string; IPAddress: string;
/** /**
* @property {string} networkID * networkID
* Each configured network has a unique small integer ID, used to identify the network when performing operations on the supplicant. * Each configured network has a unique small integer ID, used to identify the network when performing operations on the supplicant.
*/ */
networkID: string; networkID: string;
@ -245,62 +245,62 @@ export interface ConnectionInfo {
export interface HotspotNetwork { export interface HotspotNetwork {
/** /**
* @property {string} SSID * SSID
* Human readable network name * Human readable network name
*/ */
SSID: string; SSID: string;
/** /**
* @property {string} BSSID * BSSID
* MAC Address of the access point * MAC Address of the access point
*/ */
BSSID: string; BSSID: string;
/** /**
* @property {number (int)} frequency * frequency
* The primary 20 MHz frequency (in MHz) of the channel over which the client is communicating with the access point. * The primary 20 MHz frequency (in MHz) of the channel over which the client is communicating with the access point.
*/ */
frequency: number; frequency: number;
/** /**
* @property {number} level * level
* The detected signal level in dBm, also known as the RSSI. * The detected signal level in dBm, also known as the RSSI.
*/ */
level: number; level: number;
/** /**
* @property {number} timestamp * timestamp
* Timestamp in microseconds (since boot) when this result was last seen. * Timestamp in microseconds (since boot) when this result was last seen.
*/ */
timestamp: number; timestamp: number;
/** /**
* @property {string} capabilities * capabilities
* Describes the authentication, key management, and encryption schemes supported by the access point. * Describes the authentication, key management, and encryption schemes supported by the access point.
*/ */
capabilities: string; capabilities: string;
} }
export interface HotspotNetworkConfig { export interface HotspotNetworkConfig {
/** /**
* @property {string} deviceIPAddress - Device IP Address * deviceIPAddress - Device IP Address
*/ */
deviceIPAddress: string; deviceIPAddress: string;
/** /**
* @property {string} deviceMacAddress - Device MAC Address * deviceMacAddress - Device MAC Address
*/ */
deviceMacAddress: string; deviceMacAddress: string;
/** /**
* @property {string} gatewayIPAddress - Gateway IP Address * gatewayIPAddress - Gateway IP Address
*/ */
gatewayIPAddress: string; gatewayIPAddress: string;
/** /**
* @property {string} gatewayMacAddress - Gateway MAC Address * gatewayMacAddress - Gateway MAC Address
*/ */
gatewayMacAddress: string; gatewayMacAddress: string;
} }
export interface HotspotDevice { export interface HotspotDevice {
/** /**
* @property {string} ip * ip
* Hotspot IP Address * Hotspot IP Address
*/ */
ip: string; ip: string;
/** /**
* @property {string} mac * mac
* Hotspot MAC Address * Hotspot MAC Address
*/ */
mac: string; mac: string;