From 467b9255302dc5055d7189928d7825cd010acdc2 Mon Sep 17 00:00:00 2001 From: Bruno Dilly Date: Wed, 20 Jul 2016 17:08:06 -0300 Subject: [PATCH] docs: mark experimental API Some libs should be considered experimental since we're expecting a few changes in future releases. Signed-off-by: Bruno Dilly --- src/lib/comms/include/sol-bluetooth.h | 1 + src/lib/comms/include/sol-gatt.h | 1 + src/lib/comms/include/sol-lwm2m.h | 2 ++ src/lib/comms/include/sol-mavlink.h | 2 ++ src/lib/comms/include/sol-netctl.h | 2 ++ 5 files changed, 8 insertions(+) diff --git a/src/lib/comms/include/sol-bluetooth.h b/src/lib/comms/include/sol-bluetooth.h index ee675fb83..efbae2723 100644 --- a/src/lib/comms/include/sol-bluetooth.h +++ b/src/lib/comms/include/sol-bluetooth.h @@ -44,6 +44,7 @@ extern "C" { * * @brief API to handle Bluetooth technology communications. * + * @warning Experimental API. Changes are expected in future releases. * * @{ */ diff --git a/src/lib/comms/include/sol-gatt.h b/src/lib/comms/include/sol-gatt.h index 0268e1d7e..e8acb4d3b 100644 --- a/src/lib/comms/include/sol-gatt.h +++ b/src/lib/comms/include/sol-gatt.h @@ -42,6 +42,7 @@ extern "C" { * * @brief API to handle the GATT protocol. * + * @warning Experimental API. Changes are expected in future releases. * * @{ */ diff --git a/src/lib/comms/include/sol-lwm2m.h b/src/lib/comms/include/sol-lwm2m.h index f585fc25d..bf696b061 100644 --- a/src/lib/comms/include/sol-lwm2m.h +++ b/src/lib/comms/include/sol-lwm2m.h @@ -58,6 +58,8 @@ extern "C" { * - Data encryption. * - Access rights. * + * @warning Experimental API. Changes are expected in future releases. + * * @{ */ diff --git a/src/lib/comms/include/sol-mavlink.h b/src/lib/comms/include/sol-mavlink.h index 933a7b96a..e136071c8 100644 --- a/src/lib/comms/include/sol-mavlink.h +++ b/src/lib/comms/include/sol-mavlink.h @@ -37,6 +37,8 @@ extern "C" { * small unmanned vehicles. It is designed as a header-only message marshaling * library. * + * @warning Experimental API. Changes are expected in future releases. + * * @{ */ diff --git a/src/lib/comms/include/sol-netctl.h b/src/lib/comms/include/sol-netctl.h index 83f228c98..b0c66b9b4 100644 --- a/src/lib/comms/include/sol-netctl.h +++ b/src/lib/comms/include/sol-netctl.h @@ -40,6 +40,8 @@ extern "C" { * * API that should be used to manage device connections. * + * @warning Experimental API. Changes are expected in future releases. + * * @{ */