Skip to content

Commit

Permalink
Fix misleading Doxygen comment for I2C init
Browse files Browse the repository at this point in the history
  • Loading branch information
@Jake-Carter
Jake-Carter committed Oct 25, 2023
1 parent ed99a4c commit c9158fc
Show file tree
Hide file tree
Showing 15 changed files with 15 additions and 30 deletions.
3 changes: 1 addition & 2 deletions Libraries/PeriphDrivers/Include/MAX32520/i2c.h
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
3 changes: 1 addition & 2 deletions Libraries/PeriphDrivers/Include/MAX32570/i2c.h
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
3 changes: 1 addition & 2 deletions Libraries/PeriphDrivers/Include/MAX32572/i2c.h
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
3 changes: 1 addition & 2 deletions Libraries/PeriphDrivers/Include/MAX32650/i2c.h
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
3 changes: 1 addition & 2 deletions Libraries/PeriphDrivers/Include/MAX32655/i2c.h
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
3 changes: 1 addition & 2 deletions Libraries/PeriphDrivers/Include/MAX32660/i2c.h
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
3 changes: 1 addition & 2 deletions Libraries/PeriphDrivers/Include/MAX32662/i2c.h
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
3 changes: 1 addition & 2 deletions Libraries/PeriphDrivers/Include/MAX32665/i2c.h
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
3 changes: 1 addition & 2 deletions Libraries/PeriphDrivers/Include/MAX32670/i2c.h
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
3 changes: 1 addition & 2 deletions Libraries/PeriphDrivers/Include/MAX32672/i2c.h
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
3 changes: 1 addition & 2 deletions Libraries/PeriphDrivers/Include/MAX32675/i2c.h
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
3 changes: 1 addition & 2 deletions Libraries/PeriphDrivers/Include/MAX32680/i2c.h
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
3 changes: 1 addition & 2 deletions Libraries/PeriphDrivers/Include/MAX32690/i2c.h
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
3 changes: 1 addition & 2 deletions Libraries/PeriphDrivers/Include/MAX78000/i2c.h
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
3 changes: 1 addition & 2 deletions Libraries/PeriphDrivers/Include/MAX78002/i2c.h
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down

0 comments on commit c9158fc

Please sign in to comment.