michaelh/zephyr
1
0
Fork 0
Code Releases Activity

Bluetooth: Mesh: Align capitalization for BT mesh

Browse source 
Align the capitalization of the term "Bluetooth Mesh" to Bluetooth mesh"
in the documentation. This is done to to match the new updated naming
convention done in Bluetooth SIG. In the upcoming spec versions, it its
used "Bluetooth mesh" with the lower case convention.

Signed-off-by: Ingar Kulbrandstad <ingar.kulbrandstad@nordicsemi.no>
This commit is contained in:
Ingar Kulbrandstad 2021-06-08 09:32:13 +02:00 • committed by Christopher Friedt
commit 3ec6411c7f
81 changed files with 154 additions and 245 deletions
Download patch file Download diff file Expand all files Collapse all files

2
include/bluetooth/mesh.h
View file

@ -1,5 +1,5 @@
/** @file
* @brief Bluetooth Mesh Profile APIs.
* @brief Bluetooth mesh Profile APIs.
*/
/*

6
include/bluetooth/mesh/access.h
View file

@ -1,5 +1,5 @@
/** @file
* @brief Bluetooth Mesh Access Layer APIs.
* @brief Access layer APIs.
*/
/*
@ -25,8 +25,8 @@
BT_MESH_ADDR_UNASSIGNED_ELT_) }
/**
* @brief Bluetooth Mesh Access Layer
* @defgroup bt_mesh_access Bluetooth Mesh Access Layer
* @brief Access layer
* @defgroup bt_mesh_access Access layer
* @ingroup bt_mesh
* @{
*/

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

