Linux kernel mirror (for testing) git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
kernel os linux

dmaengine: acpi: Add kernel doc parameter descriptions

Kernel documentation script is not happy about absence of function parameter
descriptions:

drivers/dma/acpi-dma.c:163: warning: Function parameter or member 'data' not described in 'acpi_dma_controller_register'
drivers/dma/acpi-dma.c:247: warning: Function parameter or member 'data' not described in 'devm_acpi_dma_controller_register'
drivers/dma/acpi-dma.c:274: warning: Function parameter or member 'dev' not described in 'devm_acpi_dma_controller_free'

Append the descriptions of above mentioned function parameters.

Signed-off-by: Andy Shevchenko <andriy.shevchenko@linux.intel.com>
Link: https://lore.kernel.org/r/20190820131546.75744-3-andriy.shevchenko@linux.intel.com
Signed-off-by: Vinod Koul <vkoul@kernel.org>

authored by

Andy Shevchenko and committed by
Vinod Koul
4b8584ba a6bc3323

+3 -2
+3 -2
drivers/dma/acpi-dma.c
··· 147 147 * @dev: struct device of DMA controller 148 148 * @acpi_dma_xlate: translation function which converts a dma specifier 149 149 * into a dma_chan structure 150 - * @data pointer to controller specific data to be used by 150 + * @data: pointer to controller specific data to be used by 151 151 * translation function 152 152 * 153 153 * Allocated memory should be freed with appropriate acpi_dma_controller_free() ··· 231 231 * devm_acpi_dma_controller_register - resource managed acpi_dma_controller_register() 232 232 * @dev: device that is registering this DMA controller 233 233 * @acpi_dma_xlate: translation function 234 - * @data pointer to controller specific data 234 + * @data: pointer to controller specific data 235 235 * 236 236 * Managed acpi_dma_controller_register(). DMA controller registered by this 237 237 * function are automatically freed on driver detach. See ··· 264 264 265 265 /** 266 266 * devm_acpi_dma_controller_free - resource managed acpi_dma_controller_free() 267 + * @dev: device that is unregistering as DMA controller 267 268 * 268 269 * Unregister a DMA controller registered with 269 270 * devm_acpi_dma_controller_register(). Normally this function will not need to