fpga: fpga-region: fix kernel-doc formatting issues
authorNava kishore Manne <nava.manne@xilinx.com>
Sat, 23 Apr 2022 17:02:35 +0000 (22:32 +0530)
committerXu Yilun <yilun.xu@intel.com>
Tue, 10 May 2022 08:05:00 +0000 (16:05 +0800)
commit838a84382a9d78f306903e173bcaacd2e5178d9b
treeb74b0f1349b65caed14d9ba10168cf1911b78868
parentbaf7d27d033c7cbbdd483ce0867b27e54b702ad5
fpga: fpga-region: fix kernel-doc formatting issues

To fix below kernel-doc warnings this patch does the following
->Replaced Return\Returns with 'Return:' keyword.
->Added 'Return' description For __init of_fpga_region_init()' API.
->Added description for 'child_regions_with_firmware()' API.

warning: No description found for return value of
'of_fpga_region_find'.
warning: No description found for return value of
'of_fpga_region_get_bridges'.
warning: missing initial short description on line:
* child_regions_with_firmware
warning: No description found for return value of
'child_regions_with_firmware'.
warning: No description found for return value of
'of_fpga_region_notify_pre_apply'.
warning: No description found for return value of
'of_fpga_region_notify'.
warning: No description found for return value of
'of_fpga_region_init'.

Signed-off-by: Nava kishore Manne <nava.manne@xilinx.com>
Link: https://lore.kernel.org/r/20220423170235.2115479-6-nava.manne@xilinx.com
Signed-off-by: Xu Yilun <yilun.xu@intel.com>
drivers/fpga/of-fpga-region.c