Minor documentation improvements.
authorDean Camera <dean@fourwalledcubicle.com>
Wed, 1 Feb 2012 21:28:25 +0000 (21:28 +0000)
committerDean Camera <dean@fourwalledcubicle.com>
Wed, 1 Feb 2012 21:28:25 +0000 (21:28 +0000)
20 files changed:
Bootloaders/DFU/BootloaderDFU.h
Demos/Device/ClassDriver/RNDISEthernet/Lib/ICMP.h
Demos/Device/LowLevel/RNDISEthernet/Lib/ICMP.h
Demos/Host/Incomplete/BluetoothHost/Lib/BluetoothACLPackets.c
Demos/Host/Incomplete/BluetoothHost/Lib/BluetoothACLPackets.h
Demos/Host/Incomplete/BluetoothHost/Lib/BluetoothStack.h
Demos/Host/Incomplete/BluetoothHost/Lib/SDP.h
LUFA/Drivers/USB/Class/Common/HIDClassCommon.h
LUFA/Drivers/USB/Class/Common/HIDParser.h
LUFA/Drivers/USB/Class/Device/CDCClassDevice.h
LUFA/Drivers/USB/Class/Host/CDCClassHost.h
LUFA/Drivers/USB/Core/AVR8/Host_AVR8.c
LUFA/Drivers/USB/Core/HostStandardReq.h
LUFA/Drivers/USB/Core/StdDescriptors.h
LUFA/Drivers/USB/Core/StdRequestType.h
LUFA/Drivers/USB/Core/UC3/Host_UC3.c
LUFA/Drivers/USB/USB.h
Projects/AVRISP-MKII/Lib/ISP/ISPTarget.c
Projects/AVRISP-MKII/Lib/V2ProtocolParams.c
Projects/MissileLauncher/MissileLauncher.c

index 2c10a11..5e1f19e 100644 (file)
                /** Type define for a structure containing a complete DFU command issued by the host. */
                typedef struct
                {
                /** Type define for a structure containing a complete DFU command issued by the host. */
                typedef struct
                {
-                       uint8_t  Command; /**< Single byte command to perform, one of the COMMAND_* macro values */
+                       uint8_t  Command; /**< Single byte command to perform, one of the \c COMMAND_* macro values */
                        uint8_t  Data[5]; /**< Command parameters */
                        uint16_t DataSize; /**< Size of the command parameters */
                } DFU_Command_t;
                        uint8_t  Data[5]; /**< Command parameters */
                        uint16_t DataSize; /**< Size of the command parameters */
                } DFU_Command_t;
