Skip to content

Commit c6e5654

Browse files
committed
doc BUGFIX fix ly_in and ly_out invalid links
1 parent a8458ba commit c6e5654

File tree

4 files changed

+30
-6
lines changed

4 files changed

+30
-6
lines changed

src/context.h

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -139,7 +139,7 @@ struct lys_module;
139139
*
140140
* Structures and functions to manipulate with the libyang context containers.
141141
*
142-
* The \em context concept allows callers to work in environments with different sets of YANG schemas.
142+
* The @em context concept allows callers to work in environments with different sets of YANG schemas.
143143
* More detailed information can be found at @ref howtoContext page.
144144
*/
145145

src/in.h

Lines changed: 14 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,10 @@
11
/**
22
* @file in.h
33
* @author Radek Krejci <[email protected]>
4+
* @author Michal Vasko <[email protected]>
45
* @brief libyang input structures and functions
56
*
6-
* Copyright (c) 2020 CESNET, z.s.p.o.
7+
* Copyright (c) 2020 - 2025 CESNET, z.s.p.o.
78
*
89
* This source code is licensed under BSD 3-Clause License (the "License").
910
* You may not use this file except in compliance with the License.
@@ -70,9 +71,18 @@ extern "C" {
7071
* - @subpage howtoDataParsers
7172
*/
7273

74+
/**
75+
* @defgroup input Input handler
76+
* @{
77+
*
78+
* Structures and functions for input handling.
79+
*
80+
* The @em input abstraction allows users for transparent use of various input kinds.
81+
*/
82+
7383
/**
7484
* @struct ly_in
75-
* @brief Parser input structure specifying where the data are read.
85+
* @brief Parser input structure specifying the type of data input.
7686
*/
7787
struct ly_in;
7888

@@ -245,6 +255,8 @@ LIBYANG_API_DECL LY_ERR ly_in_read(struct ly_in *in, void *buf, size_t count);
245255
*/
246256
LIBYANG_API_DECL LY_ERR ly_in_skip(struct ly_in *in, size_t count);
247257

258+
/** @} input */
259+
248260
#ifdef __cplusplus
249261
}
250262
#endif

src/out.h

Lines changed: 14 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,10 @@
11
/**
22
* @file out.h
33
* @author Radek Krejci <[email protected]>
4+
* @author Michal Vasko <[email protected]>
45
* @brief libyang output structures and functions
56
*
6-
* Copyright (c) 2015-2020 CESNET, z.s.p.o.
7+
* Copyright (c) 2015 - 2025 CESNET, z.s.p.o.
78
*
89
* This source code is licensed under BSD 3-Clause License (the "License").
910
* You may not use this file except in compliance with the License.
@@ -78,9 +79,18 @@ extern "C" {
7879
* - @subpage howtoDataPrinters
7980
*/
8081

82+
/**
83+
* @defgroup output Output handler
84+
* @{
85+
*
86+
* Structures and functions for output handling.
87+
*
88+
* The @em output abstraction allows users for transparent use of various output kinds.
89+
*/
90+
8191
/**
8292
* @struct ly_out
83-
* @brief Printer output structure specifying where the data are printed.
93+
* @brief Printer output structure specifying the type of data output.
8494
*/
8595
struct ly_out;
8696

@@ -309,6 +319,8 @@ LIBYANG_API_DECL size_t ly_out_printed_total(const struct ly_out *out);
309319
*/
310320
LIBYANG_API_DECL void ly_out_free(struct ly_out *out, void (*clb_arg_destructor)(void *arg), ly_bool destroy);
311321

322+
/** @} output */
323+
312324
#ifdef __cplusplus
313325
}
314326
#endif

src/tree_data.h

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2172,7 +2172,7 @@ LIBYANG_API_DECL LY_ERR lyd_merge_module(struct lyd_node **target, const struct
21722172
nodes. Also, leaves and leaf-lists are added into diff even in case only their
21732173
default flag (state) was changed. */
21742174
#define LYD_DIFF_META 0x02 /**< All metadata are compared and the full difference reported in the diff always in
2175-
the form of 'yang:meta-<operation>' metadata. Also, equal nodes with only changes
2175+
the form of 'yang:meta-\<operation\>' metadata. Also, equal nodes with only changes
21762176
in their metadata will be present in the diff with the 'none' operation. */
21772177

21782178
/** @} diffoptions */

0 commit comments

Comments
 (0)