Skip to content

Commit

Permalink
docs: improved description of lyd_parse_op()
Browse files Browse the repository at this point in the history
Added clarification for _YANG types.
  • Loading branch information
lePici authored and michalvasko committed Oct 31, 2024
1 parent c099a31 commit 7e5501f
Showing 1 changed file with 9 additions and 1 deletion.
10 changes: 9 additions & 1 deletion src/parser_data.h
Original file line number Diff line number Diff line change
Expand Up @@ -409,13 +409,21 @@ enum lyd_type {
* - @p op - must be NULL, @p parent points to the operation;
* Note that error reply should be parsed as 'yang-data' extension data.
*
* - ::LYD_TYPE_RPC_YANG:
* - ::LYD_TYPE_NOTIF_YANG:
* - ::LYD_TYPE_REPLY_YANG:
* - all the parameters have their default meaning.
*
* - :: LYD_TYPE_DATA_YANG:
* - not accepted by the function.
*
* @param[in] ctx libyang context.
* @param[in] parent Optional parent to connect the parsed nodes to.
* @param[in] in Input handle to read the input from.
* @param[in] format Expected format of the data in @p in.
* @param[in] data_type Expected operation to parse (@ref datatype).
* @param[out] tree Optional full parsed data tree. If @p parent is set, set to NULL.
* @param[out] op Optional pointer to the operation (action/RPC) node.
* @param[out] op Optional pointer to the operation (action/RPC/notification) node.
* @return LY_ERR value.
* @return LY_ENOT if @p data_type is a NETCONF message and the root XML element is not the expected one.
*/
Expand Down

0 comments on commit 7e5501f

Please sign in to comment.