Skip to content

Commit 169cf86

Browse files
kartbencfriedt
authored andcommitted
include: doc: fix bad @endcond markers
Anything appearing after the @endcond tag is, well, not part of the conditional block anymore. This fixes "INTERNAL_HIDDEN" text appearing at odd polaces in the generated documentation. Fixes #94862 Signed-off-by: Benjamin Cabé <[email protected]>
1 parent c2384c5 commit 169cf86

File tree

6 files changed

+10
-11
lines changed

6 files changed

+10
-11
lines changed

include/zephyr/modbus/modbus.h

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -447,7 +447,7 @@ struct modbus_custom_fc {
447447
uint8_t fc;
448448
uint8_t excep_code;
449449
};
450-
/** @endcond INTERNAL_HIDDEN */
450+
/** INTERNAL_HIDDEN @endcond */
451451

452452
/**
453453
* @brief Helper macro for initializing custom function code structs

include/zephyr/pmci/mctp/mctp_i2c_gpio_common.h

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,6 @@
2020
/* Max packet size (pseudo registers are byte sized) */
2121
#define MCTP_I2C_GPIO_MAX_PKT_SIZE 255
2222

23-
/** @endcond INTERNAL_HIDDEN */
23+
/** INTERNAL_HIDDEN @endcond */
2424

2525
#endif /* ZEPHYR_MCTP_I2C_GPIO_COMMON_H_ */

include/zephyr/pmci/mctp/mctp_i2c_gpio_controller.h

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -31,8 +31,7 @@ struct mctp_i2c_gpio_controller_cb {
3131
uint8_t index;
3232
};
3333

34-
/** @endcond INTERNAL_HIDDEN */
35-
34+
/** INTERNAL_HIDDEN @endcond */
3635

3736
/**
3837
* @brief An MCTP binding for Zephyr's I2C interface using GPIO
@@ -65,7 +64,7 @@ struct mctp_binding_i2c_gpio_controller {
6564
struct mpsc rx_q;
6665
struct mctp_i2c_gpio_controller_cb *inflight_rx;
6766

68-
/** @endcond INTERNAL_HIDDEN */
67+
/** INTERNAL_HIDDEN @endcond */
6968
};
7069

7170
/** @cond INTERNAL_HIDDEN */
@@ -101,7 +100,7 @@ int mctp_i2c_gpio_controller_tx(struct mctp_binding *binding, struct mctp_pktbuf
101100
(,), _name) \
102101
}
103102

104-
/** @endcond INTERNAL_HIDDEN */
103+
/** INTERNAL_HIDDEN @endcond */
105104

106105
/**
107106
* @brief Define a MCTP bus binding for I2C controller with GPIO

include/zephyr/pmci/mctp/mctp_i2c_gpio_target.h

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -34,14 +34,14 @@ struct mctp_binding_i2c_gpio_target {
3434
struct k_sem *tx_complete;
3535
uint8_t tx_idx;
3636
struct mctp_pktbuf *tx_pkt;
37-
/** @endcond INTERNAL_HIDDEN */
37+
/** INTERNAL_HIDDEN @endcond */
3838
};
3939

4040
/** @cond INTERNAL_HIDDEN */
4141
extern const struct i2c_target_callbacks mctp_i2c_gpio_target_callbacks;
4242
int mctp_i2c_gpio_target_start(struct mctp_binding *binding);
4343
int mctp_i2c_gpio_target_tx(struct mctp_binding *binding, struct mctp_pktbuf *pkt);
44-
/** @endcond INTERNAL_HIDDEN */
44+
/** INTERNAL_HIDDEN @endcond */
4545

4646
/**
4747
* @brief Define a MCTP bus binding for I2C target with GPIO

include/zephyr/pmci/mctp/mctp_uart.h

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@ struct mctp_binding_uart {
4444
uint8_t tx_buf[256];
4545
int tx_res;
4646

47-
/** @endcond INTERNAL_HIDDEN */
47+
/** INTERNAL_HIDDEN @endcond */
4848
};
4949

5050
/**
@@ -59,7 +59,7 @@ void mctp_uart_start_rx(struct mctp_binding_uart *uart);
5959
/** @cond INTERNAL_HIDDEN */
6060
int mctp_uart_start(struct mctp_binding *binding);
6161
int mctp_uart_tx(struct mctp_binding *binding, struct mctp_pktbuf *pkt);
62-
/** @endcond INTERNAL_HIDDEN */
62+
/** INTERNAL_HIDDEN @endcond */
6363

6464
/**
6565
* @brief Statically define a MCTP bus binding for a UART

include/zephyr/sys/clock.h

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -387,7 +387,7 @@ struct timespec;
387387

388388
/* Convert a POSIX clock (cast to int) to a sys_clock identifier */
389389
int sys_clock_from_clockid(int clock_id);
390-
/** @endcond INTERNAL_HIDDEN */
390+
/** INTERNAL_HIDDEN @endcond */
391391

392392
/**
393393
* @brief Get the offset @ref SYS_CLOCK_REALTIME with respect to @ref SYS_CLOCK_MONOTONIC

0 commit comments

Comments
 (0)