firewire: init_ohci1394_dma: add missing function parameter documentation
PATCH 1/1 firewire: init_ohci1394_dma: add missing function parameter documentation
Add missing kernel-doc parameter descriptions for five functions in init_ohci1394_dma.c to fix documentation warnings when building with W=1.
This patch addresses the following warnings:
- init_ohci1394_wait_for_busresets: missing @ohci description
- init_ohci1394_enable_physical_dma: missing @ohci description
- init_ohci1394_reset_and_init_dma: missing @ohci description
- init_ohci1394_controller: missing @num, @slot, @func descriptions
- setup_ohci1394_dma: missing @opt description
Tested with GCC 13.2.0 and W=1 flag. All documentation warnings for these functions have been resolved.
--- drivers/firewire/init_ohci1394_dma.c | 10 ++++++++++ 1 file changed, 10 insertions(+)
drivers/firewire/init_ohci1394_dma.c +10 -0
@@ -167,6 +167,7 @@ static inline void __init init_ohci1394_initialize(struct ohci *ohci)/** * init_ohci1394_wait_for_busresets - wait until bus resets are completed +* @ohci: Pointer to the OHCI-1394 controller structure * * OHCI1394 initialization itself and any device going on- or offline * and any cable issue cause a IEEE1394 bus reset. The OHCI1394 spec
@@ -189,6 +190,8 @@ static inline void __init init_ohci1394_wait_for_busresets(struct ohci *ohci)/** * init_ohci1394_enable_physical_dma - Enable physical DMA for remote debugging +* @ohci: Pointer to the OHCI-1394 controller structure +* * This enables remote DMA access over IEEE1394 from every host for the low * 4GB of address space. DMA accesses above 4GB are not available currently. */
@@ -201,6 +204,8 @@ static inline void __init init_ohci1394_enable_physical_dma(struct ohci *ohci)/** * init_ohci1394_reset_and_init_dma - init controller and enable DMA +* @ohci: Pointer to the OHCI-1394 controller structure +* * This initializes the given controller and enables physical DMA engine in it. */ static inline void __init init_ohci1394_reset_and_init_dma (struct ohci *ohci)
@@ -230,6 +235,10 @@ static inline void __init init_ohci1394_reset_and_init_dma(struct ohci *ohci)/** * init_ohci1394_controller - Map the registers of the controller and init DMA +* @num: PCI bus number +* @slot: PCI device number +* @func: PCI function number +* * This maps the registers of the specified controller and initializes it */ static inline void __init init_ohci1394_controller (int num,int slot,int func)
@@ -284,6 +293,7 @@ void __init init_ohci1394_dma_on_all_controllers(void)/** * setup_ohci1394_dma - enables early OHCI1394 DMA initialization +* @opt: Kernel command line parameter string */ static int __init setup_ohci1394_dma (char *opt) {
Signature · 1 line
2.48.1
Quoted 11 lines · Nirbhay Sharma
Add missing kernel-doc parameter descriptions for five functions in
init_ohci1394_dma.cto fix documentation warnings when building with W=1.This patch addresses the following warnings:
-init_ohci1394_wait_for_busresets: missing @ohci description
-init_ohci1394_enable_physical_dma: missing @ohci description
-init_ohci1394_reset_and_init_dma: missing @ohci description
-init_ohci1394_controller: missing @num, @slot, @func descriptions
-setup_ohci1394_dma: missing @opt description
Quoted 7 lines
Tested with GCC 13.2.0 and W=1 flag. All documentation warnings for these functions have been resolved.
Signed-off-by Nirbhay Sharma <[email protected]>--- drivers/firewire/init_ohci1394_dma.c | 10 ++++++++++ 1 file changed, 10 insertions(+)
Applied to for-linus branch.
Thanks
Takashi Sakamoto