Skip to content

Commit

Permalink
doc: improve docstrings
Browse files Browse the repository at this point in the history
Signed-off-by: Markus Klotzbuecher <mk@mkio.de>
  • Loading branch information
kmarkus committed Jun 23, 2020
1 parent 157c059 commit 8aef399
Show file tree
Hide file tree
Showing 2 changed files with 12 additions and 6 deletions.
4 changes: 2 additions & 2 deletions libubx/ubx.c
Original file line number Diff line number Diff line change
Expand Up @@ -384,8 +384,8 @@ void ubx_node_cleanup(ubx_node_t *nd)
/**
* ubx_node_rm - cleanup an destroy a node
*
* calls ubx_node_cleanup and frees node member memory. Must not be
* used afterwards.
* calls ubx_node_cleanup and frees node member memory. Must be
* reinitialized with ubx_node_init before reusing.
*
* @param ni
*/
Expand Down
14 changes: 10 additions & 4 deletions lua/ubx.lua
Original file line number Diff line number Diff line change
Expand Up @@ -1529,12 +1529,18 @@ local function pcc_cnt()
return __pcc_cnt
end

--- Create a new port connected to an existing port via an interaction.
--
-- port_clone_conn - create a new port connected to an existing port
-- via an lfds_cyclic interaction. The returned port is garbage
-- collected.
--
-- @param bname block
-- @param pname name of port
-- @param buff_len1 desired buffer length (if port is in/out: length of out->in buffer)
-- @param buff_len2 only if port is in/out port: length of in->out buffer
-- @return the new port
-- @param buff_len1 buffer length in in->out direction (default 1)
-- @param buff_len2 buffer length in out->in direction (default buff_len1)
-- @param loglevel_overruns loglevel for buffer overruns
-- @param allow_partial allow partial flag (see lfds_cyclic)
-- @return the new, inverse, connected port
function M.port_clone_conn(block, pname, buff_len1, buff_len2, loglevel_overruns, allow_partial)

local prot = M.port_get(block, pname)
Expand Down

0 comments on commit 8aef399

Please sign in to comment.