michaelh/zephyr
1
0
Fork 0
Code Releases Activity

doc: doxygen: replace option alias with kconfig

Browse source 
Similar to Sphinx, @kconfig{} alias should be used in Doxygen docstring
in order to reference a Kconfig option. @option{} is still kept for
compatibility reasons.

Signed-off-by: Gerard Marull-Paretas <gerard.marull@nordicsemi.no>
This commit is contained in:
Gerard Marull-Paretas 2021-06-28 17:13:40 +02:00 • committed by Anas Nashif
commit 72ab6b29bf
17 changed files with 111 additions and 108 deletions
Download patch file Download diff file Expand all files Collapse all files

3
doc/zephyr.doxyfile.in
View file

@ -223,7 +223,10 @@ TAB_SIZE = 8
ALIASES = "rst=\verbatim embed:rst:leading-asterisk" \
"endrst=\endverbatim"
# WARNING: @option{} is deprecated and will be removed after next release.
# @kconfig{} should be used instead.
ALIASES += option{1}="\verbatim embed:rst:inline :kconfig:`\1` \endverbatim"
ALIASES += kconfig{1}="\verbatim embed:rst:inline :kconfig:`\1` \endverbatim"
ALIASES += req{1}="\ref ZEPH_\1 \"ZEPH-\1\" "
ALIASES += satisfy{1}="\xrefitem satisfy \"Satisfies requirement\" \"Requirement Implementation\" \1"
ALIASES += verify{1}="\xrefitem verify \"Verifies requirement\" \"Requirement Verification\" \1"

28
include/bluetooth/bluetooth.h
View file

