sravan/system76-coreboot
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

doxygen fixes: change @var to @param var

Browse Source 
These files were trying to document the parameters, but didn't have
the syntax quite right.  Change the comments from @varname to
@param varname as required by doxygen.

Change-Id: I63662094d3f1686e3e35b61925b580eb06e72e28
Signed-off-by: Martin Roth <martin.roth@se-eng.com>
Reviewed-on: http://review.coreboot.org/8100
Reviewed-by: Edward O'Callaghan <eocallaghan@alterapraxis.com>
Tested-by: build bot (Jenkins)
Reviewed-by: Alexandru Gagniuc <mr.nuke.me@gmail.com>
This commit is contained in:
Martin Roth
2015-01-04 16:47:39 -07:00
committed by Martin Roth
parent d63dbe8ef9
commit 5f066b29ce
9 changed files with 33 additions and 32 deletions
Download Patch File Download Diff File Expand all files Collapse all files

5
src/drivers/ti/tps65090/tps65090.c
View File

@@ -87,8 +87,9 @@ static int tps65090_i2c_read(unsigned int bus,
/**
* Set the power state for a FET
*
* @fet_id Fet number to set (1..MAX_FET_NUM)
* @set 1 to power on FET, 0 to power off
* @param bus
* @param fet_id Fet number to set (1..MAX_FET_NUM)
* @param set 1 to power on FET, 0 to power off
* @return FET_ERR_COMMS if we got a comms error, FET_ERR_NOT_READY if the
* FET failed to change state. If all is ok, returns 0.
*/

20
src/drivers/ti/tps65090/tps65090.h
View File

@@ -67,8 +67,8 @@ enum {
/**
* Enable FET
*
* @bus I2C bus number the TPS65090 is on
* @fet_id FET ID, value between 1 and 7
* @param bus I2C bus number the TPS65090 is on
* @param fet_id FET ID, value between 1 and 7
* return 0 on success, non-0 on failure
*/
int tps65090_fet_enable(unsigned int bus, enum fet_id fet_id);
@@ -76,8 +76,8 @@ int tps65090_fet_enable(unsigned int bus, enum fet_id fet_id);
/**
* Disable FET
*
* @bus I2C bus number the TPS65090 is on
* @fet_id FET ID, value between 1 and 7
* @param bus I2C bus number the TPS65090 is on
* @param fet_id FET ID, value between 1 and 7
* @return 0 on success, non-0 on failure
*/
int tps65090_fet_disable(unsigned int bus, enum fet_id fet_id);
@@ -85,8 +85,8 @@ int tps65090_fet_disable(unsigned int bus, enum fet_id fet_id);
/**
* Is FET enabled?
*
* @bus I2C bus number the TPS65090 is on
* @fet_id FET ID, value between 1 and 7
* @param bus I2C bus number the TPS65090 is on
* @param fet_id FET ID, value between 1 and 7
* @return 1 enabled, 0 disabled, negative value on failure
*/
int tps65090_fet_is_enabled(unsigned int bus, enum fet_id fet_id);
@@ -94,15 +94,15 @@ int tps65090_fet_is_enabled(unsigned int bus, enum fet_id fet_id);
/**
* Enable / disable the battery charger
*
* @bus I2C bus number the TPS65090 is on
* @enable 0 to disable charging, non-zero to enable
* @param bus I2C bus number the TPS65090 is on
* @param enable 0 to disable charging, non-zero to enable
*/
int tps65090_set_charge_enable(unsigned int bus, int enable);
/**
* Check whether we have enabled battery charging
*
* @bus I2C bus number the TPS65090 is on
* @param bus I2C bus number the TPS65090 is on
* @return 1 if enabled, 0 if disabled
*/
int tps65090_is_charging(unsigned int bus);
@@ -110,7 +110,7 @@ int tps65090_is_charging(unsigned int bus);
/**
* Return the value of the status register
*
* @bus I2C bus number the TPS65090 is on
* @param bus I2C bus number the TPS65090 is on
* @return status register value, or -1 on error
*/
int tps65090_get_status(unsigned int bus);