index 54e2194..cf755f7 100644 (file)
@@ -67,7 +67,7 @@
                /** Type define for an ICMP message header. */
                typedef struct
                {
                /** Type define for an ICMP message header. */
                typedef struct
                {
-                       uint8_t       Type; /**< ICMP message type, a ICMP_TYPE_* constant */
+                       uint8_t       Type; /**< ICMP message type, an \c ICMP_TYPE_* constant */
                        uint8_t       Code; /**< ICMP message code, indicating the message value */
                        uint16_t      Checksum; /**< Ethernet checksum of the ICMP message */
                        uint16_t      Id; /**< Id of the ICMP message */
                        uint8_t       Code; /**< ICMP message code, indicating the message value */
                        uint16_t      Checksum; /**< Ethernet checksum of the ICMP message */
                        uint16_t      Id; /**< Id of the ICMP message */
index c973cf2..161e1c0 100644 (file)
@@ -67,7 +67,7 @@
                /** Type define for an ICMP message header. */
                typedef struct
                {
                /** Type define for an ICMP message header. */
                typedef struct
                {
-                       uint8_t       Type; /**< ICMP message type, a ICMP_TYPE_* constant */
+                       uint8_t       Type; /**< ICMP message type, an \c ICMP_TYPE_* constant */
                        uint8_t       Code; /**< ICMP message code, indicating the message value */
                        uint16_t      Checksum; /**< Ethernet checksum of the ICMP message */
                        uint16_t      Id; /**< Id of the ICMP message */
                        uint8_t       Code; /**< ICMP message code, indicating the message value */
                        uint16_t      Checksum; /**< Ethernet checksum of the ICMP message */
                        uint16_t      Id; /**< Id of the ICMP message */
index ed5db00..e721889 100644 (file)
@@ -207,7 +207,7 @@ static void Bluetooth_ProcessIncomingACLPackets(void)
 /** Retrieves the channel information structure with the given local or remote channel number from the channel list.
  *
  *  \param[in] SearchValue  Value to search for in the channel structure list
 /** Retrieves the channel information structure with the given local or remote channel number from the channel list.
  *
  *  \param[in] SearchValue  Value to search for in the channel structure list
- *  \param[in] SearchKey    Key to search within the channel structure, a CHANNEL_SEARCH_* mask
+ *  \param[in] SearchKey    Key to search within the channel structure, a \c CHANNEL_SEARCH_* mask
  *
  *  \return Pointer to the matching channel information structure in the channel table if found, NULL otherwise
  */
  *
  *  \return Pointer to the matching channel information structure in the channel table if found, NULL otherwise
  */
index 953a5a1..7e5b11f 100644 (file)
                /** Bluetooth signaling command header structure, for all ACL packets containing a signaling command. */
                typedef struct
                {
                /** Bluetooth signaling command header structure, for all ACL packets containing a signaling command. */
                typedef struct
                {
-                       uint8_t  Code; /**< Signal code, a BT_SIGNAL_* mask value */
+                       uint8_t  Code; /**< Signal code, a \c BT_SIGNAL_* mask value */
                        uint8_t  Identifier; /**< Unique signal command identifier to link requests and responses */
                        uint16_t Length; /**< Length of the signaling command data, in bytes */
                } BT_Signal_Header_t;
                        uint8_t  Identifier; /**< Unique signal command identifier to link requests and responses */
                        uint16_t Length; /**< Length of the signaling command data, in bytes */
                } BT_Signal_Header_t;
                /** Connection Request signaling command structure, for channel connection requests. */
                typedef struct
                {
                /** Connection Request signaling command structure, for channel connection requests. */
                typedef struct
                {
-                       uint16_t PSM; /**< Type of data the channel will carry, a CHANNEL_PSM_* mask value */
+                       uint16_t PSM; /**< Type of data the channel will carry, a \c CHANNEL_PSM_* mask value */
                        uint16_t SourceChannel; /**< Channel source on the sending device this channel will link to */
                } BT_Signal_ConnectionReq_t;
 
                        uint16_t SourceChannel; /**< Channel source on the sending device this channel will link to */
                } BT_Signal_ConnectionReq_t;
 
                {
                        uint16_t DestinationChannel; /**< Destination device channel that the connection request was processed on */
                        uint16_t SourceChannel; /**< Source device channel address that the connection request came from */
                {
                        uint16_t DestinationChannel; /**< Destination device channel that the connection request was processed on */
                        uint16_t SourceChannel; /**< Source device channel address that the connection request came from */
-                       uint16_t Result; /**< Connection result, a BT_CONNECTION_* mask value */
+                       uint16_t Result; /**< Connection result, a \c BT_CONNECTION_* mask value */
                        uint16_t Status; /**< Status of the request if the result was set to the Pending value */
                } BT_Signal_ConnectionResp_t;
 
                        uint16_t Status; /**< Status of the request if the result was set to the Pending value */
                } BT_Signal_ConnectionResp_t;
 
                {
                        uint16_t SourceChannel; /**< Source channel that the configuration request was directed at */
                        uint16_t Flags; /**< Configuration flags for the response, including response continuation */
                {
                        uint16_t SourceChannel; /**< Source channel that the configuration request was directed at */
                        uint16_t Flags; /**< Configuration flags for the response, including response continuation */
-                       uint16_t Result; /**< Configuration result, a BT_CONFIGURATION_* mask value */
+                       uint16_t Result; /**< Configuration result, a \c BT_CONFIGURATION_* mask value */
                } BT_Signal_ConfigurationResp_t;
 
                /** Information Request signaling command structure, for device information requests. */
                typedef struct
                {
                } BT_Signal_ConfigurationResp_t;
 
                /** Information Request signaling command structure, for device information requests. */
                typedef struct
                {
-                       uint16_t InfoType; /**< Data type that is being requested, a BT_INFOREQ_* mask value */
+                       uint16_t InfoType; /**< Data type that is being requested, a \c BT_INFOREQ_* mask value */
                } BT_Signal_InformationReq_t;
 
                /** Information Response signaling command structure, for responses to information requests. */
                typedef struct
                {
                } BT_Signal_InformationReq_t;
 
                /** Information Response signaling command structure, for responses to information requests. */
                typedef struct
                {
-                       uint16_t InfoType; /**< Data type that was requested, a BT_INFOREQ_* mask value */
-                       uint16_t Result; /**< Result of the request, a BT_INFORMATION_* mask value */
+                       uint16_t InfoType; /**< Data type that was requested, a \c BT_INFOREQ_* mask value */
+                       uint16_t Result; /**< Result of the request, a \c BT_INFORMATION_* mask value */
                } BT_Signal_InformationResp_t;
 
                /** Configuration Option header structure, placed at the start of each option in a Channel Configuration
                } BT_Signal_InformationResp_t;
 
                /** Configuration Option header structure, placed at the start of each option in a Channel Configuration
                 */
                typedef struct
                {
                 */
                typedef struct
                {
-                       uint8_t Type; /**< Option type, a BT_CONFIG_OPTION_* mask value */
+                       uint8_t Type; /**< Option type, a \c BT_CONFIG_OPTION_* mask value */
                        uint8_t Length; /**< Length of the option's value, in bytes */
                } BT_Config_Option_Header_t;
 
                        uint8_t Length; /**< Length of the option's value, in bytes */
                } BT_Config_Option_Header_t;
 
index 8e515a5..ed7a7a7 100644 (file)
                /** Local Bluetooth device information structure, for the defining of local device characteristics for the Bluetooth stack. */
                typedef struct
                {
                /** Local Bluetooth device information structure, for the defining of local device characteristics for the Bluetooth stack. */
                typedef struct
                {
-                       uint32_t Class; /**< Class of the local device, a mask of DEVICE_CLASS_* masks. */
+                       uint32_t Class; /**< Class of the local device, a mask of \c DEVICE_CLASS_* masks. */
                        char     PINCode[16]; /**< Pin code required to send or receive in order to authenticate with a remote device. */
                        char     Name[]; /**< Name of the local Bluetooth device, up to 248 characters. */
                } Bluetooth_Device_t;
                        char     PINCode[16]; /**< Pin code required to send or receive in order to authenticate with a remote device. */
                        char     Name[]; /**< Name of the local Bluetooth device, up to 248 characters. */
                } Bluetooth_Device_t;
index 695aac7..d9ab871 100644 (file)
@@ -99,7 +99,7 @@
                 */
                typedef struct
                {
                 */
                typedef struct
                {
-                       uint8_t  PDU; /**< SDP packet type, a SDP_PDU_* mask value */
+                       uint8_t  PDU; /**< SDP packet type, a \c SDP_PDU_* mask value */
                        uint16_t TransactionID; /**< Unique transaction ID number to associate requests and responses */
                        uint16_t ParameterLength; /**< Length of the data following the SDP header */
                } SDP_PDUHeader_t;
                        uint16_t TransactionID; /**< Unique transaction ID number to associate requests and responses */
                        uint16_t ParameterLength; /**< Length of the data following the SDP header */
                } SDP_PDUHeader_t;
index 6e5187b..ff75e7c 100644 (file)
                 *  \code
                 *  struct
                 *  {
                 *  \code
                 *  struct
                 *  {
-                *      uint8_t Modifier; // Keyboard modifier byte indicating pressed modifier keys (HID_KEYBOARD_MODIFER_* masks)
+                *      uint8_t Modifier; // Keyboard modifier byte indicating pressed modifier keys (\c HID_KEYBOARD_MODIFER_* masks)
                 *      uint8_t Reserved; // Reserved for OEM use, always set to 0.
                 *      uint8_t KeyCode[MaxKeys]; // Length determined by the number of keys that can be reported
                 *  } Keyboard_Report;
                 *      uint8_t Reserved; // Reserved for OEM use, always set to 0.
                 *      uint8_t KeyCode[MaxKeys]; // Length determined by the number of keys that can be reported
                 *  } Keyboard_Report;
index 25e201b..2d6d70c 100644 (file)
                        {
                                uint16_t                    BitOffset;      /**< Bit offset in the IN, OUT or FEATURE report of the item. */
                                uint8_t                     ItemType;       /**< Report item type, a value in \ref HID_ReportItemTypes_t. */
                        {
                                uint16_t                    BitOffset;      /**< Bit offset in the IN, OUT or FEATURE report of the item. */
                                uint8_t                     ItemType;       /**< Report item type, a value in \ref HID_ReportItemTypes_t. */
-                               uint16_t                    ItemFlags;      /**< Item data flags, a mask of HID_IOF_* constants. */
+                               uint16_t                    ItemFlags;      /**< Item data flags, a mask of \c HID_IOF_* constants. */
                                uint8_t                     ReportID;       /**< Report ID this item belongs to, or 0x00 if device has only one report */
                                HID_CollectionPath_t*       CollectionPath; /**< Collection path of the item. */
 
                                uint8_t                     ReportID;       /**< Report ID this item belongs to, or 0x00 if device has only one report */
                                HID_CollectionPath_t*       CollectionPath; /**< Collection path of the item. */
 
index a172e4a..d621d0a 100644 (file)
                        /** CDC class driver event for a control line state change on a CDC interface. This event fires each time the host requests a
                         *  control line state change (containing the virtual serial control line states, such as DTR) and may be hooked in the
                         *  user program by declaring a handler function with the same name and parameters listed here. The new control line states
                        /** CDC class driver event for a control line state change on a CDC interface. This event fires each time the host requests a
                         *  control line state change (containing the virtual serial control line states, such as DTR) and may be hooked in the
                         *  user program by declaring a handler function with the same name and parameters listed here. The new control line states
-                        *  are available in the State.ControlLineStates.HostToDevice value inside the CDC interface structure passed as a parameter, set as
-                        *  a mask of CDC_CONTROL_LINE_OUT_* masks.
+                        *  are available in the \c ControlLineStates.HostToDevice value inside the CDC interface structure passed as a parameter, set as
+                        *  a mask of \c CDC_CONTROL_LINE_OUT_* masks.
                         *
                         *  \param[in,out] CDCInterfaceInfo  Pointer to a structure containing a CDC Class configuration and state.
                         */
                         *
                         *  \param[in,out] CDCInterfaceInfo  Pointer to a structure containing a CDC Class configuration and state.
                         */
                        /** Sends a Serial Control Line State Change notification to the host. This should be called when the virtual serial
                         *  control lines (DCD, DSR, etc.) have changed states, or to give BREAK notifications to the host. Line states persist
                         *  until they are cleared via a second notification. This should be called each time the CDC class driver's
                        /** Sends a Serial Control Line State Change notification to the host. This should be called when the virtual serial
                         *  control lines (DCD, DSR, etc.) have changed states, or to give BREAK notifications to the host. Line states persist
                         *  until they are cleared via a second notification. This should be called each time the CDC class driver's
-                        *  ControlLineStates.DeviceToHost value is updated to push the new states to the USB host.
+                        *  \c ControlLineStates.DeviceToHost value is updated to push the new states to the USB host.
                         *
                         *  \pre This function must only be called when the Device state machine is in the \ref DEVICE_STATE_Configured state or
                         *       the call will fail.
                         *
                         *  \pre This function must only be called when the Device state machine is in the \ref DEVICE_STATE_Configured state or
                         *       the call will fail.
                        void CDC_Device_SendControlLineStateChange(USB_ClassInfo_CDC_Device_t* const CDCInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1);
 
                        /** Creates a standard character stream for the given CDC Device instance so that it can be used with all the regular
                        void CDC_Device_SendControlLineStateChange(USB_ClassInfo_CDC_Device_t* const CDCInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1);
 
                        /** Creates a standard character stream for the given CDC Device instance so that it can be used with all the regular
-                        *  functions in the standard <stdio.h> library that accept a \c FILE stream as a destination (e.g. \c fprintf). The created
+                        *  functions in the standard <stdio.h> library that accept a \c FILE stream as a destination (e.g. \c fprintf()). The created
                         *  stream is bidirectional and can be used for both input and output functions.
                         *
                         *  Reading data from this stream is non-blocking, i.e. in most instances, complete strings cannot be read in by a single
                         *  stream is bidirectional and can be used for both input and output functions.
                         *
                         *  Reading data from this stream is non-blocking, i.e. in most instances, complete strings cannot be read in by a single
index 3ab0192..272baa2 100644 (file)
                        /** CDC class driver event for a control line state change on a CDC host interface. This event fires each time the device notifies
                         *  the host of a control line state change (containing the virtual serial control line states, such as DCD) and may be hooked in the
                         *  user program by declaring a handler function with the same name and parameters listed here. The new control line states
                        /** CDC class driver event for a control line state change on a CDC host interface. This event fires each time the device notifies
                         *  the host of a control line state change (containing the virtual serial control line states, such as DCD) and may be hooked in the
                         *  user program by declaring a handler function with the same name and parameters listed here. The new control line states
-                        *  are available in the ControlLineStates.DeviceToHost value inside the CDC host interface structure passed as a parameter, set as
+                        *  are available in the \c ControlLineStates.DeviceToHost value inside the CDC host interface structure passed as a parameter, set as
                         *  a mask of \c CDC_CONTROL_LINE_IN_* masks.
                         *
                         *  \param[in,out] CDCInterfaceInfo  Pointer to a structure containing a CDC Class host configuration and state.
                         *  a mask of \c CDC_CONTROL_LINE_IN_* masks.
                         *
                         *  \param[in,out] CDCInterfaceInfo  Pointer to a structure containing a CDC Class host configuration and state.
index dde5b1b..8aa14c2 100644 (file)
@@ -219,7 +219,7 @@ uint8_t USB_Host_WaitMS(uint8_t MS)
                        break;
                }
 
                        break;
                }
 
-               if (Pipe_IsError() == true)
+               if (Pipe_IsError())
                {
                        Pipe_ClearError();
                        ErrorCode = HOST_WAITERROR_PipeError;
                {
                        Pipe_ClearError();
                        ErrorCode = HOST_WAITERROR_PipeError;
@@ -227,7 +227,7 @@ uint8_t USB_Host_WaitMS(uint8_t MS)
                        break;
                }
 
                        break;
                }
 
-               if (Pipe_IsStalled() == true)
+               if (Pipe_IsStalled())
                {
                        Pipe_ClearStall();
                        ErrorCode = HOST_WAITERROR_SetupStalled;
                {
                        Pipe_ClearStall();
                        ErrorCode = HOST_WAITERROR_SetupStalled;
index d076a8a..44994c5 100644 (file)
 
                        /** Retrieves the current feature status of the attached device, via a GET STATUS standard request. The
                         *  retrieved feature status can then be examined by masking the retrieved value with the various
 
                        /** Retrieves the current feature status of the attached device, via a GET STATUS standard request. The
                         *  retrieved feature status can then be examined by masking the retrieved value with the various
-                        *  FEATURE_* masks for bus/self power information and remote wakeup support.
+                        *  \c FEATURE_* masks for bus/self power information and remote wakeup support.
                         *
                         *  \note After this routine returns, the control pipe will be selected.
                         *
                         *
                         *  \note After this routine returns, the control pipe will be selected.
                         *
index 8b91977..888201b 100644 (file)
                                uint8_t  ConfigurationNumber; /**< Configuration index of the current configuration. */
                                uint8_t  ConfigurationStrIndex; /**< Index of a string descriptor describing the configuration. */
 
                                uint8_t  ConfigurationNumber; /**< Configuration index of the current configuration. */
                                uint8_t  ConfigurationStrIndex; /**< Index of a string descriptor describing the configuration. */
 
-                               uint8_t  ConfigAttributes; /**< Configuration attributes, comprised of a mask of zero or
-                                                           *   more USB_CONFIG_ATTR_* masks.
+                               uint8_t  ConfigAttributes; /**< Configuration attributes, comprised of a mask of \c USB_CONFIG_ATTR_* masks.
+                                                           *   On all devices, this should include USB_CONFIG_ATTR_RESERVED at a minimum.
                                                            */
 
                                uint8_t  MaxPowerConsumption; /**< Maximum power consumption of the device while in the
                                                            */
 
                                uint8_t  MaxPowerConsumption; /**< Maximum power consumption of the device while in the
                                uint8_t  bNumInterfaces; /**< Total number of interfaces in the configuration. */
                                uint8_t  bConfigurationValue; /**< Configuration index of the current configuration. */
                                uint8_t  iConfiguration; /**< Index of a string descriptor describing the configuration. */
                                uint8_t  bNumInterfaces; /**< Total number of interfaces in the configuration. */
                                uint8_t  bConfigurationValue; /**< Configuration index of the current configuration. */
                                uint8_t  iConfiguration; /**< Index of a string descriptor describing the configuration. */
-                               uint8_t  bmAttributes; /**< Configuration attributes, comprised of a mask of zero or
-                                                       *   more USB_CONFIG_ATTR_* masks.
+                               uint8_t  bmAttributes; /**< Configuration attributes, comprised of a mask of \c USB_CONFIG_ATTR_* masks.
+                                                       *   On all devices, this should include USB_CONFIG_ATTR_RESERVED at a minimum.
                                                        */
                                uint8_t  bMaxPower; /**< Maximum power consumption of the device while in the
                                                     *   current configuration, calculated by the \ref USB_CONFIG_POWER_MA()
                                                        */
                                uint8_t  bMaxPower; /**< Maximum power consumption of the device while in the
                                                     *   current configuration, calculated by the \ref USB_CONFIG_POWER_MA()
index 47d6ae1..fdca204 100644 (file)
                        /** Mask for the request type parameter, to indicate the direction of the request data (Host to Device
                         *  or Device to Host). The result of this mask should then be compared to the request direction masks.
                         *
                        /** Mask for the request type parameter, to indicate the direction of the request data (Host to Device
                         *  or Device to Host). The result of this mask should then be compared to the request direction masks.
                         *
-                        *  \see REQDIR_* macros for masks indicating the request data direction.
+                        *  \see \c REQDIR_* macros for masks indicating the request data direction.
                         */
                        #define CONTROL_REQTYPE_DIRECTION  0x80
 
                        /** Mask for the request type parameter, to indicate the type of request (Device, Class or Vendor
                         *  Specific). The result of this mask should then be compared to the request type masks.
                         *
                         */
                        #define CONTROL_REQTYPE_DIRECTION  0x80
 
                        /** Mask for the request type parameter, to indicate the type of request (Device, Class or Vendor
                         *  Specific). The result of this mask should then be compared to the request type masks.
                         *
-                        *  \see REQTYPE_* macros for masks indicating the request type.
+                        *  \see \c REQTYPE_* macros for masks indicating the request type.
                         */
                        #define CONTROL_REQTYPE_TYPE       0x60
 
                         */
                        #define CONTROL_REQTYPE_TYPE       0x60
 
@@ -83,7 +83,7 @@
                         *  Endpoint or Other). The result of this mask should then be compared to the request recipient
                         *  masks.
                         *
                         *  Endpoint or Other). The result of this mask should then be compared to the request recipient
                         *  masks.
                         *
-                        *  \see REQREC_* macros for masks indicating the request recipient.
+                        *  \see \c REQREC_* macros for masks indicating the request recipient.
                         */
                        #define CONTROL_REQTYPE_RECIPIENT  0x1F
 
                         */
                        #define CONTROL_REQTYPE_RECIPIENT  0x1F
 
index dde5b1b..8aa14c2 100644 (file)
@@ -219,7 +219,7 @@ uint8_t USB_Host_WaitMS(uint8_t MS)
                        break;
                }
 
                        break;
                }
 
-               if (Pipe_IsError() == true)
+               if (Pipe_IsError())
                {
                        Pipe_ClearError();
                        ErrorCode = HOST_WAITERROR_PipeError;
                {
                        Pipe_ClearError();
                        ErrorCode = HOST_WAITERROR_PipeError;
@@ -227,7 +227,7 @@ uint8_t USB_Host_WaitMS(uint8_t MS)
                        break;
                }
 
                        break;
                }
 
-               if (Pipe_IsStalled() == true)
+               if (Pipe_IsStalled())
                {
                        Pipe_ClearStall();
                        ErrorCode = HOST_WAITERROR_SetupStalled;
                {
                        Pipe_ClearStall();
                        ErrorCode = HOST_WAITERROR_SetupStalled;
index b633336..fa49556 100644 (file)
  *   <td bgcolor="#00EE00">Yes</td>
  *  </tr>
  *  <tr>
  *   <td bgcolor="#00EE00">Yes</td>
  *  </tr>
  *  <tr>
- *   <td>Audio</td>
+ *   <td>Audio 1.0</td>
  *   <td bgcolor="#00EE00">Yes</td>
  *   <td bgcolor="#00EE00">Yes</td>
  *  </tr>
  *  <tr>
  *   <td bgcolor="#00EE00">Yes</td>
  *   <td bgcolor="#00EE00">Yes</td>
  *  </tr>
  *  <tr>
- *   <td>CDC</td>
+ *   <td>CDC-ACM</td>
  *   <td bgcolor="#00EE00">Yes</td>
  *   <td bgcolor="#00EE00">Yes</td>
  *  </tr>
  *   <td bgcolor="#00EE00">Yes</td>
  *   <td bgcolor="#00EE00">Yes</td>
  *  </tr>
index 157dd0b..134120d 100644 (file)
@@ -313,7 +313,7 @@ void ISPTarget_LoadExtendedAddress(void)
 /** Waits until the last issued target memory programming command has completed, via the check mode given and using
  *  the given parameters.
  *
 /** Waits until the last issued target memory programming command has completed, via the check mode given and using
  *  the given parameters.
  *
- *  \param[in] ProgrammingMode  Programming mode used and completion check to use, a mask of PROG_MODE_* constants
+ *  \param[in] ProgrammingMode  Programming mode used and completion check to use, a mask of \c PROG_MODE_* constants
  *  \param[in] PollAddress      Memory address to poll for completion if polling check mode used
  *  \param[in] PollValue        Poll value to check against if polling check mode used
  *  \param[in] DelayMS          Milliseconds to delay before returning if delay check mode used
  *  \param[in] PollAddress      Memory address to poll for completion if polling check mode used
  *  \param[in] PollValue        Poll value to check against if polling check mode used
  *  \param[in] DelayMS          Milliseconds to delay before returning if delay check mode used
index 5028dad..097e0fe 100644 (file)
@@ -108,7 +108,7 @@ void V2Params_UpdateParamValues(void)
  *
  *  \param[in] ParamID  Parameter ID whose privileges are to be retrieved from the table
  *
  *
  *  \param[in] ParamID  Parameter ID whose privileges are to be retrieved from the table
  *
- *  \return Privileges for the requested parameter, as a mask of PARAM_PRIV_* masks
+ *  \return Privileges for the requested parameter, as a mask of \c PARAM_PRIV_* masks
  */
 uint8_t V2Params_GetParameterPrivileges(const uint8_t ParamID)
 {
  */
 uint8_t V2Params_GetParameterPrivileges(const uint8_t ParamID)
 {
index f215cd3..051fca9 100644 (file)
@@ -158,7 +158,7 @@ void Send_Command_Report(const uint8_t* const Report,
        WriteNextReport(CmdBuffer, ReportSize);
 }
 
        WriteNextReport(CmdBuffer, ReportSize);
 }
 
-/** Sends one of the CMD_* command constants to the attached device.
+/** Sends one of the \c CMD_* command constants to the attached device.
  *
  *  \param[in] Command  One of the command constants.
  */
  *
  *  \param[in] Command  One of the command constants.
  */