Skip to content

docs: improved description of lyd_parse_op() #2319

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Oct 31, 2024
Merged

docs: improved description of lyd_parse_op() #2319

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 9 additions & 1 deletion src/parser_data.h
View file
Open in desktop
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
Loading