@ -130,7 +130,7 @@ typedef void (*bt_ready_cb_t)(int err);
* Enable Bluetooth. Must be the called before any calls that
* require communication with the local Bluetooth hardware.
*
* When @option{CONFIG_BT_SETTINGS} has been enabled and the application is not
* When @kconfig{CONFIG_BT_SETTINGS} has been enabled and the application is not
* managing identities of the stack itself then the application must call
* @ref settings_load() before the stack is fully enabled.
* See @ref bt_id_create() for more information.
@ -223,7 +223,7 @@ void bt_id_get(bt_addr_le_t *addrs, size_t *count);
* generate a random IRK for the identity and copy it back
* to the parameter upon return from this function (in case
* the parameter was non-NULL). If privacy
* @option{CONFIG_BT_PRIVACY} is not enabled this parameter must
* @kconfig{CONFIG_BT_PRIVACY} is not enabled this parameter must
* be NULL.
*
* @return Identity identifier (>= 0) in case of success, or a negative
@ -257,7 +257,7 @@ int bt_id_create(bt_addr_le_t *addr, uint8_t *irk);
* generate a random IRK for the identity and copy it back
* to the parameter upon return from this function (in case
* the parameter was non-NULL). If privacy
* @option{CONFIG_BT_PRIVACY} is not enabled this parameter must
* @kconfig{CONFIG_BT_PRIVACY} is not enabled this parameter must
* be NULL.
*
* @return Identity identifier (>= 0) in case of success, or a negative
@ -337,7 +337,7 @@ enum {
* Advertise as connectable. If not connectable then the type of
* advertising is determined by providing scan response data.
* The advertiser address is determined by the type of advertising
* and/or enabling privacy @option{CONFIG_BT_PRIVACY}.
* and/or enabling privacy @kconfig{CONFIG_BT_PRIVACY}.
*/
BT_LE_ADV_OPT_CONNECTABLE = BIT(0),
@ -523,7 +523,7 @@ struct bt_le_adv_param {
/**
* @brief Local identity.
*
* @note When extended advertising @option{CONFIG_BT_EXT_ADV} is not
* @note When extended advertising @kconfig{CONFIG_BT_EXT_ADV} is not
* enabled or not supported by the controller it is not possible
* to scan and advertise simultaneously using two different
* random addresses.
@ -887,8 +887,8 @@ struct bt_le_ext_adv_start_param {
* this parameters must be set to a non-zero value less than or equal
* to the maximum of @ref BT_GAP_ADV_HIGH_DUTY_CYCLE_MAX_TIMEOUT.
*
* If privacy @option{CONFIG_BT_PRIVACY} is enabled then the timeout
* must be less than @option{CONFIG_BT_RPA_TIMEOUT}.
* If privacy @kconfig{CONFIG_BT_PRIVACY} is enabled then the timeout
* must be less than @kconfig{CONFIG_BT_RPA_TIMEOUT}.
*/
uint16_t timeout;
/**
@ -1792,11 +1792,11 @@ struct bt_le_scan_cb {
* the specified callback.
*
* @note The LE scanner by default does not use the Identity Address of the
* local device when @option{CONFIG_BT_PRIVACY} is disabled. This is to
* local device when @kconfig{CONFIG_BT_PRIVACY} is disabled. This is to
* prevent the active scanner from disclosing the identity information
* when requesting additional information from advertisers.
* In order to enable directed advertiser reports then
* @option{CONFIG_BT_SCAN_WITH_IDENTITY} must be enabled.
* @kconfig{CONFIG_BT_SCAN_WITH_IDENTITY} must be enabled.
*
* @param param Scan parameters.
* @param cb Callback to notify scan results. May be NULL if callback
@ -1939,16 +1939,16 @@ struct bt_le_oob {
* This function allows to get local information that are useful for
* Out of Band pairing or connection creation.
*
* If privacy @option{CONFIG_BT_PRIVACY} is enabled this will result in
* If privacy @kconfig{CONFIG_BT_PRIVACY} is enabled this will result in
* generating new Resolvable Private Address (RPA) that is valid for
* @option{CONFIG_BT_RPA_TIMEOUT} seconds. This address will be used for
* @kconfig{CONFIG_BT_RPA_TIMEOUT} seconds. This address will be used for
* advertising started by @ref bt_le_adv_start, active scanning and
* connection creation.
*
* @note If privacy is enabled the RPA cannot be refreshed in the following
* cases:
* - Creating a connection in progress, wait for the connected callback.
* In addition when extended advertising @option{CONFIG_BT_EXT_ADV} is
* In addition when extended advertising @kconfig{CONFIG_BT_EXT_ADV} is
* not enabled or not supported by the controller:
* - Advertiser is enabled using a Random Static Identity Address for a
* different local identity.
@ -1969,9 +1969,9 @@ int bt_le_oob_get_local(uint8_t id, struct bt_le_oob *oob);
* This function allows to get local information that are useful for
* Out of Band pairing or connection creation.
*
* If privacy @option{CONFIG_BT_PRIVACY} is enabled this will result in
* If privacy @kconfig{CONFIG_BT_PRIVACY} is enabled this will result in
* generating new Resolvable Private Address (RPA) that is valid for
* @option{CONFIG_BT_RPA_TIMEOUT} seconds. This address will be used by the
* @kconfig{CONFIG_BT_RPA_TIMEOUT} seconds. This address will be used by the
* advertising set.
*
* @note When generating OOB information for multiple advertising set all

16
include/bluetooth/conn.h
View file

@ -346,7 +346,7 @@ struct bt_conn_br_remote_info {
/** @brief Connection Remote Info Structure
*
* @note The version, manufacturer and subversion fields will only contain
* valid data if @option{CONFIG_BT_REMOTE_VERSION} is enabled.
* valid data if @kconfig{CONFIG_BT_REMOTE_VERSION} is enabled.
*/
struct bt_conn_remote_info {
/** Connection Type */
@ -411,7 +411,7 @@ int bt_conn_get_info(const struct bt_conn *conn, struct bt_conn_info *info);
* @param remote_info Connection remote info object.
*
* @note In order to retrieve the remote version (version, manufacturer
* and subversion) @option{CONFIG_BT_REMOTE_VERSION} must be enabled
* and subversion) @kconfig{CONFIG_BT_REMOTE_VERSION} must be enabled
*
* @note The remote information is exchanged directly after the connection has
* been established. The application can be notified about when the remote
@ -438,7 +438,7 @@ int bt_conn_le_get_tx_power_level(struct bt_conn *conn,
*
* If the local device is in the peripheral role then updating the connection
* parameters will be delayed. This delay can be configured by through the
* @option{CONFIG_BT_CONN_PARAM_UPDATE_TIMEOUT} option.
* @kconfig{CONFIG_BT_CONN_PARAM_UPDATE_TIMEOUT} option.
*
* @param conn Connection object.
* @param param Updated connection parameters.
@ -539,7 +539,7 @@ struct bt_conn_le_create_param {
/** @brief Connection initiation timeout (N * 10 MS)
*
* Set zero to use the default @option{CONFIG_BT_CREATE_CONN_TIMEOUT}
* Set zero to use the default @kconfig{CONFIG_BT_CREATE_CONN_TIMEOUT}
* timeout.
*
* @note Unused in @ref bt_conn_le_create_auto
@ -693,10 +693,10 @@ typedef enum __packed {
* This function may return error if the pairing procedure has already been
* initiated by the local device or the peer device.
*
* @note When @option{CONFIG_BT_SMP_SC_ONLY} is enabled then the security
* @note When @kconfig{CONFIG_BT_SMP_SC_ONLY} is enabled then the security
* level will always be level 4.
*
* @note When @option{CONFIG_BT_SMP_OOB_LEGACY_PAIR_ONLY} is enabled then the
* @note When @kconfig{CONFIG_BT_SMP_OOB_LEGACY_PAIR_ONLY} is enabled then the
* security level will always be level 3.
*
* @param conn Connection object.
@ -782,7 +782,7 @@ struct bt_conn_cb {
* @ref bt_conn_le_create was canceled either by the user through
* @ref bt_conn_disconnect or by the timeout in the host through
* @ref bt_conn_le_create_param timeout parameter, which defaults to
* @option{CONFIG_BT_CREATE_CONN_TIMEOUT} seconds.
* @kconfig{CONFIG_BT_CREATE_CONN_TIMEOUT} seconds.
* - @p BT_HCI_ERR_ADV_TIMEOUT High duty cycle directed connectable
* advertiser started by @ref bt_le_adv_start failed to be connected
* within the timeout.
@ -801,7 +801,7 @@ struct bt_conn_cb {
* available.
* To avoid this issue it is recommended to either start connectable
* advertise or create a new connection using @ref k_work_submit or
* increase @option{CONFIG_BT_MAX_CONN}.
* increase @kconfig{CONFIG_BT_MAX_CONN}.
*
* @param conn Connection object.
* @param reason HCI reason for the disconnection.

8
include/bluetooth/gatt.h
View file

@ -345,11 +345,11 @@ void bt_gatt_cb_register(struct bt_gatt_cb *cb);
* macros such as BT_GATT_PRIMARY_SERVICE, BT_GATT_CHARACTERISTIC,
* BT_GATT_DESCRIPTOR, etc.
*
* When using @option{CONFIG_BT_SETTINGS} then all services that should have
* When using @kconfig{CONFIG_BT_SETTINGS} then all services that should have
* bond configuration loaded, i.e. CCC values, must be registered before
* calling @ref settings_load.
*
* When using @option{CONFIG_BT_GATT_CACHING} and @option{CONFIG_BT_SETTINGS}
* When using @kconfig{CONFIG_BT_GATT_CACHING} and @kconfig{CONFIG_BT_SETTINGS}
* then all services that should be included in the GATT Database Hash
* calculation should be added before calling @ref settings_load.
* All services registered after settings_load will trigger a new database hash
@ -978,7 +978,7 @@ struct bt_gatt_notify_params {
* When called from the System Workqueue context this API will not wait for
* resources for the callback but instead return an error.
* The number of pending callbacks can be increased with the
* @option{CONFIG_BT_CONN_TX_MAX} option.
* @kconfig{CONFIG_BT_CONN_TX_MAX} option.
*
* Alternatively it is possible to notify by UUID by setting it on the
* parameters, when using this method the attribute if provided is used as the
@ -1464,7 +1464,7 @@ int bt_gatt_write(struct bt_conn *conn, struct bt_gatt_write_params *params);
* When called from the System Workqueue context this API will not wait for
* resources for the callback but instead return an error.
* The number of pending callbacks can be increased with the
* @option{CONFIG_BT_CONN_TX_MAX} option.
* @kconfig{CONFIG_BT_CONN_TX_MAX} option.
*
* @note By using a callback it also disable the internal flow control

2
include/bluetooth/mesh/cfg.h
View file

@ -315,7 +315,7 @@ uint8_t bt_mesh_subnet_kr_phase_get(uint16_t net_idx, uint8_t *phase);
* but only acts on a single Subnet.
*
* GATT Proxy support must be enabled through
* @option{CONFIG_BT_MESH_GATT_PROXY}.
* @kconfig{CONFIG_BT_MESH_GATT_PROXY}.
*
* @param net_idx Network index.
* @param node_id New Node Identity state, must be either @ref

4
include/bluetooth/mesh/main.h
View file

@ -107,7 +107,7 @@ struct bt_mesh_prov {
/** Pointer to Public Key in big-endian for OOB public key type support.
*
* Remember to enable @option{CONFIG_BT_MESH_PROV_OOB_PUBLIC_KEY}
* Remember to enable @kconfig{CONFIG_BT_MESH_PROV_OOB_PUBLIC_KEY}
* when initializing this parameter.
*
* Must be used together with @ref bt_mesh_prov::private_key_be.
@ -115,7 +115,7 @@ struct bt_mesh_prov {
const uint8_t *public_key_be;
/** Pointer to Private Key in big-endian for OOB public key type support.
*
* Remember to enable @option{CONFIG_BT_MESH_PROV_OOB_PUBLIC_KEY}
* Remember to enable @kconfig{CONFIG_BT_MESH_PROV_OOB_PUBLIC_KEY}
* when initializing this parameter.
*
* Must be used together with @ref bt_mesh_prov::public_key_be.

2
include/drivers/adc.h
View file

@ -419,7 +419,7 @@ static inline int z_impl_adc_read(const struct device *dev,
/**
* @brief Set an asynchronous read request.
*
* @note This function is available only if @option{CONFIG_ADC_ASYNC}
* @note This function is available only if @kconfig{CONFIG_ADC_ASYNC}
* is selected.
*
* If invoked from user mode, any sequence struct options for callback must

14
include/drivers/pwm.h
View file

@ -82,7 +82,7 @@ typedef int (*pwm_pin_set_t)(const struct device *dev, uint32_t pwm,
*
* @note The callback handler will be called in interrupt context.
*
* @note @option{CONFIG_PWM_CAPTURE} must be selected to enable PWM capture
* @note @kconfig{CONFIG_PWM_CAPTURE} must be selected to enable PWM capture
* support.
*
* @param dev Pointer to the device structure for the driver instance.
@ -192,7 +192,7 @@ static inline int z_impl_pwm_pin_set_cycles(const struct device *dev,
* pwm_pin_capture_cycles(), @a pwm_pin_capture_usec(), or @a
* pwm_pin_capture_nsec()) can be used instead.
*
* @note @option{CONFIG_PWM_CAPTURE} must be selected for this function to be
* @note @kconfig{CONFIG_PWM_CAPTURE} must be selected for this function to be
* available.
*
* @param dev Pointer to the device structure for the driver instance.
@ -231,7 +231,7 @@ static inline int pwm_pin_configure_capture(const struct device *dev,
* The PWM pin must be configured using @a pwm_pin_configure_capture() prior to
* calling this function.
*
* @note @option{CONFIG_PWM_CAPTURE} must be selected for this function to be
* @note @kconfig{CONFIG_PWM_CAPTURE} must be selected for this function to be
* available.
*
* @param dev Pointer to the device structure for the driver instance.
@ -263,7 +263,7 @@ static inline int z_impl_pwm_pin_enable_capture(const struct device *dev,
* @brief Disable PWM period/pulse width capture for a single PWM input.
*
*
* @note @option{CONFIG_PWM_CAPTURE} must be selected for this function to be
* @note @kconfig{CONFIG_PWM_CAPTURE} must be selected for this function to be
* available.
*
* @param dev Pointer to the device structure for the driver instance.
@ -299,7 +299,7 @@ static inline int z_impl_pwm_pin_disable_capture(const struct device *dev,
* capture result to the caller. The function is blocking until either the PWM
* capture is completed or a timeout occurs.
*
* @note @option{CONFIG_PWM_CAPTURE} must be selected for this function to be
* @note @kconfig{CONFIG_PWM_CAPTURE} must be selected for this function to be
* available.
*
* @param dev Pointer to the device structure for the driver instance.
@ -490,7 +490,7 @@ static inline int pwm_pin_cycles_to_nsec(const struct device *dev, uint32_t pwm,
* function is blocking until either the PWM capture is completed or a timeout
* occurs.
*
* @note @option{CONFIG_PWM_CAPTURE} must be selected for this function to be
* @note @kconfig{CONFIG_PWM_CAPTURE} must be selected for this function to be
* available.
*
* @param dev Pointer to the device structure for the driver instance.
@ -546,7 +546,7 @@ static inline int pwm_pin_capture_usec(const struct device *dev, uint32_t pwm,
* function is blocking until either the PWM capture is completed or a timeout
* occurs.
*
* @note @option{CONFIG_PWM_CAPTURE} must be selected for this function to be
* @note @kconfig{CONFIG_PWM_CAPTURE} must be selected for this function to be
* available.
*
* @param dev Pointer to the device structure for the driver instance.

6
include/drivers/spi.h
View file

@ -449,7 +449,7 @@ static inline int spi_write(const struct device *dev,
*
* @note This function is asynchronous.
*
* @note This function is available only if @option{CONFIG_SPI_ASYNC}
* @note This function is available only if @kconfig{CONFIG_SPI_ASYNC}
* is selected.
*
* @param dev Pointer to the device structure for the driver instance
@ -486,7 +486,7 @@ static inline int spi_transceive_async(const struct device *dev,
*
* @note This function is asynchronous.
*
* @note This function is available only if @option{CONFIG_SPI_ASYNC}
* @note This function is available only if @kconfig{CONFIG_SPI_ASYNC}
* is selected.
*
* @param dev Pointer to the device structure for the driver instance
@ -516,7 +516,7 @@ static inline int spi_read_async(const struct device *dev,
*
* @note This function is asynchronous.
*
* @note This function is available only if @option{CONFIG_SPI_ASYNC}
* @note This function is available only if @kconfig{CONFIG_SPI_ASYNC}
* is selected.
*
* @param dev Pointer to the device structure for the driver instance

10
include/fs/littlefs.h
View file

@ -57,15 +57,15 @@ struct fs_littlefs {
* values are consistent with littlefs requirements.
*
* @note If you use a non-default configuration for cache size, you
* must also select @option{CONFIG_FS_LITTLEFS_FC_HEAP_SIZE} to relax
* must also select @kconfig{CONFIG_FS_LITTLEFS_FC_HEAP_SIZE} to relax
* the size constraints on per-file cache allocations.
*
* @param name the name for the structure. The defined object has
* file scope.
* @param read_sz see @option{CONFIG_FS_LITTLEFS_READ_SIZE}
* @param prog_sz see @option{CONFIG_FS_LITTLEFS_PROG_SIZE}
* @param cache_sz see @option{CONFIG_FS_LITTLEFS_CACHE_SIZE}
* @param lookahead_sz see @option{CONFIG_FS_LITTLEFS_LOOKAHEAD_SIZE}
* @param read_sz see @kconfig{CONFIG_FS_LITTLEFS_READ_SIZE}
* @param prog_sz see @kconfig{CONFIG_FS_LITTLEFS_PROG_SIZE}
* @param cache_sz see @kconfig{CONFIG_FS_LITTLEFS_CACHE_SIZE}
* @param lookahead_sz see @kconfig{CONFIG_FS_LITTLEFS_LOOKAHEAD_SIZE}
*/
#define FS_LITTLEFS_DECLARE_CUSTOM_CONFIG(name, read_sz, prog_sz, cache_sz, lookahead_sz) \
static uint8_t __aligned(4) name ## _read_buffer[cache_sz]; \

30
include/kernel.h
View file

@ -107,7 +107,7 @@ typedef void (*k_thread_user_cb_t)(const struct k_thread *thread,
* @param user_cb Pointer to the user callback function.
* @param user_data Pointer to user data.
*
* @note @option{CONFIG_THREAD_MONITOR} must be set for this function
* @note @kconfig{CONFIG_THREAD_MONITOR} must be set for this function
* to be effective.
* @note This API uses @ref k_spin_lock to protect the _kernel.threads
* list which means creation of new threads and terminations of existing
@ -126,7 +126,7 @@ extern void k_thread_foreach(k_thread_user_cb_t user_cb, void *user_data);
* @param user_cb Pointer to the user callback function.
* @param user_data Pointer to user data.
*
* @note @option{CONFIG_THREAD_MONITOR} must be set for this function
* @note @kconfig{CONFIG_THREAD_MONITOR} must be set for this function
* to be effective.
* @note This API uses @ref k_spin_lock only when accessing the _kernel.threads
* queue elements. It unlocks it during user callback function processing.
@ -176,7 +176,7 @@ extern void k_thread_foreach_unlocked(
* This option indicates that the thread uses the CPU's floating point
* registers. This instructs the kernel to take additional steps to save
* and restore the contents of these registers when scheduling the thread.
* No effect if @option{CONFIG_FPU_SHARING} is not enabled.
* No effect if @kconfig{CONFIG_FPU_SHARING} is not enabled.
*/
#define K_FP_REGS (BIT(1))
#endif
@ -195,7 +195,7 @@ extern void k_thread_foreach_unlocked(
* @details
* Indicates that the thread being created should inherit all kernel object
* permissions from the thread that created it. No effect if
* @option{CONFIG_USERSPACE} is not enabled.
* @kconfig{CONFIG_USERSPACE} is not enabled.
*/
#define K_INHERIT_PERMS (BIT(3))
@ -346,7 +346,7 @@ static inline void k_thread_heap_assign(struct k_thread *thread,
*
* Some hardware may prevent inspection of a stack buffer currently in use.
* If this API is called from supervisor mode, on the currently running thread,
* on a platform which selects @option{CONFIG_NO_UNUSED_STACK_INSPECTION}, an
* on a platform which selects @kconfig{CONFIG_NO_UNUSED_STACK_INSPECTION}, an
* error will be generated.
*
* @param thread Thread to inspect stack information
@ -435,7 +435,7 @@ static inline int32_t k_msleep(int32_t ms)
*
* This function is unlikely to work as expected without kernel tuning.
* In particular, because the lower bound on the duration of a sleep is
* the duration of a tick, @option{CONFIG_SYS_CLOCK_TICKS_PER_SEC} must be
* the duration of a tick, @kconfig{CONFIG_SYS_CLOCK_TICKS_PER_SEC} must be
* adjusted to achieve the resolution desired. The implications of doing
* this must be understood before attempting to use k_usleep(). Use with
* caution.
@ -723,7 +723,7 @@ __syscall void k_thread_priority_set(k_tid_t thread, int prio);
* above this call, which is simply input to the priority selection
* logic.
*
* @note You should enable @option{CONFIG_SCHED_DEADLINE} in your project
* @note You should enable @kconfig{CONFIG_SCHED_DEADLINE} in your project
* configuration.
*
* @param thread A thread on which to set the deadline
@ -740,7 +740,7 @@ __syscall void k_thread_deadline_set(k_tid_t thread, int deadline);
* After this returns, the thread will no longer be schedulable on any
* CPUs. The thread must not be currently runnable.
*
* @note You should enable @option{CONFIG_SCHED_DEADLINE} in your project
* @note You should enable @kconfig{CONFIG_SCHED_DEADLINE} in your project
* configuration.
*
* @param thread Thread to operate upon
@ -754,7 +754,7 @@ int k_thread_cpu_mask_clear(k_tid_t thread);
* After this returns, the thread will be schedulable on any CPU. The
* thread must not be currently runnable.
*
* @note You should enable @option{CONFIG_SCHED_DEADLINE} in your project
* @note You should enable @kconfig{CONFIG_SCHED_DEADLINE} in your project
* configuration.
*
* @param thread Thread to operate upon
@ -767,7 +767,7 @@ int k_thread_cpu_mask_enable_all(k_tid_t thread);
*
* The thread must not be currently runnable.
*
* @note You should enable @option{CONFIG_SCHED_DEADLINE} in your project
* @note You should enable @kconfig{CONFIG_SCHED_DEADLINE} in your project
* configuration.
*
* @param thread Thread to operate upon
@ -781,7 +781,7 @@ int k_thread_cpu_mask_enable(k_tid_t thread, int cpu);
*
* The thread must not be currently runnable.
*
* @note You should enable @option{CONFIG_SCHED_DEADLINE} in your project
* @note You should enable @kconfig{CONFIG_SCHED_DEADLINE} in your project
* configuration.
*
* @param thread Thread to operate upon
@ -978,7 +978,7 @@ __syscall void *k_thread_custom_data_get(void);
/**
* @brief Set current thread name
*
* Set the name of the thread to be used when @option{CONFIG_THREAD_MONITOR}
* Set the name of the thread to be used when @kconfig{CONFIG_THREAD_MONITOR}
* is enabled for tracing and debugging.
*
* @param thread Thread to set name, or NULL to set the current thread
@ -1522,7 +1522,7 @@ static inline void *z_impl_k_timer_user_data_get(const struct k_timer *timer)
* @brief Get system uptime, in system ticks.
*
* This routine returns the elapsed time since the system booted, in
* ticks (c.f. @option{CONFIG_SYS_CLOCK_TICKS_PER_SEC}), which is the
* ticks (c.f. @kconfig{CONFIG_SYS_CLOCK_TICKS_PER_SEC}), which is the
* fundamental unit of resolution of kernel timekeeping.
*
* @return Current uptime in ticks.
@ -1538,7 +1538,7 @@ __syscall int64_t k_uptime_ticks(void);
* @note
* While this function returns time in milliseconds, it does
* not mean it has millisecond resolution. The actual resolution depends on
* @option{CONFIG_SYS_CLOCK_TICKS_PER_SEC} config option.
* @kconfig{CONFIG_SYS_CLOCK_TICKS_PER_SEC} config option.
*
* @return Current uptime in milliseconds.
*/
@ -1562,7 +1562,7 @@ static inline int64_t k_uptime_get(void)
* @note
* While this function returns time in milliseconds, it does
* not mean it has millisecond resolution. The actual resolution depends on
* @option{CONFIG_SYS_CLOCK_TICKS_PER_SEC} config option
* @kconfig{CONFIG_SYS_CLOCK_TICKS_PER_SEC} config option
*
* @return The low 32 bits of the current uptime, in milliseconds.
*/

2
include/net/mqtt.h
View file

@ -571,7 +571,7 @@ int mqtt_client_set_proxy(struct mqtt_client *client,
* @note Default protocol revision used for connection request is 3.1.1. Please
* set client.protocol_version = MQTT_VERSION_3_1_0 to use protocol 3.1.0.
* @note
* Please modify @option{CONFIG_MQTT_KEEPALIVE} time to override default
* Please modify @kconfig{CONFIG_MQTT_KEEPALIVE} time to override default
* of 1 minute.
*/
int mqtt_connect(struct mqtt_client *client);

50
include/net/socket.h
View file

@ -211,7 +211,7 @@ __syscall void *zsock_get_context_object(int sock);
* <http://pubs.opengroup.org/onlinepubs/9699919799/functions/socket.html>`__
* for normative description.
* This function is also exposed as ``socket()``
* if :option:`CONFIG_NET_SOCKETS_POSIX_NAMES` is defined.
* if :kconfig:`CONFIG_NET_SOCKETS_POSIX_NAMES` is defined.
* @endrst
*
* If CONFIG_USERSPACE is enabled, the caller will be granted access to the
@ -230,7 +230,7 @@ __syscall int zsock_socket(int family, int type, int proto);
* <https://pubs.opengroup.org/onlinepubs/009695399/functions/socketpair.html>`__
* for normative description.
* This function is also exposed as ``socketpair()``
* if :option:`CONFIG_NET_SOCKETS_POSIX_NAMES` is defined.
* if :kconfig:`CONFIG_NET_SOCKETS_POSIX_NAMES` is defined.
* @endrst
*/
__syscall int zsock_socketpair(int family, int type, int proto, int *sv);
@ -242,7 +242,7 @@ __syscall int zsock_socketpair(int family, int type, int proto, int *sv);
* @rst
* Close a network socket.
* This function is also exposed as ``close()``
* if :option:`CONFIG_NET_SOCKETS_POSIX_NAMES` is defined (in which case it
* if :kconfig:`CONFIG_NET_SOCKETS_POSIX_NAMES` is defined (in which case it
* may conflict with generic POSIX ``close()`` function).
* @endrst
*/
@ -258,7 +258,7 @@ __syscall int zsock_close(int sock);
* for normative description, but currently this function has no effect in
* Zephyr and provided solely for compatibility with existing code.
* This function is also exposed as ``shutdown()``
* if :option:`CONFIG_NET_SOCKETS_POSIX_NAMES` is defined.
* if :kconfig:`CONFIG_NET_SOCKETS_POSIX_NAMES` is defined.
* @endrst
*/
__syscall int zsock_shutdown(int sock, int how);
@ -272,7 +272,7 @@ __syscall int zsock_shutdown(int sock, int how);
* <http://pubs.opengroup.org/onlinepubs/9699919799/functions/bind.html>`__
* for normative description.
* This function is also exposed as ``bind()``
* if :option:`CONFIG_NET_SOCKETS_POSIX_NAMES` is defined.
* if :kconfig:`CONFIG_NET_SOCKETS_POSIX_NAMES` is defined.
* @endrst
*/
__syscall int zsock_bind(int sock, const struct sockaddr *addr,
@ -287,7 +287,7 @@ __syscall int zsock_bind(int sock, const struct sockaddr *addr,
* <http://pubs.opengroup.org/onlinepubs/9699919799/functions/connect.html>`__
* for normative description.
* This function is also exposed as ``connect()``
* if :option:`CONFIG_NET_SOCKETS_POSIX_NAMES` is defined.
* if :kconfig:`CONFIG_NET_SOCKETS_POSIX_NAMES` is defined.
* @endrst
*/
__syscall int zsock_connect(int sock, const struct sockaddr *addr,
@ -302,7 +302,7 @@ __syscall int zsock_connect(int sock, const struct sockaddr *addr,
* <http://pubs.opengroup.org/onlinepubs/9699919799/functions/listen.html>`__
* for normative description.
* This function is also exposed as ``listen()``
* if :option:`CONFIG_NET_SOCKETS_POSIX_NAMES` is defined.
* if :kconfig:`CONFIG_NET_SOCKETS_POSIX_NAMES` is defined.
* @endrst
*/
__syscall int zsock_listen(int sock, int backlog);
@ -316,7 +316,7 @@ __syscall int zsock_listen(int sock, int backlog);
* <http://pubs.opengroup.org/onlinepubs/9699919799/functions/accept.html>`__
* for normative description.
* This function is also exposed as ``accept()``
* if :option:`CONFIG_NET_SOCKETS_POSIX_NAMES` is defined.
* if :kconfig:`CONFIG_NET_SOCKETS_POSIX_NAMES` is defined.
* @endrst
*/
__syscall int zsock_accept(int sock, struct sockaddr *addr, socklen_t *addrlen);
@ -330,7 +330,7 @@ __syscall int zsock_accept(int sock, struct sockaddr *addr, socklen_t *addrlen);
* <http://pubs.opengroup.org/onlinepubs/9699919799/functions/sendto.html>`__
* for normative description.
* This function is also exposed as ``sendto()``
* if :option:`CONFIG_NET_SOCKETS_POSIX_NAMES` is defined.
* if :kconfig:`CONFIG_NET_SOCKETS_POSIX_NAMES` is defined.
* @endrst
*/
__syscall ssize_t zsock_sendto(int sock, const void *buf, size_t len,
@ -346,7 +346,7 @@ __syscall ssize_t zsock_sendto(int sock, const void *buf, size_t len,
* <http://pubs.opengroup.org/onlinepubs/9699919799/functions/send.html>`__
* for normative description.
* This function is also exposed as ``send()``
* if :option:`CONFIG_NET_SOCKETS_POSIX_NAMES` is defined.
* if :kconfig:`CONFIG_NET_SOCKETS_POSIX_NAMES` is defined.
* @endrst
*/
static inline ssize_t zsock_send(int sock, const void *buf, size_t len,
@ -364,7 +364,7 @@ static inline ssize_t zsock_send(int sock, const void *buf, size_t len,
* <http://pubs.opengroup.org/onlinepubs/9699919799/functions/sendmsg.html>`__
* for normative description.
* This function is also exposed as ``sendmsg()``
* if :option:`CONFIG_NET_SOCKETS_POSIX_NAMES` is defined.
* if :kconfig:`CONFIG_NET_SOCKETS_POSIX_NAMES` is defined.
* @endrst
*/
__syscall ssize_t zsock_sendmsg(int sock, const struct msghdr *msg,
@ -379,7 +379,7 @@ __syscall ssize_t zsock_sendmsg(int sock, const struct msghdr *msg,
* <http://pubs.opengroup.org/onlinepubs/9699919799/functions/recvfrom.html>`__
* for normative description.
* This function is also exposed as ``recvfrom()``
* if :option:`CONFIG_NET_SOCKETS_POSIX_NAMES` is defined.
* if :kconfig:`CONFIG_NET_SOCKETS_POSIX_NAMES` is defined.
* @endrst
*/
__syscall ssize_t zsock_recvfrom(int sock, void *buf, size_t max_len,
@ -395,7 +395,7 @@ __syscall ssize_t zsock_recvfrom(int sock, void *buf, size_t max_len,
* <http://pubs.opengroup.org/onlinepubs/9699919799/functions/recv.html>`__
* for normative description.
* This function is also exposed as ``recv()``
* if :option:`CONFIG_NET_SOCKETS_POSIX_NAMES` is defined.
* if :kconfig:`CONFIG_NET_SOCKETS_POSIX_NAMES` is defined.
* @endrst
*/
static inline ssize_t zsock_recv(int sock, void *buf, size_t max_len,
@ -412,7 +412,7 @@ static inline ssize_t zsock_recv(int sock, void *buf, size_t max_len,
* This functions allow to (only) configure a socket for blocking or
* non-blocking operation (O_NONBLOCK).
* This function is also exposed as ``fcntl()``
* if :option:`CONFIG_NET_SOCKETS_POSIX_NAMES` is defined (in which case
* if :kconfig:`CONFIG_NET_SOCKETS_POSIX_NAMES` is defined (in which case
* it may conflict with generic POSIX ``fcntl()`` function).
* @endrst
*/
@ -428,7 +428,7 @@ __syscall int zsock_fcntl(int sock, int cmd, int flags);
* for normative description. (In Zephyr this function works only with
* sockets, not arbitrary file descriptors.)
* This function is also exposed as ``poll()``
* if :option:`CONFIG_NET_SOCKETS_POSIX_NAMES` is defined (in which case
* if :kconfig:`CONFIG_NET_SOCKETS_POSIX_NAMES` is defined (in which case
* it may conflict with generic POSIX ``poll()`` function).
* @endrst
*/
@ -446,7 +446,7 @@ __syscall int zsock_poll(struct zsock_pollfd *fds, int nfds, int timeout);
* available in Linux (some options are dummy and provided to ease porting
* of existing code).
* This function is also exposed as ``getsockopt()``
* if :option:`CONFIG_NET_SOCKETS_POSIX_NAMES` is defined.
* if :kconfig:`CONFIG_NET_SOCKETS_POSIX_NAMES` is defined.
* @endrst
*/
__syscall int zsock_getsockopt(int sock, int level, int optname,
@ -464,7 +464,7 @@ __syscall int zsock_getsockopt(int sock, int level, int optname,
* available in Linux (some options are dummy and provided to ease porting
* of existing code).
* This function is also exposed as ``setsockopt()``
* if :option:`CONFIG_NET_SOCKETS_POSIX_NAMES` is defined.
* if :kconfig:`CONFIG_NET_SOCKETS_POSIX_NAMES` is defined.
* @endrst
*/
__syscall int zsock_setsockopt(int sock, int level, int optname,
@ -479,7 +479,7 @@ __syscall int zsock_setsockopt(int sock, int level, int optname,
* <http://pubs.opengroup.org/onlinepubs/9699919799/functions/getsockname.html>`__
* for normative description.
* This function is also exposed as ``getsockname()``
* if :option:`CONFIG_NET_SOCKETS_POSIX_NAMES` is defined.
* if :kconfig:`CONFIG_NET_SOCKETS_POSIX_NAMES` is defined.
* @endrst
*/
__syscall int zsock_getsockname(int sock, struct sockaddr *addr,
@ -494,7 +494,7 @@ __syscall int zsock_getsockname(int sock, struct sockaddr *addr,
* <http://pubs.opengroup.org/onlinepubs/9699919799/functions/gethostname.html>`__
* for normative description.
* This function is also exposed as ``gethostname()``
* if :option:`CONFIG_NET_SOCKETS_POSIX_NAMES` is defined.
* if :kconfig:`CONFIG_NET_SOCKETS_POSIX_NAMES` is defined.
* @endrst
*/
__syscall int zsock_gethostname(char *buf, size_t len);
@ -508,7 +508,7 @@ __syscall int zsock_gethostname(char *buf, size_t len);
* <http://pubs.opengroup.org/onlinepubs/9699919799/functions/inet_ntop.html>`__
* for normative description.
* This function is also exposed as ``inet_ntop()``
* if :option:`CONFIG_NET_SOCKETS_POSIX_NAMES` is defined.
* if :kconfig:`CONFIG_NET_SOCKETS_POSIX_NAMES` is defined.
* @endrst
*/
static inline char *zsock_inet_ntop(sa_family_t family, const void *src,
@ -526,7 +526,7 @@ static inline char *zsock_inet_ntop(sa_family_t family, const void *src,
* <http://pubs.opengroup.org/onlinepubs/9699919799/functions/inet_pton.html>`__
* for normative description.
* This function is also exposed as ``inet_pton()``
* if :option:`CONFIG_NET_SOCKETS_POSIX_NAMES` is defined.
* if :kconfig:`CONFIG_NET_SOCKETS_POSIX_NAMES` is defined.
* @endrst
*/
__syscall int zsock_inet_pton(sa_family_t family, const char *src, void *dst);
@ -564,7 +564,7 @@ __syscall int z_zsock_getaddrinfo_internal(const char *host,
* <http://pubs.opengroup.org/onlinepubs/9699919799/functions/getaddrinfo.html>`__
* for normative description.
* This function is also exposed as ``getaddrinfo()``
* if :option:`CONFIG_NET_SOCKETS_POSIX_NAMES` is defined.
* if :kconfig:`CONFIG_NET_SOCKETS_POSIX_NAMES` is defined.
* @endrst
*/
int zsock_getaddrinfo(const char *host, const char *service,
@ -580,7 +580,7 @@ int zsock_getaddrinfo(const char *host, const char *service,
* <http://pubs.opengroup.org/onlinepubs/9699919799/functions/freeaddrinfo.html>`__
* for normative description.
* This function is also exposed as ``freeaddrinfo()``
* if :option:`CONFIG_NET_SOCKETS_POSIX_NAMES` is defined.
* if :kconfig:`CONFIG_NET_SOCKETS_POSIX_NAMES` is defined.
* @endrst
*/
void zsock_freeaddrinfo(struct zsock_addrinfo *ai);
@ -594,7 +594,7 @@ void zsock_freeaddrinfo(struct zsock_addrinfo *ai);
* <http://pubs.opengroup.org/onlinepubs/9699919799/functions/gai_strerror.html>`__
* for normative description.
* This function is also exposed as ``gai_strerror()``
* if :option:`CONFIG_NET_SOCKETS_POSIX_NAMES` is defined.
* if :kconfig:`CONFIG_NET_SOCKETS_POSIX_NAMES` is defined.
* @endrst
*/
const char *zsock_gai_strerror(int errcode);
@ -626,7 +626,7 @@ const char *zsock_gai_strerror(int errcode);
* <http://pubs.opengroup.org/onlinepubs/9699919799/functions/getnameinfo.html>`__
* for normative description.
* This function is also exposed as ``getnameinfo()``
* if :option:`CONFIG_NET_SOCKETS_POSIX_NAMES` is defined.
* if :kconfig:`CONFIG_NET_SOCKETS_POSIX_NAMES` is defined.
* @endrst
*/
int zsock_getnameinfo(const struct sockaddr *addr, socklen_t addrlen,

10
include/net/socket_select.h
View file

@ -37,7 +37,7 @@ typedef struct zsock_fd_set {
* use :c:func:`zsock_poll()` instead. In Zephyr this function works only with
* sockets, not arbitrary file descriptors.
* This function is also exposed as ``select()``
* if :option:`CONFIG_NET_SOCKETS_POSIX_NAMES` is defined (in which case
* if :kconfig:`CONFIG_NET_SOCKETS_POSIX_NAMES` is defined (in which case
* it may conflict with generic POSIX ``select()`` function).
* @endrst
*/
@ -58,7 +58,7 @@ __syscall int zsock_select(int nfds, zsock_fd_set *readfds,
* <http://pubs.opengroup.org/onlinepubs/9699919799/functions/select.html>`__
* for normative description.
* This function is also exposed as ``FD_ZERO()``
* if :option:`CONFIG_NET_SOCKETS_POSIX_NAMES` is defined.
* if :kconfig:`CONFIG_NET_SOCKETS_POSIX_NAMES` is defined.
* @endrst
*/
void ZSOCK_FD_ZERO(zsock_fd_set *set);
@ -72,7 +72,7 @@ void ZSOCK_FD_ZERO(zsock_fd_set *set);
* <http://pubs.opengroup.org/onlinepubs/9699919799/functions/select.html>`__
* for normative description.
* This function is also exposed as ``FD_ISSET()``
* if :option:`CONFIG_NET_SOCKETS_POSIX_NAMES` is defined.
* if :kconfig:`CONFIG_NET_SOCKETS_POSIX_NAMES` is defined.
* @endrst
*/
int ZSOCK_FD_ISSET(int fd, zsock_fd_set *set);
@ -86,7 +86,7 @@ int ZSOCK_FD_ISSET(int fd, zsock_fd_set *set);
* <http://pubs.opengroup.org/onlinepubs/9699919799/functions/select.html>`__
* for normative description.
* This function is also exposed as ``FD_CLR()``
* if :option:`CONFIG_NET_SOCKETS_POSIX_NAMES` is defined.
* if :kconfig:`CONFIG_NET_SOCKETS_POSIX_NAMES` is defined.
* @endrst
*/
void ZSOCK_FD_CLR(int fd, zsock_fd_set *set);
@ -100,7 +100,7 @@ void ZSOCK_FD_CLR(int fd, zsock_fd_set *set);
* <http://pubs.opengroup.org/onlinepubs/9699919799/functions/select.html>`__
* for normative description.
* This function is also exposed as ``FD_SET()``
* if :option:`CONFIG_NET_SOCKETS_POSIX_NAMES` is defined.
* if :kconfig:`CONFIG_NET_SOCKETS_POSIX_NAMES` is defined.
* @endrst
*/
void ZSOCK_FD_SET(int fd, zsock_fd_set *set);

2
include/shell/shell.h
View file

@ -1024,7 +1024,7 @@ struct getopt_state *shell_getopt_state_get(const struct shell *shell);
*
* @param[in] shell Pointer to the shell instance.
* It can be NULL when the
* @option{CONFIG_SHELL_BACKEND_DUMMY} option is enabled.
* @kconfig{CONFIG_SHELL_BACKEND_DUMMY} option is enabled.
* @param[in] cmd Command to be executed.
*
* @return Result of the execution

30
include/sys/cbprintf.h
View file

@ -246,7 +246,7 @@ int cbpprintf(cbprintf_cb out,
* the functionality is enabled.
*
* @note The functionality of this function is significantly reduced
* when @option{CONFIG_CBPRINTF_NANO} is selected.
* when @kconfig{CONFIG_CBPRINTF_NANO} is selected.
*
* @param out the function used to emit each generated character.
*
@ -272,10 +272,10 @@ int cbprintf(cbprintf_cb out, void *ctx, const char *format, ...);
* temporary buffer.
*
* @note This function is available only when
* @option{CONFIG_CBPRINTF_LIBC_SUBSTS} is selected.
* @kconfig{CONFIG_CBPRINTF_LIBC_SUBSTS} is selected.
*
* @note The functionality of this function is significantly reduced when
* @option{CONFIG_CBPRINTF_NANO} is selected.
* @kconfig{CONFIG_CBPRINTF_NANO} is selected.
*
* @param out the function used to emit each generated character.
*
@ -296,10 +296,10 @@ int cbvprintf(cbprintf_cb out, void *ctx, const char *format, va_list ap);
/** @brief fprintf using Zephyrs cbprintf infrastructure.
*
* @note This function is available only when
* @option{CONFIG_CBPRINTF_LIBC_SUBSTS} is selected.
* @kconfig{CONFIG_CBPRINTF_LIBC_SUBSTS} is selected.
*
* @note The functionality of this function is significantly reduced
* when @option{CONFIG_CBPRINTF_NANO} is selected.
* when @kconfig{CONFIG_CBPRINTF_NANO} is selected.
*
* @param stream the stream to which the output should be written.
*
@ -317,10 +317,10 @@ int fprintfcb(FILE * stream, const char *format, ...);
/** @brief vfprintf using Zephyrs cbprintf infrastructure.
*
* @note This function is available only when
* @option{CONFIG_CBPRINTF_LIBC_SUBSTS} is selected.
* @kconfig{CONFIG_CBPRINTF_LIBC_SUBSTS} is selected.
*
* @note The functionality of this function is significantly reduced when
* @option{CONFIG_CBPRINTF_NANO} is selected.
* @kconfig{CONFIG_CBPRINTF_NANO} is selected.
*
* @param stream the stream to which the output should be written.
*
@ -336,10 +336,10 @@ int vfprintfcb(FILE *stream, const char *format, va_list ap);
/** @brief printf using Zephyrs cbprintf infrastructure.
*
* @note This function is available only when
* @option{CONFIG_CBPRINTF_LIBC_SUBSTS} is selected.
* @kconfig{CONFIG_CBPRINTF_LIBC_SUBSTS} is selected.
*
* @note The functionality of this function is significantly reduced
* when @option{CONFIG_CBPRINTF_NANO} is selected.
* when @kconfig{CONFIG_CBPRINTF_NANO} is selected.
*
* @param format a standard ISO C format string with characters and
* conversion specifications.
@ -355,10 +355,10 @@ int printfcb(const char *format, ...);
/** @brief vprintf using Zephyrs cbprintf infrastructure.
*
* @note This function is available only when
* @option{CONFIG_CBPRINTF_LIBC_SUBSTS} is selected.
* @kconfig{CONFIG_CBPRINTF_LIBC_SUBSTS} is selected.
*
* @note The functionality of this function is significantly reduced when
* @option{CONFIG_CBPRINTF_NANO} is selected.
* @kconfig{CONFIG_CBPRINTF_NANO} is selected.
*
* @param format a standard ISO C format string with characters and conversion
* specifications.
@ -372,10 +372,10 @@ int vprintfcb(const char *format, va_list ap);
/** @brief snprintf using Zephyrs cbprintf infrastructure.
*
* @note This function is available only when
* @option{CONFIG_CBPRINTF_LIBC_SUBSTS} is selected.
* @kconfig{CONFIG_CBPRINTF_LIBC_SUBSTS} is selected.
*
* @note The functionality of this function is significantly reduced
* when @option{CONFIG_CBPRINTF_NANO} is selected.
* when @kconfig{CONFIG_CBPRINTF_NANO} is selected.
*
* @param str where the formatted content should be written
*
@ -398,10 +398,10 @@ int snprintfcb(char *str, size_t size, const char *format, ...);
/** @brief vsnprintf using Zephyrs cbprintf infrastructure.
*
* @note This function is available only when
* @option{CONFIG_CBPRINTF_LIBC_SUBSTS} is selected.
* @kconfig{CONFIG_CBPRINTF_LIBC_SUBSTS} is selected.
*
* @note The functionality of this function is significantly reduced when
* @option{CONFIG_CBPRINTF_NANO} is selected.
* @kconfig{CONFIG_CBPRINTF_NANO} is selected.
*
* @param str where the formatted content should be written
*

2
include/sys/notify.h
View file

@ -280,7 +280,7 @@ static inline void sys_notify_init_spinwait(struct sys_notify *notify)
* reinitialized before it can be re-used.
*
* @note
* This capability is available only when @option{CONFIG_POLL} is
* This capability is available only when @kconfig{CONFIG_POLL} is
* selected.
*
* @param notify pointer to the notification configuration object.