Skip to content

Commit 010a7e3

Browse files
kartbenjhedberg
authored andcommitted
include: doc: fix trivial doxygen warnings
Fix incorrect/unbalanced usage of backticks in a bunch of headers causing doxygen warnings. Signed-off-by: Benjamin Cabé <[email protected]>
1 parent cf76e4b commit 010a7e3

File tree

5 files changed

+11
-11
lines changed

5 files changed

+11
-11
lines changed

include/zephyr/linker/linker-tool-gcc.h

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -100,11 +100,11 @@
100100
*
101101
* The GROUP_ROM_LINK_IN() macro is located at the end of the section
102102
* description and tells the linker that this a read-only section
103-
* that is physically placed at the 'lregion` argument.
103+
* that is physically placed at the `lregion` argument.
104104
*
105-
* If CONFIG_XIP is active, the 'lregion' area is flash memory.
105+
* If CONFIG_XIP is active, the `lregion` area is flash memory.
106106
*
107-
* If CONFIG_MMU is active, the vregion argument will be used to
107+
* If CONFIG_MMU is active, the `vregion` argument will be used to
108108
* determine where this is located in the virtual memory map, otherwise
109109
* it is ignored.
110110
*

include/zephyr/linker/linker-tool-mwdt.h

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@
3939
/**
4040
* The GROUP_ROM_LINK_IN() macro is located at the end of the section
4141
* description and tells the linker that this a read-only section
42-
* that is physically placed at the 'lregion` argument.
42+
* that is physically placed at the `region` argument.
4343
*
4444
*/
4545
#define GROUP_ROM_LINK_IN(vregion, lregion) > lregion

include/zephyr/net/dns_resolve.h

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -337,7 +337,7 @@ struct dns_addrinfo {
337337
* Status values for the callback.
338338
*/
339339
enum dns_resolve_status {
340-
/** Invalid value for `ai_flags' field */
340+
/** Invalid value for `ai_flags` field */
341341
DNS_EAI_BADFLAGS = -1,
342342
/** NAME or SERVICE is unknown */
343343
DNS_EAI_NONAME = -2,
@@ -347,17 +347,17 @@ enum dns_resolve_status {
347347
DNS_EAI_FAIL = -4,
348348
/** No address associated with NAME */
349349
DNS_EAI_NODATA = -5,
350-
/** `ai_family' not supported */
350+
/** `ai_family` not supported */
351351
DNS_EAI_FAMILY = -6,
352-
/** `ai_socktype' not supported */
352+
/** `ai_socktype` not supported */
353353
DNS_EAI_SOCKTYPE = -7,
354-
/** SRV not supported for `ai_socktype' */
354+
/** SRV not supported for `ai_socktype` */
355355
DNS_EAI_SERVICE = -8,
356356
/** Address family for NAME not supported */
357357
DNS_EAI_ADDRFAMILY = -9,
358358
/** Memory allocation failure */
359359
DNS_EAI_MEMORY = -10,
360-
/** System error returned in `errno' */
360+
/** System error returned in `errno` */
361361
DNS_EAI_SYSTEM = -11,
362362
/** Argument buffer overflow */
363363
DNS_EAI_OVERFLOW = -12,

include/zephyr/net/socket.h

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -338,7 +338,7 @@ struct zsock_addrinfo {
338338
*
339339
* This is achieved by tagging data structure definitions that implement the
340340
* underlying object associated with a network socket file descriptor with
341-
* '__net_socket`. All pointers to instances of these will be known to the
341+
* `__net_socket`. All pointers to instances of these will be known to the
342342
* kernel as kernel objects with type K_OBJ_NET_SOCKET.
343343
*
344344
* This API is intended for threads that need to grant access to the object

include/zephyr/sys/timeutil.h

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -107,7 +107,7 @@ int64_t timeutil_timegm64(const struct tm *tm);
107107
*
108108
* @return the corresponding time in the POSIX epoch time scale. If
109109
* the time cannot be represented then @c (time_t)-1 is returned and
110-
* @c errno is set to @c ERANGE`.
110+
* @c errno is set to @c ERANGE.
111111
*
112112
* @see http://man7.org/linux/man-pages/man3/timegm.3.html
113113
*/

0 commit comments

Comments
 (0)