doxygen fixes: change @var to @param var

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

View File

@ -38,7 +38,7 @@
/** /**
* is_edp - is the given port attached to an eDP panel (either CPU or PCH) * is_edp - is the given port attached to an eDP panel (either CPU or PCH)
* @intel_dp: DP struct * @param intel_dp: DP struct
* *
* If a CPU or PCH DP output is attached to an eDP panel, this function * If a CPU or PCH DP output is attached to an eDP panel, this function
* will return 1, and 0 otherwise. * will return 1, and 0 otherwise.
@ -50,7 +50,7 @@ static int is_edp(struct intel_dp *intel_dp)
/** /**
* is_pch_edp - is the port on the PCH and attached to an eDP panel? * is_pch_edp - is the port on the PCH and attached to an eDP panel?
* @intel_dp: DP struct * @param intel_dp: DP struct
* *
* Returns 1 if the given DP struct corresponds to a PCH DP port attached * Returns 1 if the given DP struct corresponds to a PCH DP port attached
* to an eDP panel, 0 otherwise. Helpful for determining whether we * to an eDP panel, 0 otherwise. Helpful for determining whether we
@ -63,7 +63,7 @@ static int is_pch_edp(struct intel_dp *intel_dp)
/** /**
* is_cpu_edp - is the port on the CPU and attached to an eDP panel? * is_cpu_edp - is the port on the CPU and attached to an eDP panel?
* @intel_dp: DP struct * @param intel_dp: DP struct
* *
* Returns 1 if the given DP struct corresponds to a CPU eDP port. * Returns 1 if the given DP struct corresponds to a CPU eDP port.
*/ */

View File

@ -87,8 +87,9 @@ static int tps65090_i2c_read(unsigned int bus,
/** /**
* Set the power state for a FET * Set the power state for a FET
* *
* @fet_id Fet number to set (1..MAX_FET_NUM) * @param bus
* @set 1 to power on FET, 0 to power off * @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 * @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. * FET failed to change state. If all is ok, returns 0.
*/ */

View File

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

View File

@ -30,9 +30,9 @@
/** /**
* container_of - cast a member of a structure out to the containing structure * container_of - cast a member of a structure out to the containing structure
* @ptr: the pointer to the member. * @param ptr: the pointer to the member.
* @type: the type of the container struct this is embedded in. * @param type: the type of the container struct this is embedded in.
* @member: the name of the member within the struct. * @param member: the name of the member within the struct.
* *
*/ */
#define container_of(ptr, type, member) ({ \ #define container_of(ptr, type, member) ({ \

View File

@ -52,9 +52,9 @@ static void phys_memory_barrier(void)
* memory bus. To test most address lines, addresses are scattered * memory bus. To test most address lines, addresses are scattered
* using 256B, 4kB and 64kB increments. * using 256B, 4kB and 64kB increments.
* *
* @idx Index to test pattern (0=<idx<0x400) * @param idx Index to test pattern (0=<idx<0x400)
* @addr Memory to access on @idx * @param addr Memory to access on idx
* @value Value to write or read at @addr * @param value Value to write or read at addr
*/ */
static inline void test_pattern(unsigned short int idx, static inline void test_pattern(unsigned short int idx,
unsigned long *addr, unsigned long *value) unsigned long *addr, unsigned long *value)
@ -74,7 +74,7 @@ static inline void test_pattern(unsigned short int idx,
* Simple write-read-verify memory test. See console debug output for * Simple write-read-verify memory test. See console debug output for
* any dislocated bytes. * any dislocated bytes.
* *
* @start System memory offset, aligned to 128bytes * @param start System memory offset, aligned to 128bytes
*/ */
static int ram_bitset_nodie(unsigned long start) static int ram_bitset_nodie(unsigned long start)
{ {

View File

@ -139,10 +139,10 @@ static int hda_wait_for_valid(u32 base)
/** /**
* Find a specific entry within a verb table * Find a specific entry within a verb table
* *
* @verb_table_bytes: verb table size in bytes * @param verb_table_bytes: verb table size in bytes
* @verb_table_data: verb table data * @param verb_table_data: verb table data
* @viddid: vendor/device to search for * @param viddid: vendor/device to search for
* @verb_out: pointer to entry within table * @param verb: pointer to entry within table
* *
* Returns size of the entry within the verb table, * Returns size of the entry within the verb table,
* Returns 0 if the entry is not found * Returns 0 if the entry is not found

View File

@ -50,7 +50,7 @@ void init_timer(void)
/** /**
* udelay - generates micro second delay. * udelay - generates micro second delay.
* @usec: delay duration in microseconds * @param usec: delay duration in microseconds
* *
* With 32KHz clock, minimum possible delay is 31.25 Micro seconds and * With 32KHz clock, minimum possible delay is 31.25 Micro seconds and
* its multiples. In Rumi GPT clock is 32 KHz * its multiples. In Rumi GPT clock is 32 KHz

View File

@ -114,7 +114,7 @@ static void fimd_bypass(void)
* Initialize display controller. * Initialize display controller.
* *
* @param lcdbase pointer to the base address of framebuffer. * @param lcdbase pointer to the base address of framebuffer.
* @pd pointer to the main panel_data structure * @param pd pointer to the main panel_data structure
*/ */
void fb_init(unsigned long int fb_size, void *lcdbase, void fb_init(unsigned long int fb_size, void *lcdbase,
struct exynos5_fimd_panel *pd) struct exynos5_fimd_panel *pd)

View File

@ -140,10 +140,10 @@ static int hda_wait_for_valid(u32 base)
/** /**
* Find a specific entry within a verb table * Find a specific entry within a verb table
* *
* @verb_table_bytes: verb table size in bytes * @param verb_table_bytes: verb table size in bytes
* @verb_table_data: verb table data * @param verb_table_data: verb table data
* @viddid: vendor/device to search for * @param viddid: vendor/device to search for
* @verb_out: pointer to entry within table * @param **verb: pointer to entry within table
* *
* Returns size of the entry within the verb table, * Returns size of the entry within the verb table,
* Returns 0 if the entry is not found * Returns 0 if the entry is not found