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

@@ -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