Changeset 3b77628 in mainline for uspace/drv

Timestamp:

2011-01-24T11:58:24Z (15 years ago)

Author:

Vojtech Horky <vojtechhorky@…>

Branches:

lfn, master, serial, ticket/834-toolchain-update, topic/msim-upgrade, topic/simplify-dev-export

Children:

afc4fbb

Parents:

0cfc68f0

Message:

Doxygen comment fixes

Mainly proper subgrouping and some missing @param comments.

Location:

uspace/drv

Files:

• usbhub/usbhub.c (modified) (1 diff)
• usbhub/usblist.c (modified) (1 diff)
• usbhub/usblist.h (modified) (3 diffs)
• usbhub/utils.c (modified) (1 diff)
• vhc/devices.c (modified) (2 diffs)

uspace/drv/usbhub/usbhub.c

@@ -26 +26 @@
  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  */
-/** @addtogroup usb hub driver
+/** @addtogroup usbhub
  * @{
  */

uspace/drv/usbhub/usblist.c

@@ -26 +26 @@
  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  */
-/** @addtogroup usb hub driver
+/** @addtogroup usbhub
  * @{
  */

uspace/drv/usbhub/usblist.h

@@ -27 +27 @@
  */
 
-
-#ifndef USBLIST_H
-#define USBLIST_H
-/** @addtogroup usb hub driver
+/** @addtogroup usbhub
  * @{
  */
@@ -40 +37 @@
  * much simpler and more straight-forward semantics.
  */
+#ifndef USBLIST_H
+#define USBLIST_H
 
 /**
@@ -78 +77 @@
 }
 
-
+#endif  /* USBLIST_H */
 /**
  * @}
  */
-
-
-
-#endif  /* USBLIST_H */
-

uspace/drv/usbhub/utils.c

@@ -27 +27 @@
  */
 
-/** @addtogroup libusb usb
+/** @addtogroup usbhub
  * @{
  */

uspace/drv/vhc/devices.c

@@ -58 +58 @@
 /** Create virtual device.
  *
- * @param address USB address.
  * @param phone Callback phone.
  * @return New device.
- * @retval NULL Out of memory or address already occupied.
+ * @retval NULL Out of memory.
  */
 virtdev_connection_t *virtdev_add_device(int phone)
@@ -67 +66 @@
         virtdev_connection_t *dev = (virtdev_connection_t *)
             malloc(sizeof(virtdev_connection_t));
+        if (dev == NULL) {
+                return NULL;
+        }
+
         dev->phone = phone;
         list_append(&dev->link, &devices);