Skip to content

Commit c099a31

Browse files
jktjktmichalvasko
authored andcommitted
docs: fix docstrings for enum lyd_type
Doxygen needs a special markup to render these in the generated docs. Fixes: e066574 data tree FEATURE support for NETCONF messages
1 parent 47f7c6b commit c099a31

File tree

1 file changed

+21
-21
lines changed

1 file changed

+21
-21
lines changed

src/parser_data.h

Lines changed: 21 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -332,29 +332,29 @@ LIBYANG_API_DECL LY_ERR lyd_parse_ext_data(const struct lysc_ext_instance *ext,
332332
* @{
333333
*/
334334
enum lyd_type {
335-
LYD_TYPE_DATA_YANG = 0, /* generic YANG instance data */
336-
LYD_TYPE_RPC_YANG, /* instance of a YANG RPC/action request with only "input" data children,
337-
including all parents and optional top-level "action" element in case of an action */
338-
LYD_TYPE_NOTIF_YANG, /* instance of a YANG notification, including all parents in case of a nested one */
339-
LYD_TYPE_REPLY_YANG, /* instance of a YANG RPC/action reply with only "output" data children,
340-
including all parents in case of an action */
335+
LYD_TYPE_DATA_YANG = 0, /**< generic YANG instance data */
336+
LYD_TYPE_RPC_YANG, /**< instance of a YANG RPC/action request with only "input" data children,
337+
including all parents and optional top-level "action" element in case of an action */
338+
LYD_TYPE_NOTIF_YANG, /**< instance of a YANG notification, including all parents in case of a nested one */
339+
LYD_TYPE_REPLY_YANG, /**< instance of a YANG RPC/action reply with only "output" data children,
340+
including all parents in case of an action */
341341

342-
LYD_TYPE_RPC_NETCONF, /* complete NETCONF RPC invocation as defined for
343-
[RPC](https://tools.ietf.org/html/rfc7950#section-7.14.4) and
344-
[action](https://tools.ietf.org/html/rfc7950#section-7.15.2) */
345-
LYD_TYPE_NOTIF_NETCONF, /* complete NETCONF notification message as defined for
346-
[notification](https://tools.ietf.org/html/rfc7950#section-7.16.2) */
347-
LYD_TYPE_REPLY_NETCONF, /* complete NETCONF RPC reply as defined for
348-
[RPC](https://tools.ietf.org/html/rfc7950#section-7.14.4) and
349-
[action](https://tools.ietf.org/html/rfc7950#section-7.15.2) */
342+
LYD_TYPE_RPC_NETCONF, /**< complete NETCONF RPC invocation as defined for
343+
[RPC](https://tools.ietf.org/html/rfc7950#section-7.14.4) and
344+
[action](https://tools.ietf.org/html/rfc7950#section-7.15.2) */
345+
LYD_TYPE_NOTIF_NETCONF, /**< complete NETCONF notification message as defined for
346+
[notification](https://tools.ietf.org/html/rfc7950#section-7.16.2) */
347+
LYD_TYPE_REPLY_NETCONF, /**< complete NETCONF RPC reply as defined for
348+
[RPC](https://tools.ietf.org/html/rfc7950#section-7.14.4) and
349+
[action](https://tools.ietf.org/html/rfc7950#section-7.15.2) */
350350

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

0 commit comments

Comments
 (0)