@ -1,5 +1,5 @@
/** @file
* @brief Bluetooth Mesh Runtime Configuration APIs.
* @brief Runtime configuration APIs.
*/
/*
@ -15,8 +15,8 @@
#include <sys/types.h>
/**
* @brief Bluetooth Mesh Runtime Configuration API
* @defgroup bt_mesh_cfg Bluetooth Mesh Runtime Configuration
* @brief Runtime Configuration
* @defgroup bt_mesh_cfg Runtime Configuration
* @ingroup bt_mesh
* @{
*/
@ -25,7 +25,7 @@
extern "C" {
#endif
/** Bluetooth Mesh Feature states */
/** Bluetooth mesh feature states */
enum bt_mesh_feat_state {
/** Feature is supported, but disabled. */
BT_MESH_FEATURE_DISABLED,
@ -207,8 +207,8 @@ int bt_mesh_friend_set(enum bt_mesh_feat_state friendship);
enum bt_mesh_feat_state bt_mesh_friend_get(void);
/**
* @brief Bluetooth Mesh Subnet Configuration
* @defgroup bt_mesh_cfg_subnet Bluetooth Mesh Subnet Configuration
* @brief Subnet Configuration
* @defgroup bt_mesh_cfg_subnet Subnet Configuration
* @{
*/
@ -369,8 +369,8 @@ ssize_t bt_mesh_subnets_get(uint16_t net_idxs[], size_t max, off_t skip);
*/
/**
* @brief Bluetooth Mesh Application Configuration
* @defgroup bt_mesh_cfg_app Bluetooth Mesh Application Configuration
* @brief Application Configuration
* @defgroup bt_mesh_cfg_app Application Configuration
* @{
*/

6
include/bluetooth/mesh/cfg_cli.h
View file

@ -1,5 +1,5 @@
/** @file
* @brief Bluetooth Mesh Configuration Client Model APIs.
* @brief Configuration Client Model APIs.
*/
/*
@ -11,8 +11,8 @@
#define ZEPHYR_INCLUDE_BLUETOOTH_MESH_CFG_CLI_H_
/**
* @brief Bluetooth Mesh
* @defgroup bt_mesh_cfg_cli Bluetooth Mesh Configuration Client Model
* @brief Configuration Client Model
* @defgroup bt_mesh_cfg_cli Configuration Client Model
* @ingroup bt_mesh
* @{
*/

6
include/bluetooth/mesh/cfg_srv.h
View file

@ -1,5 +1,5 @@
/** @file
* @brief Bluetooth Mesh Configuration Server Model APIs.
* @brief Configuration Server Model APIs.
*/
/*
@ -11,8 +11,8 @@
#define ZEPHYR_INCLUDE_BLUETOOTH_MESH_CFG_SRV_H_
/**
* @brief Bluetooth Mesh
* @defgroup bt_mesh_cfg_srv Bluetooth Mesh Configuration Server Model
* @brief Configuration Server Model
* @defgroup bt_mesh_cfg_srv Configuration Server Model
* @ingroup bt_mesh
* @{
*/

8
include/bluetooth/mesh/health_cli.h
View file

@ -1,5 +1,5 @@
/** @file
* @brief Bluetooth Mesh Health Client Model APIs.
* @brief Health Client Model APIs.
*/
/*
@ -11,8 +11,8 @@
#define ZEPHYR_INCLUDE_BLUETOOTH_MESH_HEALTH_CLI_H_
/**
* @brief Bluetooth Mesh
* @defgroup bt_mesh_health_cli Bluetooth Mesh Health Client Model
* @brief Health Client Model
* @defgroup bt_mesh_health_cli Health Client Model
* @ingroup bt_mesh
* @{
*/
@ -21,7 +21,7 @@
extern "C" {
#endif
/** Mesh Health Client Model Context */
/** Health Client Model Context */
struct bt_mesh_health_cli {
/** Composition data model entry pointer. */
struct bt_mesh_model *model;

6
include/bluetooth/mesh/health_faults.h
View file

@ -1,5 +1,5 @@
/** @file
* @brief Bluetooth Mesh Health faults
* @brief Health faults
*/
/*
@ -11,8 +11,8 @@
#define ZEPHYR_INCLUDE_BLUETOOTH_MESH_HEALTH_FAULTS_H__
/**
* @brief List of specification defined Health Fault values.
* @defgroup bt_mesh_health_faults Bluetooth Mesh Health Faults
* @brief List of specification defined Health fault values.
* @defgroup bt_mesh_health_faults Health faults
* @ingroup bt_mesh
* @{
*/

6
include/bluetooth/mesh/health_srv.h
View file

@ -1,5 +1,5 @@
/** @file
* @brief Bluetooth Mesh Health Server Model APIs.
* @brief Health Server Model APIs.
*/
/*
@ -11,8 +11,8 @@
#define ZEPHYR_INCLUDE_BLUETOOTH_MESH_HEALTH_SRV_H_
/**
* @brief Bluetooth Mesh Health Server Model
* @defgroup bt_mesh_health_srv Bluetooth Mesh Health Server Model
* @brief Health Server Model
* @defgroup bt_mesh_health_srv Health Server Model
* @ingroup bt_mesh
* @{
*/

6
include/bluetooth/mesh/heartbeat.h
View file

@ -1,5 +1,5 @@
/** @file
* @brief Bluetooth Mesh Heartbeat API.
* @brief Heartbeat APIs.
*/
/*
@ -13,8 +13,8 @@
#include <sys/slist.h>
/**
* @brief Bluetooth Mesh
* @defgroup bt_mesh_heartbeat Bluetooth Mesh Heartbeat
* @brief Heartbeat
* @defgroup bt_mesh_heartbeat Heartbeat
* @ingroup bt_mesh
* @{
*/

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

@ -1,5 +1,5 @@
/** @file
* @brief Bluetooth Mesh Profile APIs.
* @brief Bluetooth mesh Profile APIs.
*/
/*
@ -11,8 +11,8 @@
#define ZEPHYR_INCLUDE_BLUETOOTH_MESH_MAIN_H_
/**
* @brief Bluetooth Mesh Provisioning
* @defgroup bt_mesh_prov Bluetooth Mesh Provisioning
* @brief Provisioning
* @defgroup bt_mesh_prov Provisioning
* @ingroup bt_mesh
* @{
*/
@ -440,8 +440,8 @@ bool bt_mesh_is_provisioned(void);
*/
/**
* @brief Bluetooth Mesh
* @defgroup bt_mesh Bluetooth Mesh
* @brief Bluetooth mesh
* @defgroup bt_mesh Bluetooth mesh
* @ingroup bluetooth
* @{
*/

6
include/bluetooth/mesh/msg.h
View file

@ -1,5 +1,5 @@
/** @file
* @brief Bluetooth Mesh Message APIs.
* @brief Message APIs.
*/
/*
@ -11,8 +11,8 @@
#define ZEPHYR_INCLUDE_BLUETOOTH_MESH_MSG_H_
/**
* @brief Bluetooth Mesh Message API
* @defgroup bt_mesh_msg Bluetooth Mesh Message API
* @brief Message
* @defgroup bt_mesh_msg Message
* @ingroup bt_mesh
* @{
*/

6
include/bluetooth/mesh/proxy.h
View file

@ -1,5 +1,5 @@
/** @file
* @brief Bluetooth Mesh Proxy APIs.
* @brief Proxy APIs.
*/
/*
@ -11,8 +11,8 @@
#define ZEPHYR_INCLUDE_BLUETOOTH_MESH_PROXY_H_
/**
* @brief Bluetooth Mesh Proxy
* @defgroup bt_mesh_proxy Bluetooth Mesh Proxy
* @brief Proxy
* @defgroup bt_mesh_proxy Proxy
* @ingroup bt_mesh
* @{
*/