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>

9 files changed, 33 insertions, 32 deletions

diff --git a/src/drivers/intel/gma/intel_dp.c b/src/drivers/intel/gma/intel_dp.c
index dc2a957cdd..55839e149a 100644
--- a/src/drivers/intel/gma/intel_dp.c
+++ b/src/drivers/intel/gma/intel_dp.c
@@ -38,7 +38,7 @@
 
 /**
  * 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
  * 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?
- * @intel_dp: DP struct
+ * @param intel_dp: DP struct
  *
  * 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
@@ -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?
- * @intel_dp: DP struct
+ * @param intel_dp: DP struct
  *
  * Returns 1 if the given DP struct corresponds to a CPU eDP port.
  */
diff --git a/src/drivers/ti/tps65090/tps65090.c b/src/drivers/ti/tps65090/tps65090.c
index 35a050f36f..58bb3ce95d 100644
--- a/src/drivers/ti/tps65090/tps65090.c
+++ b/src/drivers/ti/tps65090/tps65090.c
@@ -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.
  */
diff --git a/src/drivers/ti/tps65090/tps65090.h b/src/drivers/ti/tps65090/tps65090.h
index b38db59892..a79158b697 100644
--- a/src/drivers/ti/tps65090/tps65090.h
+++ b/src/drivers/ti/tps65090/tps65090.h
@@ -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);
diff --git a/src/include/spi_flash.h b/src/include/spi_flash.h
index 1a78b5a904..8ac7912f91 100644
--- a/src/include/spi_flash.h
+++ b/src/include/spi_flash.h
@@ -30,9 +30,9 @@
 
 /**
  * container_of - cast a member of a structure out to the containing structure
- * @ptr:	the pointer to the member.
- * @type:	the type of the container struct this is embedded in.
- * @member:	the name of the member within the struct.
+ * @param ptr:    the pointer to the member.
+ * @param type:   the type of the container struct this is embedded in.
+ * @param member: the name of the member within the struct.
  *
  */
 #define container_of(ptr, type, member) ({			\
diff --git a/src/lib/ramtest.c b/src/lib/ramtest.c
index e9173fa7e6..03c4aa7d78 100644
--- a/src/lib/ramtest.c
+++ b/src/lib/ramtest.c
@@ -52,9 +52,9 @@ static void phys_memory_barrier(void)
  * memory bus. To test most address lines, addresses are scattered
  * using 256B, 4kB and 64kB increments.
  *
- * @idx		Index to test pattern (0=<idx<0x400)
- * @addr	Memory to access on @idx
- * @value	Value to write or read at @addr
+ * @param idx	Index to test pattern (0=<idx<0x400)
+ * @param addr	Memory to access on idx
+ * @param value	Value to write or read at addr
  */
 static inline void test_pattern(unsigned short int idx,
 	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
  * 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)
 {
diff --git a/src/soc/intel/common/hda_verb.c b/src/soc/intel/common/hda_verb.c
index 6404ee281f..946972ef7e 100644
--- a/src/soc/intel/common/hda_verb.c
+++ b/src/soc/intel/common/hda_verb.c
@@ -139,10 +139,10 @@ static int hda_wait_for_valid(u32 base)
 /**
  * Find a specific entry within a verb table
  *
- * @verb_table_bytes:	verb table size in bytes
- * @verb_table_data:	verb table data
- * @viddid:		vendor/device to search for
- * @verb_out:		pointer to entry within table
+ * @param verb_table_bytes:	verb table size in bytes
+ * @param verb_table_data:	verb table data
+ * @param viddid:		vendor/device to search for
+ * @param verb:			pointer to entry within table
  *
  * Returns size of the entry within the verb table,
  * Returns 0 if the entry is not found
diff --git a/src/soc/qualcomm/ipq806x/timer.c b/src/soc/qualcomm/ipq806x/timer.c
index 676c7f53e8..3cb9531d33 100644
--- a/src/soc/qualcomm/ipq806x/timer.c
+++ b/src/soc/qualcomm/ipq806x/timer.c
@@ -50,7 +50,7 @@ void init_timer(void)
 
 /**
  * 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
  * its multiples. In Rumi GPT clock is 32 KHz
diff --git a/src/soc/samsung/exynos5250/fb.c b/src/soc/samsung/exynos5250/fb.c
index 080be49250..e0355fc715 100644
--- a/src/soc/samsung/exynos5250/fb.c
+++ b/src/soc/samsung/exynos5250/fb.c
@@ -114,7 +114,7 @@ static void fimd_bypass(void)
  * Initialize display controller.
  *
  * @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,
 	     struct exynos5_fimd_panel *pd)
diff --git a/src/southbridge/intel/lynxpoint/hda_verb.c b/src/southbridge/intel/lynxpoint/hda_verb.c
index 234a1ab439..424deb52bb 100644
--- a/src/southbridge/intel/lynxpoint/hda_verb.c
+++ b/src/southbridge/intel/lynxpoint/hda_verb.c
@@ -140,10 +140,10 @@ static int hda_wait_for_valid(u32 base)
 /**
  * Find a specific entry within a verb table
  *
- * @verb_table_bytes:	verb table size in bytes
- * @verb_table_data:	verb table data
- * @viddid:		vendor/device to search for
- * @verb_out:		pointer to entry within table
+ * @param verb_table_bytes:	verb table size in bytes
+ * @param verb_table_data:	verb table data
+ * @param viddid:		vendor/device to search for
+ * @param **verb:		pointer to entry within table
  *
  * Returns size of the entry within the verb table,
  * Returns 0 if the entry is not found