More documentation changes for better module-level documentation rather than file-level documentation.

LUFA/Drivers/Peripheral/ADC.h

@@ -36,8 +36,15 @@
  *  currently selected AVR model.
  */
 
-/** \ingroup Group_SubsystemDrivers
+/** \ingroup Group_PeripheralDrivers
  *  @defgroup Group_ADC ADC Driver - LUFA/Drivers/Peripheral/ADC.h
+ *
+ *  \section Sec_Dependencies Module Source Dependencies
+ *  The following files must be built with any user project that uses this module:
+ *    - None
+ *
+ *  \section Module Description
+ *  Functions, macros, variables, enums and types related to the setup of a the ADC subsystem.
  */
  
 #ifndef __ADC_H__
@@ -58,30 +65,5 @@
 		#else
 			#error "ADC is not available for the currently selected AVR model."
 		#endif
-
-	/* Public Interface - May be used in end-application: */
-		/* Inline Functions: */
-			/** Starts the reading of the given channel, but does not wait until the conversion has completed.
-			 *  Once executed, the conversion status can be determined via the ADC_IsReadingComplete() macro and
-			 *  the result read via the ADC_GetResult() macro.
-			 *
-			 *  \param MUXMask  Mask comprising of an ADC channel number, reference mask and adjustment mask
-			 */
-			static inline void ADC_StartReading(const uint8_t MUXMask);
-
-			/** Performs a complete single reading from channel, including a polling spinloop to wait for the
-			 *  conversion to complete, and the returning of the converted value.
-			 *
-			 *  \param MUXMask  Mask comprising of an ADC channel number, reference mask and adjustment mask
-			 */
-			static inline uint16_t ADC_GetChannelReading(const uint8_t MUXMask) ATTR_WARN_UNUSED_RESULT;
-
-			/** Configures the given ADC channel, ready for ADC conversions. This function sets the
-			 *  associated port pin as an input and disables the digital portion of the I/O to reduce
-			 *  power consumption.
-			 *
-			 *  \param Channel  ADC channel number to set up for conversions
-			 */
-			static inline void ADC_SetupChannel(const uint8_t Channel);
 			
 #endif

LUFA/Drivers/Peripheral/SPI.h

@@ -33,9 +33,14 @@
  *  Hardware SPI subsystem driver for the supported USB AVRs models.
  */
 
-/** \ingroup Group_SubsystemDrivers
+/** \ingroup Group_PeripheralDrivers
  *  @defgroup Group_SPI SPI Driver - LUFA/Drivers/Peripheral/SPI.h
  *
+ *  \section Sec_Dependencies Module Source Dependencies
+ *  The following files must be built with any user project that uses this module:
+ *    - None
+ *
+ *  \section Module Description
  *  Functions, macros, variables, enums and types related to the setup of a the SPI port.
  *
  *  @{

LUFA/Drivers/Peripheral/Serial.h

@@ -33,9 +33,14 @@
  *  Driver for the USART subsystem on supported USB AVRs.
  */
  
-/** \ingroup Group_SubsystemDrivers
+/** \ingroup Group_PeripheralDrivers
  *  @defgroup Group_Serial Serial USART Driver - LUFA/Drivers/Peripheral/Serial.h
  *
+ *  \section Sec_Dependencies Module Source Dependencies
+ *  The following files must be built with any user project that uses this module:
+ *    - LUFA/Drivers/Peripheral/Serial.c
+ *
+ *  \section Module Description
  *  Functions, macros, variables, enums and types related to the setup of the USART for serial communications.
  *
  *  @{
@@ -59,11 +64,6 @@
 
 	/* Public Interface - May be used in end-application: */
 		/* Macros: */	
-			/** Indicates whether a character has been received through the USART - boolean false if no character
-			 *  has been received, or non-zero if a character is waiting to be read from the reception buffer.
-			 */
-			#define Serial_IsCharReceived() ((UCSR1A & (1 << RXC1)) ? true : false)
-
 			/** Macro for calculating the baud value from a given baud rate when the U2X (double speed) bit is
 			 *  not set.
 			 */
@@ -74,6 +74,17 @@
 			 */
 			#define SERIAL_2X_UBBRVAL(baud) (((F_CPU / 8) / baud) - 1)
 
+		/* Psuedo-Functions: */
+			#if defined(__DOXYGEN__)
+				/** Indicates whether a character has been received through the USART.
+				 *
+				 *  \return Boolean true if a character has been received, false otherwise
+				 */
+				static inline bool Serial_IsCharReceived(void);
+			#else
+				#define Serial_IsCharReceived() ((UCSR1A & (1 << RXC1)) ? true : false)
+			#endif
+
 		/* Function Prototypes: */
 			/** Initializes the USART, ready for serial data transmission and reception.
 			 *

LUFA/Drivers/Peripheral/SerialStream.h

@@ -35,11 +35,17 @@
  *  USART.
  **/
 
-/** \ingroup Group_SubsystemDrivers
+/** \ingroup Group_PeripheralDrivers
  *  @defgroup Group_SerialStream Serial Stream Driver - LUFA/Drivers/Peripheral/SerialStream.h
  *
- *  Functions, macros, variables, enums and types related to the setup of a serial stream, so that standard printf and other
- *  C stream functions can be used on the serial port.
+ *  \section Sec_Dependencies Module Source Dependencies
+ *  The following files must be built with any user project that uses this module:
+ *    - LUFA/Drivers/Peripheral/SerialStream.c
+ *
+ *  \section Module Description
+ *  Serial stream driver for the USART subsystem on supported USB AVRs. This makes use of the functions in the
+ *  regular USART driver, but allows the avr-libc standard stream functions (printf, puts, etc.) to work with the
+ *  USART.
  *
  *  @{
  */