Minor documentation improvements.

20 files changed, 38 insertions, 38 deletions

diff --git a/Bootloaders/DFU/BootloaderDFU.h b/Bootloaders/DFU/BootloaderDFU.h
index 2c10a1162..5e1f19e99 100644
--- a/Bootloaders/DFU/BootloaderDFU.h
+++ b/Bootloaders/DFU/BootloaderDFU.h
@@ -148,7 +148,7 @@
 		/** 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;
diff --git a/Demos/Device/ClassDriver/RNDISEthernet/Lib/ICMP.h b/Demos/Device/ClassDriver/RNDISEthernet/Lib/ICMP.h
index 54e219480..cf755f7d2 100644
--- a/Demos/Device/ClassDriver/RNDISEthernet/Lib/ICMP.h
+++ b/Demos/Device/ClassDriver/RNDISEthernet/Lib/ICMP.h
@@ -67,7 +67,7 @@
 		/** 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 */
diff --git a/Demos/Device/LowLevel/RNDISEthernet/Lib/ICMP.h b/Demos/Device/LowLevel/RNDISEthernet/Lib/ICMP.h
index c973cf2b3..161e1c0d9 100644
--- a/Demos/Device/LowLevel/RNDISEthernet/Lib/ICMP.h
+++ b/Demos/Device/LowLevel/RNDISEthernet/Lib/ICMP.h
@@ -67,7 +67,7 @@
 		/** 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 */
diff --git a/Demos/Host/Incomplete/BluetoothHost/Lib/BluetoothACLPackets.c b/Demos/Host/Incomplete/BluetoothHost/Lib/BluetoothACLPackets.c
index ed5db0005..e721889a7 100644
--- a/Demos/Host/Incomplete/BluetoothHost/Lib/BluetoothACLPackets.c
+++ b/Demos/Host/Incomplete/BluetoothHost/Lib/BluetoothACLPackets.c
@@ -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
- *  \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
  */
diff --git a/Demos/Host/Incomplete/BluetoothHost/Lib/BluetoothACLPackets.h b/Demos/Host/Incomplete/BluetoothHost/Lib/BluetoothACLPackets.h
index 953a5a14a..7e5b11f74 100644
--- a/Demos/Host/Incomplete/BluetoothHost/Lib/BluetoothACLPackets.h
+++ b/Demos/Host/Incomplete/BluetoothHost/Lib/BluetoothACLPackets.h
@@ -108,7 +108,7 @@
 		/** 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;
@@ -116,7 +116,7 @@
 		/** 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;
 
@@ -125,7 +125,7 @@
 		{
 			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;
 
@@ -155,20 +155,20 @@
 		{
 			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
 		{
-			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
 		{
-			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
@@ -176,7 +176,7 @@
 		 */
 		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;
 
diff --git a/Demos/Host/Incomplete/BluetoothHost/Lib/BluetoothStack.h b/Demos/Host/Incomplete/BluetoothHost/Lib/BluetoothStack.h
index 8e515a5d4..ed7a7a738 100644
--- a/Demos/Host/Incomplete/BluetoothHost/Lib/BluetoothStack.h
+++ b/Demos/Host/Incomplete/BluetoothHost/Lib/BluetoothStack.h
@@ -121,7 +121,7 @@
 		/** 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;
diff --git a/Demos/Host/Incomplete/BluetoothHost/Lib/SDP.h b/Demos/Host/Incomplete/BluetoothHost/Lib/SDP.h
index 695aac733..d9ab87177 100644
--- a/Demos/Host/Incomplete/BluetoothHost/Lib/SDP.h
+++ b/Demos/Host/Incomplete/BluetoothHost/Lib/SDP.h
@@ -99,7 +99,7 @@
 		 */
 		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;
diff --git a/LUFA/Drivers/USB/Class/Common/HIDClassCommon.h b/LUFA/Drivers/USB/Class/Common/HIDClassCommon.h
index 6e5187bbf..ff75e7c44 100644
--- a/LUFA/Drivers/USB/Class/Common/HIDClassCommon.h
+++ b/LUFA/Drivers/USB/Class/Common/HIDClassCommon.h
@@ -392,7 +392,7 @@
 		 *  \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;
