Skip to main content
aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorKevin KIN-FOO2014-10-06 11:26:58 -0400
committerIan Craggs2016-03-30 11:02:12 -0400
commit953e0d79d60795df1dde61606d762d7234dfb8aa (patch)
tree41290e42efac1a785df129d1213141195650cd3c
parent54aab5cb9f59cb9c15f95e8391507edaec999c2f (diff)
downloadorg.eclipse.paho.mqtt.lua-953e0d79d60795df1dde61606d762d7234dfb8aa.tar.gz
org.eclipse.paho.mqtt.lua-953e0d79d60795df1dde61606d762d7234dfb8aa.tar.xz
org.eclipse.paho.mqtt.lua-953e0d79d60795df1dde61606d762d7234dfb8aa.zip
Bug 445785: Staying LDT-friendly.HEADmaster
Signed-off-by: Kevin KIN-FOO <kkinfoo@sierrawireless.com>
-rw-r--r--paho/mqtt.lua14
-rw-r--r--paho/utility.lua26
2 files changed, 20 insertions, 20 deletions
diff --git a/paho/mqtt.lua b/paho/mqtt.lua
index 34513c1..69162ea 100644
--- a/paho/mqtt.lua
+++ b/paho/mqtt.lua
@@ -1,5 +1,5 @@
---
--- @module mqtt_library
+-- @module paho.mqtt
-- ~~~~~~~~~~~~~~~~
-- Version: 0.3 2014-10-06
-- -------------------------------------------------------------------------- --
@@ -83,22 +83,22 @@ end
local MQTT = {}
---
--- @field [parent = #mqtt_library] utility#utility Utility
+-- @field [parent = #paho.mqtt] mqtt.utility#utility Utility
--
MQTT.Utility = require "paho.utility"
---
--- @field [parent = #mqtt_library] #number VERSION
+-- @field [parent = #paho.mqtt] #number VERSION
--
MQTT.VERSION = 0x03
---
--- @field [parent = #mqtt_library] #boolean ERROR_TERMINATE
+-- @field [parent = #paho.mqtt] #boolean ERROR_TERMINATE
--
MQTT.ERROR_TERMINATE = false -- Message handler errors terminate process ?
---
--- @field [parent = #mqtt_library] #string DEFAULT_BROKER_HOSTNAME
+-- @field [parent = #paho.mqtt] #string DEFAULT_BROKER_HOSTNAME
--
MQTT.DEFAULT_BROKER_HOSTNAME = "m2m.eclipse.org"
@@ -107,7 +107,7 @@ MQTT.DEFAULT_BROKER_HOSTNAME = "m2m.eclipse.org"
-- @type client
---
--- @field [parent = #mqtt_library] #client client
+-- @field [parent = #paho.mqtt] #client client
--
MQTT.client = {}
MQTT.client.__index = MQTT.client
@@ -130,7 +130,7 @@ MQTT.client.MAX_PAYLOAD_LENGTH = 268435455 -- bytes
-- MQTT 3.1 Specification: Section 2.1: Fixed header, Message type
---
--- @field [parent = #mqtt_library] message
+-- @field [parent = #paho.mqtt] message
--
MQTT.message = {}
MQTT.message.TYPE_RESERVED = 0x00
diff --git a/paho/utility.lua b/paho/utility.lua
index 70301ee..21ea0d7 100644
--- a/paho/utility.lua
+++ b/paho/utility.lua
@@ -1,5 +1,5 @@
---
--- @module Utility
+-- @module paho.utility
-- ~~~~~~~~~~~
-- Version: 0.3 2014-10-06
-- -------------------------------------------------------------------------- --
@@ -152,31 +152,31 @@ end
local Utility = {}
---
--- @function [parent = #utility] isPsp
+-- @function [parent = #paho.utility] isPsp
--
Utility.isPsp = isPsp
---
-- @param #boolean flag
--- @function [parent = #utility] set_debug
+-- @function [parent = #paho.utility] set_debug
--
Utility.set_debug = set_debug
---
-- @param #string message
--- @function [parent = #utility] debug
+-- @function [parent = #paho.utility] debug
--
Utility.debug = debug
---
-- @param #string value
--- @function [parent = #utility] dump_string
+-- @function [parent = #paho.utility] dump_string
--
Utility.dump_string = dump_string
---
--- @function [parent = #utility] get_time
+-- @function [parent = #paho.utility] get_time
-- @return #number
--
Utility.get_time = get_time
@@ -185,7 +185,7 @@ Utility.get_time = get_time
-- @param #number last_time
-- @param #number duration
-- @param #string type
--- @function [parent = #utility] expired
+-- @function [parent = #paho.utility] expired
-- @return #number
--
Utility.expired = expired
@@ -193,7 +193,7 @@ Utility.expired = expired
---
-- @param #number value
-- @param #number shift
--- @function [parent = #utility] shift_left
+-- @function [parent = #paho.utility] shift_left
-- @return #number
--
Utility.shift_left = shift_left
@@ -201,14 +201,14 @@ Utility.shift_left = shift_left
---
-- @param #number value
-- @param #number shift
--- @function [parent = #utility] shift_left
+-- @function [parent = #paho.utility] shift_left
-- @return #number
--
Utility.shift_right = shift_right
---
-- @param socket_client
--- @function [parent = #utility] socket_ready
+-- @function [parent = #paho.utility] socket_ready
-- @return #boolean
--
Utility.socket_ready = socket_ready
@@ -216,20 +216,20 @@ Utility.socket_ready = socket_ready
---
-- @param socket_client
-- @param #number byte_count
--- @function [parent = #utility] socket_receive
+-- @function [parent = #paho.utility] socket_receive
-- @return #string,#string
--
Utility.socket_receive = socket_receive
---
-- @param socket_client
--- @function [parent = #utility] socket_wait_connected
+-- @function [parent = #paho.utility] socket_wait_connected
--
Utility.socket_wait_connected = socket_wait_connected
---
-- @param #table table
--- @function [parent = #utility] table_to_string
+-- @function [parent = #paho.utility] table_to_string
-- @return #string
--
Utility.table_to_string = table_to_string

Back to the top