Skip to content
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

docs: fix docstrings for enum lyd_type #2317

Merged
merged 1 commit into from
Oct 24, 2024
Merged

docs: fix docstrings for enum lyd_type #2317

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
42 changes: 21 additions & 21 deletions src/parser_data.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -332,29 +332,29 @@ LIBYANG_API_DECL LY_ERR lyd_parse_ext_data(const struct lysc_ext_instance *ext,
* @{
*/
enum lyd_type {
LYD_TYPE_DATA_YANG = 0, /* generic YANG instance data */
LYD_TYPE_RPC_YANG, /* instance of a YANG RPC/action request with only "input" data children,
including all parents and optional top-level "action" element in case of an action */
LYD_TYPE_NOTIF_YANG, /* instance of a YANG notification, including all parents in case of a nested one */
LYD_TYPE_REPLY_YANG, /* instance of a YANG RPC/action reply with only "output" data children,
including all parents in case of an action */
LYD_TYPE_DATA_YANG = 0, /**< generic YANG instance data */
LYD_TYPE_RPC_YANG, /**< instance of a YANG RPC/action request with only "input" data children,
including all parents and optional top-level "action" element in case of an action */
LYD_TYPE_NOTIF_YANG, /**< instance of a YANG notification, including all parents in case of a nested one */
LYD_TYPE_REPLY_YANG, /**< instance of a YANG RPC/action reply with only "output" data children,
including all parents in case of an action */

LYD_TYPE_RPC_NETCONF, /* complete NETCONF RPC invocation as defined for
[RPC](https://tools.ietf.org/html/rfc7950#section-7.14.4) and
[action](https://tools.ietf.org/html/rfc7950#section-7.15.2) */
LYD_TYPE_NOTIF_NETCONF, /* complete NETCONF notification message as defined for
[notification](https://tools.ietf.org/html/rfc7950#section-7.16.2) */
LYD_TYPE_REPLY_NETCONF, /* complete NETCONF RPC reply as defined for
[RPC](https://tools.ietf.org/html/rfc7950#section-7.14.4) and
[action](https://tools.ietf.org/html/rfc7950#section-7.15.2) */
LYD_TYPE_RPC_NETCONF, /**< complete NETCONF RPC invocation as defined for
[RPC](https://tools.ietf.org/html/rfc7950#section-7.14.4) and
[action](https://tools.ietf.org/html/rfc7950#section-7.15.2) */
LYD_TYPE_NOTIF_NETCONF, /**< complete NETCONF notification message as defined for
[notification](https://tools.ietf.org/html/rfc7950#section-7.16.2) */
LYD_TYPE_REPLY_NETCONF, /**< complete NETCONF RPC reply as defined for
[RPC](https://tools.ietf.org/html/rfc7950#section-7.14.4) and
[action](https://tools.ietf.org/html/rfc7950#section-7.15.2) */

LYD_TYPE_RPC_RESTCONF, /* message-body of a RESTCONF operation input parameters
([ref](https://www.rfc-editor.org/rfc/rfc8040.html#section-3.6.1)) */
LYD_TYPE_NOTIF_RESTCONF, /* RESTCONF JSON notification data
([ref](https://www.rfc-editor.org/rfc/rfc8040.html#section-6.4)), to parse
a notification in XML, use ::LYD_TYPE_NOTIF_NETCONF */
LYD_TYPE_REPLY_RESTCONF /* message-body of a RESTCONF operation output parameters
([ref](https://www.rfc-editor.org/rfc/rfc8040.html#section-3.6.2)) */
LYD_TYPE_RPC_RESTCONF, /**< message-body of a RESTCONF operation input parameters
([ref](https://www.rfc-editor.org/rfc/rfc8040.html#section-3.6.1)) */
LYD_TYPE_NOTIF_RESTCONF, /**< RESTCONF JSON notification data
([ref](https://www.rfc-editor.org/rfc/rfc8040.html#section-6.4)), to parse
a notification in XML, use ::LYD_TYPE_NOTIF_NETCONF */
LYD_TYPE_REPLY_RESTCONF /**< message-body of a RESTCONF operation output parameters
([ref](https://www.rfc-editor.org/rfc/rfc8040.html#section-3.6.2)) */
};
/** @} datatype */

Expand Down
Loading