drivers/net/ethernet: add some basic kdoc tags

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

kernel os linux

A couple of drivers had a "generic documentation" section that
would trigger a "can't understand" message from W=1 compiles.

Fix by using correct DOC: tags in the generic sections.

Fixed Warnings:
drivers/net/ethernet/arc/emac_arc.c:4: info: Scanning doc for c
drivers/net/ethernet/cadence/macb_pci.c:3: warning: missing initial short description on line:
* Cadence GEM PCI wrapper.
drivers/net/ethernet/cadence/macb_pci.c:3: info: Scanning doc for Cadence

Signed-off-by: Jesse Brandeburg <jesse.brandeburg@intel.com>
Signed-off-by: David S. Miller <davem@davemloft.net>

authored by

Jesse Brandeburg and committed by

David S. Miller 5 years ago f410f157 2602ddfe

+2 -2

2 changed files

expand all

drivers

net

ethernet

arc

emac_arc.c

cadence

macb_pci.c

+1 -1

drivers/net/ethernet/arc/emac_arc.c

··· 1 1 // SPDX-License-Identifier: GPL-2.0-or-later 2 2 /** 3 - * emac_arc.c - ARC EMAC specific glue layer 3 + * DOC: emac_arc.c - ARC EMAC specific glue layer 4 4 * 5 5 * Copyright (C) 2014 Romain Perier 6 6 *

+1 -1

drivers/net/ethernet/cadence/macb_pci.c

··· 1 1 // SPDX-License-Identifier: GPL-2.0-only 2 2 /** 3 - * Cadence GEM PCI wrapper. 3 + * DOC: Cadence GEM PCI wrapper. 4 4 * 5 5 * Copyright (C) 2016 Cadence Design Systems - https://www.cadence.com 6 6 *