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 <[email protected]>
solettaproject · Jul 20, 2016 · 467b925 · 467b925
1 parent 7daedfe
commit 467b925
Show file tree

Hide file tree

Showing 5 changed files with 8 additions and 0 deletions.
diff --git 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
@@ -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
@@ -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
@@ -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
@@ -40,6 +40,8 @@ extern "C" {
  *
  * API that should be used to manage device connections.
  *
+ * @warning Experimental API. Changes are expected in future releases.
+ *
  * @{
  */
-Original file line number
+Diff line change
@@ Expand Up / @@ -44,6 +44,7 @@ extern "C" { @@
      *
      * @brief API to handle Bluetooth technology communications.
      *
+     * @warning Experimental API. Changes are expected in future releases.
      *
      * @{
      */
@@ Expand Down @@