diff options
author | Martin Roth <martin.roth@se-eng.com> | 2015-01-04 16:47:39 -0700 |
---|---|---|
committer | Martin Roth <gaumless@gmail.com> | 2015-01-06 06:33:25 +0100 |
commit | 5f066b29ce993c0fd67fc8b6ab156a0a0fa02c6c (patch) | |
tree | c5381d22bf4c0f3da053101bbaade1b6f5610f55 /src/include | |
parent | d63dbe8ef9455c546571585f9dbfa82243fb81f0 (diff) | |
download | coreboot-5f066b29ce993c0fd67fc8b6ab156a0a0fa02c6c.tar.xz |
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>
Diffstat (limited to 'src/include')
-rw-r--r-- | src/include/spi_flash.h | 6 |
1 files changed, 3 insertions, 3 deletions
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) ({ \ |