diff --git a/LUFA/Drivers/USB/Class/Common/HIDParser.h b/LUFA/Drivers/USB/Class/Common/HIDParser.h
index 25e201b36..2d6d70c42 100644
--- a/LUFA/Drivers/USB/Class/Common/HIDParser.h
+++ b/LUFA/Drivers/USB/Class/Common/HIDParser.h
@@ -222,7 +222,7 @@
 			{
 				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. */
 
diff --git a/LUFA/Drivers/USB/Class/Device/CDCClassDevice.h b/LUFA/Drivers/USB/Class/Device/CDCClassDevice.h
index a172e4ac1..d621d0a08 100644
--- a/LUFA/Drivers/USB/Class/Device/CDCClassDevice.h
+++ b/LUFA/Drivers/USB/Class/Device/CDCClassDevice.h
@@ -173,8 +173,8 @@
 			/** 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.
 			 */
@@ -281,7 +281,7 @@
 			/** 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.
@@ -291,7 +291,7 @@
 			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
diff --git a/LUFA/Drivers/USB/Class/Host/CDCClassHost.h b/LUFA/Drivers/USB/Class/Host/CDCClassHost.h
index 3ab01927a..272baa2dc 100644
--- a/LUFA/Drivers/USB/Class/Host/CDCClassHost.h
+++ b/LUFA/Drivers/USB/Class/Host/CDCClassHost.h
@@ -315,7 +315,7 @@
 			/** 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.
diff --git a/LUFA/Drivers/USB/Core/AVR8/Host_AVR8.c b/LUFA/Drivers/USB/Core/AVR8/Host_AVR8.c
index dde5b1b0f..8aa14c244 100644
--- a/LUFA/Drivers/USB/Core/AVR8/Host_AVR8.c
+++ b/LUFA/Drivers/USB/Core/AVR8/Host_AVR8.c
@@ -219,7 +219,7 @@ uint8_t USB_Host_WaitMS(uint8_t MS)
 			break;
 		}
 
-		if (Pipe_IsError() == true)
+		if (Pipe_IsError())
 		{
 			Pipe_ClearError();
 			ErrorCode = HOST_WAITERROR_PipeError;
@@ -227,7 +227,7 @@ uint8_t USB_Host_WaitMS(uint8_t MS)
 			break;
 		}
 
-		if (Pipe_IsStalled() == true)
+		if (Pipe_IsStalled())
 		{
 			Pipe_ClearStall();
 			ErrorCode = HOST_WAITERROR_SetupStalled;
diff --git a/LUFA/Drivers/USB/Core/HostStandardReq.h b/LUFA/Drivers/USB/Core/HostStandardReq.h
index d076a8a66..44994c5c9 100644
--- a/LUFA/Drivers/USB/Core/HostStandardReq.h
+++ b/LUFA/Drivers/USB/Core/HostStandardReq.h
@@ -165,7 +165,7 @@
 
 			/** 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.
 			 *
diff --git a/LUFA/Drivers/USB/Core/StdDescriptors.h b/LUFA/Drivers/USB/Core/StdDescriptors.h
index 8b91977c7..888201b1d 100644
--- a/LUFA/Drivers/USB/Core/StdDescriptors.h
+++ b/LUFA/Drivers/USB/Core/StdDescriptors.h
@@ -431,8 +431,8 @@
 				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
@@ -462,8 +462,8 @@
 				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()
diff --git a/LUFA/Drivers/USB/Core/StdRequestType.h b/LUFA/Drivers/USB/Core/StdRequestType.h
index 47d6ae1d7..fdca2046a 100644
--- a/LUFA/Drivers/USB/Core/StdRequestType.h
+++ b/LUFA/Drivers/USB/Core/StdRequestType.h
@@ -68,14 +68,14 @@
 			/** 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.
 			 *
-			 *  \see REQTYPE_* macros for masks indicating the request type.
+			 *  \see \c REQTYPE_* macros for masks indicating the request type.
 			 */
 			#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.
 			 *
-			 *  \see REQREC_* macros for masks indicating the request recipient.
+			 *  \see \c REQREC_* macros for masks indicating the request recipient.
 			 */
 			#define CONTROL_REQTYPE_RECIPIENT  0x1F
 
diff --git a/LUFA/Drivers/USB/Core/UC3/Host_UC3.c b/LUFA/Drivers/USB/Core/UC3/Host_UC3.c
index dde5b1b0f..8aa14c244 100644
--- a/LUFA/Drivers/USB/Core/UC3/Host_UC3.c
+++ b/LUFA/Drivers/USB/Core/UC3/Host_UC3.c
@@ -219,7 +219,7 @@ uint8_t USB_Host_WaitMS(uint8_t MS)
 			break;
 		}
 
-		if (Pipe_IsError() == true)
+		if (Pipe_IsError())
 		{
 			Pipe_ClearError();
 			ErrorCode = HOST_WAITERROR_PipeError;
@@ -227,7 +227,7 @@ uint8_t USB_Host_WaitMS(uint8_t MS)
 			break;
 		}
 
-		if (Pipe_IsStalled() == true)
+		if (Pipe_IsStalled())
 		{
 			Pipe_ClearStall();
 			ErrorCode = HOST_WAITERROR_SetupStalled;
diff --git a/LUFA/Drivers/USB/USB.h b/LUFA/Drivers/USB/USB.h
index b63333626..fa4955620 100644
--- a/LUFA/Drivers/USB/USB.h
+++ b/LUFA/Drivers/USB/USB.h
@@ -97,12 +97,12 @@
  *   <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>CDC</td>
+ *   <td>CDC-ACM</td>
  *   <td bgcolor="#00EE00">Yes</td>
  *   <td bgcolor="#00EE00">Yes</td>
  *  </tr>
diff --git a/Projects/AVRISP-MKII/Lib/ISP/ISPTarget.c b/Projects/AVRISP-MKII/Lib/ISP/ISPTarget.c
index 157dd0b36..134120d9d 100644
--- a/Projects/AVRISP-MKII/Lib/ISP/ISPTarget.c
+++ b/Projects/AVRISP-MKII/Lib/ISP/ISPTarget.c
@@ -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.
  *
- *  \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
diff --git a/Projects/AVRISP-MKII/Lib/V2ProtocolParams.c b/Projects/AVRISP-MKII/Lib/V2ProtocolParams.c
index 5028dad88..097e0fe9d 100644
--- a/Projects/AVRISP-MKII/Lib/V2ProtocolParams.c
+++ b/Projects/AVRISP-MKII/Lib/V2ProtocolParams.c
@@ -108,7 +108,7 @@ void V2Params_UpdateParamValues(void)
  *
  *  \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)
 {
diff --git a/Projects/MissileLauncher/MissileLauncher.c b/Projects/MissileLauncher/MissileLauncher.c
index f215cd340..051fca937 100644
--- a/Projects/MissileLauncher/MissileLauncher.c
+++ b/Projects/MissileLauncher/MissileLauncher.c
@@ -158,7 +158,7 @@ void Send_Command_Report(const uint8_t* const Report,
 	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.
  */