Update host C# applications for VS2010. Make LEDNotifier project host applications...
[pub/lufa.git] / LUFA / Drivers / Peripheral / AVR8 / TWI_AVR8.h
index 0f31eca..5a6c296 100644 (file)
@@ -52,8 +52,8 @@
  *
  *  <b>Low Level API Example:</b>
  *  \code
- *      // Initialize the TWI driver before first use
- *      TWI_Init(TWI_BIT_PRESCALE_1, 10);
+ *      // Initialize the TWI driver before first use at 200KHz
+ *      TWI_Init(TWI_BIT_PRESCALE_1, TWI_BITLENGTH_FROM_FREQ(1, 200000));
  *
  *      // Start a write session to device at device address 0xA0, internal address 0xDC with a 10ms timeout
  *      if (TWI_StartTransmission(0xA0 | TWI_ADDRESS_WRITE, 10) == TWI_ERROR_NoError)
@@ -91,8 +91,8 @@
  * 
  *  <b>High Level API Example:</b>
  *  \code
- *      // Initialize the TWI driver before first use
- *      TWI_Init(TWI_BIT_PRESCALE_1, 10);
+ *      // Initialize the TWI driver before first use at 200KHz
+ *      TWI_Init(TWI_BIT_PRESCALE_1, TWI_BITLENGTH_FROM_FREQ(1, 200000));
  *
  *      // Start a write session to device at device address 0xA0, internal address 0xDC with a 10ms timeout
  *      uint8_t InternalWriteAddress = 0xDC;
                         *  the \ref TWI_Init() function to convert a bus frequency to a number of clocks for the \c BitLength
                         *  parameter.
                         *
-                        *  \param[in] Prescaler  Prescaler set on the TWI bus.
+                        *  \param[in] Prescale   Prescaler set on the TWI bus.
                         *  \param[in] Frequency  Desired TWI bus frequency in Hz.
                         *
                         *  \return Bit length in clocks for the given TWI bus frequency at the given prescaler value.