15 Commits

Author SHA1 Message Date
Thomas Wood
fa24ce6b96 docs: add igt_edid_template.h to IGNORE_HFILES
Signed-off-by: Thomas Wood <thomas.wood@intel.com>
2015-12-21 17:09:19 +00:00
Thomas Wood
b3ff112326 docs: exclude gpgpu_fill.h
gpgpu_fill.h is only used internally by the library.

Signed-off-by: Thomas Wood <thomas.wood@intel.com>
2015-12-02 15:02:52 +00:00
Thomas Wood
6141aa2dad docs: various documentation fixes
Fix various typos, add missing parameter documentation, include the
igt_draw section and update the list of ignored headers.

Signed-off-by: Thomas Wood <thomas.wood@intel.com>
2015-05-14 17:00:40 +01:00
Thomas Wood
5b7edb9cb0 docs: avoid escaping characters in documentation comments
Avoid having to escape certain characters in documentation comments by
not allowing docbook markup tags. Markdown formatting in documentation
comments is still supported.

Signed-off-by: Thomas Wood <thomas.wood@intel.com>
2015-04-21 10:52:14 +01:00
Thomas Wood
e72686b83b tests: create a single combined test list
All tests now respond in a consistent way such that separate lists for
tests with and without subtests are no longer necessary.

v2: fix other references to the test list

Signed-off-by: Thomas Wood <thomas.wood@intel.com>
2015-04-14 17:43:05 +01:00
Thomas Wood
0c4dd28d2d docs: limit the number of subtests listed
Avoid producing long lists of subtests in the documentation and instead
provide instructions on how to obtain the full list.

Signed-off-by: Thomas Wood <thomas.wood@intel.com>
2015-03-26 15:50:41 +00:00
Daniel Vetter
25c4347078 doc: Consolidate naming conventions into docbook
Duplication just means it gets out of sync.

Also update they keyword list in the Makefile, not everything was listed.
And add a new "invalid" keyword.

While at it update NEWS.

Signed-off-by: Daniel Vetter <daniel.vetter@ffwll.ch>
2015-02-13 09:35:36 +01:00
Thomas Wood
029dee7979 docs: treat the test description as cdata
Enclose the test description in cdata tags since the test descriptions
come from the tests themselves and may not be escaped for use in xml.

Signed-off-by: Thomas Wood <thomas.wood@intel.com>
2014-12-04 16:07:55 +00:00
Thomas Wood
a5425a101c docs: add a glossary of test name terms
Add a glossary of test name terms based on the details in
tests/NAMING-CONVENTION.

Signed-off-by: Thomas Wood <thomas.wood@intel.com>
2014-12-04 16:07:55 +00:00
Thomas Wood
e4e18faffc docs: add subtest lists to test descriptions
Signed-off-by: Thomas Wood <thomas.wood@intel.com>
2014-12-04 16:07:55 +00:00
Thomas Wood
7d2ab7083b docs: split the test program documentation into sections
Signed-off-by: Thomas Wood <thomas.wood@intel.com>
2014-12-04 16:07:55 +00:00
Thomas Wood
98188b4b41 docs: include descriptions for the test programs
v2: fix various distcheck issues

Signed-off-by: Thomas Wood <thomas.wood@intel.com>
2014-11-06 13:24:30 +00:00
Thomas Wood
cd714f93e8 docs: always rebuild the sections file
Always rebuild the sections file since it currently doesn't contain any
custom modifications.

Signed-off-by: Thomas Wood <thomas.wood@intel.com>
2014-06-12 10:12:13 +01:00
Thomas Wood
bbd014e163 docs: add private headers to IGNORE_HFILES
Signed-off-by: Thomas Wood <thomas.wood@intel.com>
2014-06-12 10:12:13 +01:00
Thomas Wood
14ea2a04eb Add API documentation support
Add optional support for building API documentation using gtk-doc.

Signed-off-by: Thomas Wood <thomas.wood@intel.com>
Signed-off-by: Daniel Vetter <daniel.vetter@ffwll.ch>
2014-03-11 17:19:47 +01:00