Skip to content

Commit

Permalink
* Better Ldoc documentation.
Browse files Browse the repository at this point in the history
  • Loading branch information
António P. P. Almeida committed Oct 19, 2015
1 parent 5a0a6a7 commit 796d651
Showing 1 changed file with 19 additions and 3 deletions.
22 changes: 19 additions & 3 deletions lib/resty/tarantool.lua
Original file line number Diff line number Diff line change
@@ -1,5 1,5 @@
--
-- @file tarantool.lua
-- @module tarantool.lua
-- @author António P. P. Almeida <[email protected]>
-- @date Mon Sep 21 19:47:05 2015
--
Expand Down Expand Up @@ -170,7 170,7 @@ if reps > 0 and tonumber(mp_version) < 33 then
mp.set_integer('unsigned')
end

-- @table: module table.
-- @table module table.
local M = { _VERSION = '0.2', _NAME = 'tarantool', _DESCRIPTION = 'resty Lua library for tarantool' }
local mt = { __index = M }

Expand Down Expand Up @@ -319,6 319,8 @@ end

--- Issue a request to tarantool.
--
-- @local
--
-- @param self table connection object.
-- @param header table request header.
-- @param body table request body (payload).
Expand Down Expand Up @@ -411,7 413,9 @@ end
--- Perform the authentication with the tarantool server.
--
-- @param self table object representing the current connection with
-- all the parameters.
-- all the parameters.
--
-- @local
--
-- @return boolean or nil, string
-- If the authentication succeeds return true, if not nil and the
Expand Down Expand Up @@ -444,6 448,8 @@ end

--- Performs the handshake of the IProto protocol.
--
-- @local
--
-- @param self table connection object.
--
-- @return boolean or nil, string
Expand Down Expand Up @@ -544,6 550,8 @@ end

--- Finds a space numeric id to be used in the IProto packets.
--
-- @local
--
-- @param self table connection object.
-- @param space string space id (name).
--
Expand Down Expand Up @@ -593,6 601,8 @@ end

--- Finds a space numeric id to be used in the IProto packets.
--
-- @local
--
-- @param self table connection object.
-- @param space string space id (name).
-- @param index index index id (name).
Expand Down Expand Up @@ -647,6 657,8 @@ end
--- Transforms the given argument into a table if it's not already
-- one. IProto key field, an array.
--
-- @local
--
-- @param table|string|number!nil value the value to be used as query
-- key.
-- @return table
Expand Down Expand Up @@ -727,6 739,8 @@ end

--- Issue a insert or replace command to the tarantool DB.
--
-- @local
--
-- @param self table connection object.
-- @param space string space name.
-- @param tuple table values to be inserted/replaced
Expand Down Expand Up @@ -818,6 832,8 @@ end
--- Massages the operator list for the update operation
-- so that the field numbers are the same as in the console.
--
-- @local
--
-- @param oplist table operator list.
--
-- @return table
Expand Down

0 comments on commit 796d651

Please sign in to comment.