fix(Documentation): Remove Misleading Doxygen Comment for I2C Init (Doesn't Set Speed) (#782)

Jake-Carter · web-flow · commit 74042a964819 · 2023-11-02T15:58:07.000-05:00
diff --git a/Libraries/PeriphDrivers/Include/MAX32520/i2c.h b/Libraries/PeriphDrivers/Include/MAX32520/i2c.h
@@ -180,8 +180,7 @@ typedef int (*mxc_i2c_slave_handler_t)(mxc_i2c_regs_t *i2c, mxc_i2c_slave_event_
 
 /**
  * @brief   Initialize and enable I2C peripheral.
- * @note    This function sets the I2C Speed to 100kHz,  if another speed is
- *          desired use the MXC_I2C_SetFrequency() function to set it.
+
  *
  * @param   i2c         Pointer to I2C registers (selects the I2C block used.)
  * @param   masterMode  Whether to put the device in master or slave mode. Use
diff --git a/Libraries/PeriphDrivers/Include/MAX32570/i2c.h b/Libraries/PeriphDrivers/Include/MAX32570/i2c.h
@@ -177,8 +177,7 @@ typedef int (*mxc_i2c_slave_handler_t)(mxc_i2c_regs_t *i2c, mxc_i2c_slave_event_
 
 /**
  * @brief   Initialize and enable I2C peripheral.
- * @note    This function sets the I2C Speed to 100kHz,  if another speed is
- *          desired use the MXC_I2C_SetFrequency() function to set it.
+ *
  *
  * @param   i2c         Pointer to I2C registers (selects the I2C block used.)
  * @param   masterMode  Whether to put the device in master or slave mode. Use
diff --git a/Libraries/PeriphDrivers/Include/MAX32572/i2c.h b/Libraries/PeriphDrivers/Include/MAX32572/i2c.h
@@ -183,8 +183,7 @@ typedef int (*mxc_i2c_slave_handler_t)(mxc_i2c_regs_t *i2c, mxc_i2c_slave_event_
 
 /**
  * @brief   Initialize and enable I2C peripheral.
- * @note    This function sets the I2C Speed to 100kHz,  if another speed is
- *          desired use the MXC_I2C_SetFrequency() function to set it.
+ *
  *
  * @param   i2c         Pointer to I2C registers (selects the I2C block used.)
  * @param   masterMode  Whether to put the device in master or slave mode. Use
diff --git a/Libraries/PeriphDrivers/Include/MAX32650/i2c.h b/Libraries/PeriphDrivers/Include/MAX32650/i2c.h
@@ -180,8 +180,7 @@ typedef int (*mxc_i2c_slave_handler_t)(mxc_i2c_regs_t *i2c, mxc_i2c_slave_event_
 
 /**
  * @brief   Initialize and enable I2C peripheral.
- * @note    This function sets the I2C Speed to 100kHz,  if another speed is
- *          desired use the MXC_I2C_SetFrequency() function to set it.
+ *
  *
  * @param   i2c         Pointer to I2C registers (selects the I2C block used.)
  * @param   masterMode  Whether to put the device in master or slave mode. Use
diff --git a/Libraries/PeriphDrivers/Include/MAX32655/i2c.h b/Libraries/PeriphDrivers/Include/MAX32655/i2c.h
@@ -183,8 +183,7 @@ typedef int (*mxc_i2c_slave_handler_t)(mxc_i2c_regs_t *i2c, mxc_i2c_slave_event_
 
 /**
  * @brief   Initialize and enable I2C peripheral.
- * @note    This function sets the I2C Speed to 100kHz,  if another speed is
- *          desired use the MXC_I2C_SetFrequency() function to set it.
+ *
  * @note    On default this function enables I2C peripheral clock and i2c gpio pins.
  *          if you wish to manage clock and gpio related things in upper level instead of here.
  *          Define MSDK_NO_GPIO_CLK_INIT flag in project.mk file. 
diff --git a/Libraries/PeriphDrivers/Include/MAX32660/i2c.h b/Libraries/PeriphDrivers/Include/MAX32660/i2c.h
@@ -184,8 +184,7 @@ typedef int (*mxc_i2c_slave_handler_t)(mxc_i2c_regs_t *i2c, mxc_i2c_slave_event_
 
 /**
  * @brief   Initialize and enable I2C peripheral.
- * @note    This function sets the I2C Speed to 100kHz,  if another speed is
- *          desired use the MXC_I2C_SetFrequency() function to set it.
+ *
  *
  * @param   i2c         Pointer to I2C registers (selects the I2C block used.)
  * @param   masterMode  Whether to put the device in master or slave mode. Use
diff --git a/Libraries/PeriphDrivers/Include/MAX32662/i2c.h b/Libraries/PeriphDrivers/Include/MAX32662/i2c.h
@@ -177,8 +177,7 @@ typedef int (*mxc_i2c_slave_handler_t)(mxc_i2c_regs_t *i2c, mxc_i2c_slave_event_
 
 /**
  * @brief   Initialize and enable I2C peripheral.
- * @note    This function sets the I2C Speed to 100kHz,  if another speed is
- *          desired use the MXC_I2C_SetFrequency() function to set it.
+ *
  *
  * @param   i2c         Pointer to I2C registers (selects the I2C block used.)
  * @param   masterMode  Whether to put the device in master or slave mode. Use
diff --git a/Libraries/PeriphDrivers/Include/MAX32665/i2c.h b/Libraries/PeriphDrivers/Include/MAX32665/i2c.h
@@ -185,8 +185,7 @@ typedef int (*mxc_i2c_slave_handler_t)(mxc_i2c_regs_t *i2c, mxc_i2c_slave_event_
 
 /**
  * @brief   Initialize and enable I2C peripheral.
- * @note    This function sets the I2C Speed to 100kHz,  if another speed is
- *          desired use the MXC_I2C_SetFrequency() function to set it.
+ *
  * @note    On default this function enables I2C peripheral clock and i2c gpio pins.
  *          if you wish to manage clock and gpio related things in upper level instead of here.
  *          Define MSDK_NO_GPIO_CLK_INIT flag in project.mk file. 
diff --git a/Libraries/PeriphDrivers/Include/MAX32670/i2c.h b/Libraries/PeriphDrivers/Include/MAX32670/i2c.h
@@ -184,8 +184,7 @@ typedef int (*mxc_i2c_slave_handler_t)(mxc_i2c_regs_t *i2c, mxc_i2c_slave_event_
 
 /**
  * @brief   Initialize and enable I2C peripheral.
- * @note    This function sets the I2C Speed to 100kHz,  if another speed is
- *          desired use the MXC_I2C_SetFrequency() function to set it.
+ *
  * @note    On default this function enables I2C peripheral clock and i2c gpio pins.
  *          if you wish to manage clock and gpio related things in upper level instead of here.
  *          Define MSDK_NO_GPIO_CLK_INIT flag in project.mk file. 
diff --git a/Libraries/PeriphDrivers/Include/MAX32672/i2c.h b/Libraries/PeriphDrivers/Include/MAX32672/i2c.h
@@ -184,8 +184,7 @@ typedef int (*mxc_i2c_slave_handler_t)(mxc_i2c_regs_t *i2c, mxc_i2c_slave_event_
 
 /**
  * @brief   Initialize and enable I2C peripheral.
- * @note    This function sets the I2C Speed to 100kHz,  if another speed is
- *          desired use the MXC_I2C_SetFrequency() function to set it.
+ *
  *
  * @param   i2c         Pointer to I2C registers (selects the I2C block used.)
  * @param   masterMode  Whether to put the device in master or slave mode. Use
diff --git a/Libraries/PeriphDrivers/Include/MAX32675/i2c.h b/Libraries/PeriphDrivers/Include/MAX32675/i2c.h
@@ -184,8 +184,7 @@ typedef int (*mxc_i2c_slave_handler_t)(mxc_i2c_regs_t *i2c, mxc_i2c_slave_event_
 
 /**
  * @brief   Initialize and enable I2C peripheral.
- * @note    This function sets the I2C Speed to 100kHz,  if another speed is
- *          desired use the MXC_I2C_SetFrequency() function to set it.
+ *
  *
  * @param   i2c         Pointer to I2C registers (selects the I2C block used.)
  * @param   masterMode  Whether to put the device in master or slave mode. Use
diff --git a/Libraries/PeriphDrivers/Include/MAX32680/i2c.h b/Libraries/PeriphDrivers/Include/MAX32680/i2c.h
@@ -183,8 +183,7 @@ typedef int (*mxc_i2c_slave_handler_t)(mxc_i2c_regs_t *i2c, mxc_i2c_slave_event_
 
 /**
  * @brief   Initialize and enable I2C peripheral.
- * @note    This function sets the I2C Speed to 100kHz,  if another speed is
- *          desired use the MXC_I2C_SetFrequency() function to set it.
+ *
  *
  * @param   i2c         Pointer to I2C registers (selects the I2C block used.)
  * @param   masterMode  Whether to put the device in master or slave mode. Use
diff --git a/Libraries/PeriphDrivers/Include/MAX32690/i2c.h b/Libraries/PeriphDrivers/Include/MAX32690/i2c.h
@@ -183,8 +183,7 @@ typedef int (*mxc_i2c_slave_handler_t)(mxc_i2c_regs_t *i2c, mxc_i2c_slave_event_
 
 /**
  * @brief   Initialize and enable I2C peripheral.
- * @note    This function sets the I2C Speed to 100kHz,  if another speed is
- *          desired use the MXC_I2C_SetFrequency() function to set it.
+ *
  * @note    On default this function enables I2C peripheral clock and i2c gpio pins.
  *          if you wish to manage clock and gpio related things in upper level instead of here.
  *          Define MSDK_NO_GPIO_CLK_INIT flag in project.mk file. 
diff --git a/Libraries/PeriphDrivers/Include/MAX78000/i2c.h b/Libraries/PeriphDrivers/Include/MAX78000/i2c.h
@@ -177,8 +177,7 @@ typedef int (*mxc_i2c_slave_handler_t)(mxc_i2c_regs_t *i2c, mxc_i2c_slave_event_
 
 /**
  * @brief   Initialize and enable I2C peripheral.
- * @note    This function sets the I2C Speed to 100kHz,  if another speed is
- *          desired use the MXC_I2C_SetFrequency() function to set it.
+ *
  *
  * @param   i2c         Pointer to I2C registers (selects the I2C block used.)
  * @param   masterMode  Whether to put the device in master or slave mode. Use
diff --git a/Libraries/PeriphDrivers/Include/MAX78002/i2c.h b/Libraries/PeriphDrivers/Include/MAX78002/i2c.h
@@ -183,8 +183,7 @@ typedef int (*mxc_i2c_slave_handler_t)(mxc_i2c_regs_t *i2c, mxc_i2c_slave_event_
 
 /**
  * @brief   Initialize and enable I2C peripheral.
- * @note    This function sets the I2C Speed to 100kHz,  if another speed is
- *          desired use the MXC_I2C_SetFrequency() function to set it.
+ *
  *
  * @param   i2c         Pointer to I2C registers (selects the I2C block used.)
  * @param   masterMode  Whether to put the device in master or slave mode. Use

Original file line number	Diff line number	Diff line change
`@@ -180,8 +180,7 @@ typedef int (mxc_i2c_slave_handler_t)(mxc_i2c_regs_t i2c, mxc_i2c_slave_event_`
`180`	`180`
`181`	`181`	`/**`
`182`	`182`	`* @brief Initialize and enable I2C peripheral.`
`183`		`- * @note This function sets the I2C Speed to 100kHz, if another speed is`
`184`		`- * desired use the MXC_I2C_SetFrequency() function to set it.`
	`183`	`+`
`185`	`184`	`*`
`186`	`185`	`* @param i2c Pointer to I2C registers (selects the I2C block used.)`
`187`	`186`	`* @param masterMode Whether to put the device in master or slave mode. Use`
Original file line number	Diff line number	Diff line change
`@@ -177,8 +177,7 @@ typedef int (mxc_i2c_slave_handler_t)(mxc_i2c_regs_t i2c, mxc_i2c_slave_event_`
`177`	`177`
`178`	`178`	`/**`
`179`	`179`	`* @brief Initialize and enable I2C peripheral.`
`180`		`- * @note This function sets the I2C Speed to 100kHz, if another speed is`
`181`		`- * desired use the MXC_I2C_SetFrequency() function to set it.`
	`180`	`+ *`
`182`	`181`	`*`
`183`	`182`	`* @param i2c Pointer to I2C registers (selects the I2C block used.)`
`184`	`183`	`* @param masterMode Whether to put the device in master or slave mode. Use`
Original file line number	Diff line number	Diff line change
`@@ -183,8 +183,7 @@ typedef int (mxc_i2c_slave_handler_t)(mxc_i2c_regs_t i2c, mxc_i2c_slave_event_`
`183`	`183`
`184`	`184`	`/**`
`185`	`185`	`* @brief Initialize and enable I2C peripheral.`
`186`		`- * @note This function sets the I2C Speed to 100kHz, if another speed is`
`187`		`- * desired use the MXC_I2C_SetFrequency() function to set it.`
	`186`	`+ *`
`188`	`187`	`*`
`189`	`188`	`* @param i2c Pointer to I2C registers (selects the I2C block used.)`
`190`	`189`	`* @param masterMode Whether to put the device in master or slave mode. Use`
Original file line number	Diff line number	Diff line change
`@@ -184,8 +184,7 @@ typedef int (mxc_i2c_slave_handler_t)(mxc_i2c_regs_t i2c, mxc_i2c_slave_event_`
`184`	`184`
`185`	`185`	`/**`
`186`	`186`	`* @brief Initialize and enable I2C peripheral.`
`187`		`- * @note This function sets the I2C Speed to 100kHz, if another speed is`
`188`		`- * desired use the MXC_I2C_SetFrequency() function to set it.`
	`187`	`+ *`
`189`	`188`	`*`
`190`	`189`	`* @param i2c Pointer to I2C registers (selects the I2C block used.)`
`191`	`190`	`* @param masterMode Whether to put the device in master or slave mode. Use`