Add briefs for the library core structures.
[pub/USBasp.git] / LUFA / Drivers / USB / Class / Common / MassStorage.h
index 7f32135..b5e590e 100644 (file)
@@ -31,6 +31,8 @@
 /** \file\r
  *  \brief Common definitions and declarations for the library USB Mass Storage Class driver.\r
  *\r
+ *  Common definitions and declarations for the library USB Mass Storage Class driver.\r
+ *\r
  *  \note This file should not be included directly. It is automatically included as needed by the class driver\r
  *        dispatch header located in LUFA/Drivers/USB/Class/MassStorage.h.\r
  */\r
                #define SCSI_ASENSEQ_OPERATION_IN_PROGRESS             0x07\r
                \r
        /* Type defines: */\r
-               /** Type define for a Command Block Wrapper, used in the Mass Storage Bulk-Only Transport protocol. */\r
+               /** \brief Mass Storage Class Command Block Wrapper.\r
+                *\r
+                *  Type define for a Command Block Wrapper, used in the Mass Storage Bulk-Only Transport protocol. */\r
                typedef struct\r
                {\r
                        uint32_t Signature; /**< Command block signature, must be CBW_SIGNATURE to indicate a valid Command Block */\r
                        uint8_t  SCSICommandData[16]; /**< Issued SCSI command in the Command Block */\r
                } MS_CommandBlockWrapper_t;\r
                \r
-               /** Type define for a Command Status Wrapper, used in the Mass Storage Bulk-Only Transport protocol. */\r
+               /** \brief Mass Storage Class Command Status Wrapper.\r
+                *\r
+                *  Type define for a Command Status Wrapper, used in the Mass Storage Bulk-Only Transport protocol.\r
+                */\r
                typedef struct\r
                {\r
                        uint32_t Signature; /**< Status block signature, must be CSW_SIGNATURE to indicate a valid Command Status */\r
                        uint8_t  Status; /**< Status code of the issued command - a value from the MassStorage_CommandStatusCodes_t enum */\r
                } MS_CommandStatusWrapper_t;\r
                \r
-               /** Type define for a SCSI Sense structure. Structures of this type are filled out by the\r
+               /** \brief Mass Storage Class SCSI Sense Structure\r
+                *  \r
+                *  Type define for a SCSI Sense structure. Structures of this type are filled out by the\r
                 *  device via the MassStore_RequestSense() function, indicating the current sense data of the\r
                 *  device (giving explicit error codes for the last issued command). For details of the\r
                 *  structure contents, refer to the SCSI specifications.\r
                        uint8_t      SenseKeySpecific[3];\r
                } SCSI_Request_Sense_Response_t;\r
 \r
-               /** Type define for a SCSI Inquiry structure. Structures of this type are filled out by the\r
+               /** \brief Mass Storage Class SCSI Inquiry Structure.\r
+                *\r
+                *  Type define for a SCSI Inquiry structure. Structures of this type are filled out by the\r
                 *  device via the MassStore_Inquiry() function, retrieving the attached device's information.\r
                 *  For details of the structure contents, refer to the SCSI specifications.\r
                 */\r