linux-kernel - [PATCH 14/18] fbdev: modedb.c: fix a kernel-doc markup

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite: Windows password security audit tool. GUI, reports in PDF.

[<prev] [next>] [<thread-prev] [thread-next>] [day] [month] [year] [list]

Message-Id: <a712d724d034cedeab76335071f916808db77e7a.1525684985.git.mchehab+samsung@kernel.org>
Date:   Mon,  7 May 2018 06:35:50 -0300
From:   Mauro Carvalho Chehab <mchehab+samsung@...nel.org>
To:     Linux Doc Mailing List <linux-doc@...r.kernel.org>
Cc:     Mauro Carvalho Chehab <mchehab+samsung@...nel.org>,
        Mauro Carvalho Chehab <mchehab@...radead.org>,
        linux-kernel@...r.kernel.org, Jonathan Corbet <corbet@....net>,
        Bartlomiej Zolnierkiewicz <b.zolnierkie@...sung.com>,
        dri-devel@...ts.freedesktop.org, linux-fbdev@...r.kernel.org
Subject: [PATCH 14/18] fbdev: modedb.c: fix a kernel-doc markup

Use code blocks to avoid those warnings and make it look nicer.

	./drivers/video/fbdev/core/modedb.c:647: WARNING: Inline strong start-string without end-string.
	./drivers/video/fbdev/core/modedb.c:647: WARNING: Inline strong start-string without end-string.
	./drivers/video/fbdev/core/modedb.c:647: WARNING: Inline strong start-string without end-string.
	./drivers/video/fbdev/core/modedb.c:647: WARNING: Inline strong start-string without end-string.

Signed-off-by: Mauro Carvalho Chehab <mchehab+samsung@...nel.org>
---
 drivers/video/fbdev/core/modedb.c | 22 +++++++++++-----------
 1 file changed, 11 insertions(+), 11 deletions(-)

diff --git a/drivers/video/fbdev/core/modedb.c b/drivers/video/fbdev/core/modedb.c
index 2510fa728d77..7284324fbd77 100644
--- a/drivers/video/fbdev/core/modedb.c
+++ b/drivers/video/fbdev/core/modedb.c
@@ -642,23 +642,23 @@ static int fb_try_mode(struct fb_var_screeninfo *var, struct fb_info *info,
  *     @default_mode fails, all modes in the video mode database will
  *     be tried.
  *
- *     Valid mode specifiers for @mode_option:
+ *     Valid mode specifiers for @mode_option::
  *
- *     <xres>x<yres>[M][R][-<bpp>][@<refresh>][i][m] or
- *     <name>[-<bpp>][@<refresh>]
+ *       <xres>x<yres>[M][R][-<bpp>][@<refresh>][i][m] or
+ *       <name>[-<bpp>][@<refresh>]
  *
  *     with <xres>, <yres>, <bpp> and <refresh> decimal numbers and
  *     <name> a string.
  *
- *      If 'M' is present after yres (and before refresh/bpp if present),
- *      the function will compute the timings using VESA(tm) Coordinated
- *      Video Timings (CVT).  If 'R' is present after 'M', will compute with
- *      reduced blanking (for flatpanels).  If 'i' is present, compute
- *      interlaced mode.  If 'm' is present, add margins equal to 1.8%
- *      of xres rounded down to 8 pixels, and 1.8% of yres. The char
- *      'i' and 'm' must be after 'M' and 'R'. Example:
+ *     If 'M' is present after yres (and before refresh/bpp if present),
+ *     the function will compute the timings using VESA(tm) Coordinated
+ *     Video Timings (CVT).  If 'R' is present after 'M', will compute with
+ *     reduced blanking (for flatpanels).  If 'i' is present, compute
+ *     interlaced mode.  If 'm' is present, add margins equal to 1.8%
+ *     of xres rounded down to 8 pixels, and 1.8% of yres. The char
+ *     'i' and 'm' must be after 'M' and 'R'. Example::
  *
- *      1024x768MR-8@60m - Reduced blank with margins at 60Hz.
+ *       1024x768MR-8@60m - Reduced blank with margins at 60Hz.
  *
  *     NOTE: The passed struct @var is _not_ cleared!  This allows you
  *     to supply values for e.g. the grayscale and accel_flags fields.
-- 
2.17.0