From 73a3b0b1d973c7e55419f9a3890cd68c6ac130da Mon Sep 17 00:00:00 2001 From: Paul Kocialkowski Date: Mon, 28 Aug 2017 11:12:03 +0300 Subject: lib/igt_core: Use HTML character for documentation comment in example The gtkdoc output for the example configuration given in the file confuses gtkdoc because of the use of # for comments, that is interpreted as a headline (although it is an example block). This uses the HTML character instead to ensure the rendering is correct. Signed-off-by: Paul Kocialkowski (with one small typo fixed) Reviewed-by: Lyude Paul --- lib/igt_core.c | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) (limited to 'lib/igt_core.c') diff --git a/lib/igt_core.c b/lib/igt_core.c index 58d64dc2..99a82d5a 100644 --- a/lib/igt_core.c +++ b/lib/igt_core.c @@ -235,12 +235,12 @@ * An example configuration follows: * * |[ - * # The common configuration secton follows. + * # The common configuration section follows. * [Common] * FrameDumpPath=/tmp # The path to dump frames that fail comparison checks * - * # The following section is used for configuring the Device Under Test. - * # It is not mandatory and allows overriding default values. + * # The following section is used for configuring the Device Under Test. + * # It is not mandatory and allows overriding default values. * [DUT] * SuspendResumeDelay=10 * ]| -- cgit v1.2.3