Add API warning in USB subsystem.

git-svn-id: https://src.develer.com/svnoss/bertos/trunk@4448 38d2e660-2303-0410-9eaa-f027e97ec537

diff --git a/bertos/drv/usb.h b/bertos/drv/usb.h
index 23b14973af96ce9d6dfd7c52aa60013be6b5173c..4016864f0e9966f83d6ca5d36c428e76ce4bffd4 100644 (file)
--- a/bertos/drv/usb.h
+++ b/bertos/drv/usb.h
@@ -37,6 +37,8 @@
  * This file holds USB constants and structures that are needed for USB device
  * APIs, as defined in the USB 2.0 specification.
  *
+ * \attention The API is work in progress and may change in future versions.
+ *
  * $WIZ$ module_name = "usb"
  * $WIZ$ module_configuration = "bertos/cfg/cfg_usb.h"
  * $WIZ$ module_supports = "stm32"

diff --git a/bertos/drv/usbkbd.h b/bertos/drv/usbkbd.h
index 1b4cd3e1a600b159561ea4f3f55f269cf099fa2c..ad3f03da204b65eb6e040f70605adf91e36b5070 100644 (file)
--- a/bertos/drv/usbkbd.h
+++ b/bertos/drv/usbkbd.h
@@ -34,6 +34,10 @@
  *
  * \brief Generic USB keyboard device driver.
  *
+ * This module allows to create virtual keyboards.
+ *
+ * \attention The API is work in progress and may change in future versions.
+ *
  * $WIZ$ module_name = "usbkbd"
  * $WIZ$ module_configuration = "bertos/cfg/cfg_usbkbd.h"
  * $WIZ$ module_depends = "usb"

diff --git a/bertos/drv/usbmouse.h b/bertos/drv/usbmouse.h
index 18eb9499dcc8ce1a155e7a44df96788da145cdcc..49e8aa795c1cb26d8d858cd3fc08c24f7035feb4 100644 (file)
--- a/bertos/drv/usbmouse.h
+++ b/bertos/drv/usbmouse.h
@@ -34,6 +34,8 @@
  *
  * \brief Generic USB mouse device driver.
  *
+ * \attention The API is work in progress and may change in future versions.
+ *
  * $WIZ$ module_name = "usbmouse"
  * $WIZ$ module_configuration = "bertos/cfg/cfg_usbmouse.h"
  * $WIZ$ module_depends = "usb"

diff --git a/bertos/drv/usbser.h b/bertos/drv/usbser.h
index bd65a11b09f793263689bf76190aa730c0a00183..561f33d52eada6948c21c6dfb8a095f54da138fe 100644 (file)
--- a/bertos/drv/usbser.h
+++ b/bertos/drv/usbser.h
@@ -34,6 +34,10 @@
  *
  * \brief Generic USB serial device driver.
  *
+ * This driver exports a USB-serial converter. It provides a KFile interface
+ * to access the data.
+ * \attention The API is work in progress and may change in future versions.
+ *
  * $WIZ$ module_name = "usbser"
  * $WIZ$ module_configuration = "bertos/cfg/cfg_usbser.h"
  * $WIZ$ module_depends = "usb"