include: Add basic documentation for vkd3d_types.h.

This is built on Doxygen. I'm not personally attached to Doxygen, but it was
easy enough to set up and write for, and I've found its compiled HTML to be
reasonably legible.

Note that Doxygen does allow for specifying documentation in external files,
if keeping the documentation out of the header is desired.

Signed-off-by: Zebediah Figura <z.figura12@gmail.com>
Signed-off-by: Henri Verbeet <hverbeet@codeweavers.com>
Signed-off-by: Alexandre Julliard <julliard@winehq.org>
This commit is contained in:
Zebediah Figura
2020-09-01 10:32:29 -05:00
committed by Alexandre Julliard
parent f895f0dce6
commit 83c67e76ff
6 changed files with 633 additions and 1 deletions

17
Doxyfile.in Normal file
View File

@@ -0,0 +1,17 @@
# Doxyfile 1.8.18
DOXYFILE_ENCODING = UTF-8
PROJECT_NAME = @PACKAGE_NAME@
PROJECT_NUMBER = @PACKAGE_VERSION@
PROJECT_BRIEF = "The vkd3d 3D Graphics Library"
OUTPUT_DIRECTORY = doc
JAVADOC_AUTOBRIEF = YES
OPTIMIZE_OUTPUT_FOR_C = YES
EXTRACT_STATIC = YES
INPUT = @srcdir@/include/vkd3d.h \
@srcdir@/include/vkd3d_shader.h \
@srcdir@/include/vkd3d_types.h \
@srcdir@/include/vkd3d_utils.h
EXCLUDE_SYMBOLS = VKD3D_FORCE_32_BIT_ENUM