[PATCH i-g-t 1/3] lib/igt_core: Use HTML character for documentation comment in example

From: Paul Kocialkowski <paul.kocialkowski@linux.intel.com>
To: intel-gfx@lists.freedesktop.org
Subject: [PATCH i-g-t 1/3] lib/igt_core: Use HTML character for documentation comment in example
Date: Fri, 25 Aug 2017 18:25:05 +0300	[thread overview]
Message-ID: <20170825152507.22862-1-paul.kocialkowski@linux.intel.com> (raw)

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 <paul.kocialkowski@linux.intel.com>
---
 lib/igt_core.c | 6 +++---
 1 file changed, 3 insertions(+), 3 deletions(-)

diff --git a/lib/igt_core.c b/lib/igt_core.c
index 58d64dc2..c8753a6f 100644
--- a/lib/igt_core.c
+++ b/lib/igt_core.c
@@ -235,12 +235,12 @@
  * An example configuration follows:
  *
  * |[<!-- language="plain" -->
- *	# The common configuration secton follows.
+ *	&num; The common configuration secton 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.
+ *	&num; The following section is used for configuring the Device Under Test.
+ *	&num; It is not mandatory and allows overriding default values.
  *	[DUT]
  *	SuspendResumeDelay=10
  * ]|
-- 
2.14.0

_______________________________________________
Intel-gfx mailing list
Intel-gfx@lists.freedesktop.org
https://lists.freedesktop.org/mailman/listinfo/intel-gfx
