diff options
| author | Paul Kocialkowski <paul.kocialkowski@linux.intel.com> | 2017-08-28 11:12:03 +0300 |
|---|---|---|
| committer | Lyude <lyude@redhat.com> | 2017-08-28 15:47:14 -0400 |
| commit | 73a3b0b1d973c7e55419f9a3890cd68c6ac130da (patch) | |
| tree | 47eef310f8ccebd50cf3cdae1267feca347f46ce /lib/igt_core.c | |
| parent | 60f6a12195395934f179d5ecc080353190d19a6c (diff) | |
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 <paul.kocialkowski@linux.intel.com>
(with one small typo fixed)
Reviewed-by: Lyude Paul <lyude@redhat.com>
Diffstat (limited to 'lib/igt_core.c')
| -rw-r--r-- | lib/igt_core.c | 6 |
1 files changed, 3 insertions, 3 deletions
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: * * |[<!-- language="plain" --> - * # 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 * ]| |