Skip to content

Commit 7e5501f

Browse files
lePicimichalvasko
authored andcommitted
docs: improved description of lyd_parse_op()
Added clarification for _YANG types.
1 parent c099a31 commit 7e5501f

File tree

1 file changed

+9
-1
lines changed

1 file changed

+9
-1
lines changed

src/parser_data.h

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -409,13 +409,21 @@ enum lyd_type {
409409
* - @p op - must be NULL, @p parent points to the operation;
410410
* Note that error reply should be parsed as 'yang-data' extension data.
411411
*
412+
* - ::LYD_TYPE_RPC_YANG:
413+
* - ::LYD_TYPE_NOTIF_YANG:
414+
* - ::LYD_TYPE_REPLY_YANG:
415+
* - all the parameters have their default meaning.
416+
*
417+
* - :: LYD_TYPE_DATA_YANG:
418+
* - not accepted by the function.
419+
*
412420
* @param[in] ctx libyang context.
413421
* @param[in] parent Optional parent to connect the parsed nodes to.
414422
* @param[in] in Input handle to read the input from.
415423
* @param[in] format Expected format of the data in @p in.
416424
* @param[in] data_type Expected operation to parse (@ref datatype).
417425
* @param[out] tree Optional full parsed data tree. If @p parent is set, set to NULL.
418-
* @param[out] op Optional pointer to the operation (action/RPC) node.
426+
* @param[out] op Optional pointer to the operation (action/RPC/notification) node.
419427
* @return LY_ERR value.
420428
* @return LY_ENOT if @p data_type is a NETCONF message and the root XML element is not the expected one.
421429
*/

0 commit comments

Comments
 (0)