net: skbuff.h: properly escape a macro name on kernel-doc
authorMauro Carvalho Chehab <mchehab@s-opensource.com>
Fri, 12 May 2017 12:19:29 +0000 (09:19 -0300)
committerMauro Carvalho Chehab <mchehab@s-opensource.com>
Tue, 16 May 2017 11:44:13 +0000 (08:44 -0300)
The "%" escape code of kernel-doc only handle letters. It
doesn't handle special chars. So, use the ``literal``
notation. That fixes this warning:

./include/linux/skbuff.h:2695: WARNING: Inline literal start-string without end-string.

No functional changes.

Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
include/linux/skbuff.h

index a098d95b3d84d0246adc88651af9978d6810fb01..25b1659c832ad89f3634985c26530bb1e5c7f3ee 100644 (file)
@@ -2691,7 +2691,7 @@ bool skb_page_frag_refill(unsigned int sz, struct page_frag *pfrag, gfp_t prio);
  * @offset: the offset within the fragment (starting at the
  *          fragment's own offset)
  * @size: the number of bytes to map
- * @dir: the direction of the mapping (%PCI_DMA_*)
+ * @dir: the direction of the mapping (``PCI_DMA_*``)
  *
  * Maps the page associated with @frag to @device.
  */