From 933e092273b03ff625e037ff37b68f8ebea9aa79 Mon Sep 17 00:00:00 2001
From: lottaviano <lottaviano@38d2e660-2303-0410-9eaa-f027e97ec537>
Date: Fri, 22 Oct 2010 13:12:03 +0000
Subject: [PATCH] Add API warning in USB subsystem.

git-svn-id: https://src.develer.com/svnoss/bertos/trunk@4448 38d2e660-2303-0410-9eaa-f027e97ec537
---
 bertos/drv/usb.h      | 2 ++
 bertos/drv/usbkbd.h   | 4 ++++
 bertos/drv/usbmouse.h | 2 ++
 bertos/drv/usbser.h   | 4 ++++
 4 files changed, 12 insertions(+)

diff --git a/bertos/drv/usb.h b/bertos/drv/usb.h
index 23b14973..4016864f 100644
--- 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 1b4cd3e1..ad3f03da 100644
--- 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 18eb9499..49e8aa79 100644
--- 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 bd65a11b..561f33d5 100644
--- 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"
-- 
2.25.1