Re: [PATCH net-next v2] iavf: fix kernel-doc comment style in iavf_ethtool.c

Breno Leitao
2026-04-09T12:35:45Z

On Thu, Apr 09, 2026 at 11:30:20AM +0200, Aleksandr Loktionov wrote:
> iavf_ethtool.c contains 31 kernel-doc comment blocks using the legacy
> `**/` terminator instead of the correct single `*/`. Two function
> headers also use a colon separator (`iavf_get_channels:`,
> `iavf_set_channels:`) instead of the ` - ` dash required by kernel-doc.
>
> Additionally several comments embed their return-value descriptions in
> the body paragraph, producing `scripts/kernel-doc -Wreturn` warnings.
> Void functions that incorrectly say "Returns ..." are also rephrased.
>
> Fix all issues across the full file:
> - Replace every `**/` terminator with `*/`.
> - Change `function_name:` doc headers to `function_name -`.
> - Move inline "Returns ..." sentences into dedicated `Return:` sections
> for non-void functions (iavf_get_msglevel, iavf_get_rxnfc,
> iavf_set_channels, iavf_get_rxfh_key_size, iavf_get_rxfh_indir_size,
> iavf_get_rxfh, iavf_set_rxfh).
> - Rephrase body descriptions in void functions that incorrectly said
> "Returns ..." (iavf_get_drvinfo, iavf_get_ringparam, iavf_get_coalesce).
> - Remove boilerplate body text for iavf_get_rxfh_key_size and
> iavf_get_rxfh_indir_size; the `Return:` line now conveys the same
> information without the vague "Returns the table size." sentence.
>
> Suggested-by: Anthony L. Nguyen <anthony.l.nguyen@intel.com>
> Suggested-by: Leszek Pepiak <leszek.pepiak@intel.com>
> Signed-off-by: Aleksandr Loktionov <aleksandr.loktionov@intel.com>

Reviewed-by: Breno Leitao <leitao@debian.org>