wine/vkd3d
0
0
Fork 0
mirror of https://gitlab.winehq.org/wine/vkd3d.git synced 2024-09-13 09:16:14 -07:00
Code Issues Packages Projects Releases Wiki Activity
47981def0d
vkd3d/Doxyfile.in

22 lines
696 B
Plaintext
Raw Normal View History

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>
2020-09-01 08:32:29 -07:00
# 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
build: Make doxygen output slightly less verbose. There is perhaps a bit of a trade-off involved here, but with the current state of things it's fairly hard to notice unexpected issues in the output.
2023-11-13 04:45:13 -08:00
QUIET = YES
WARN_IF_UNDOCUMENTED = NO
build: Do not warn on incomplete documentation. Some functions in vkd3d_utils.h are altered versions of Windows functions, and only the vkd3d-specific parts need documentation.
2024-09-04 16:29:26 -07:00
WARN_IF_INCOMPLETE_DOC = NO
build: Make doxygen output slightly less verbose. There is perhaps a bit of a trade-off involved here, but with the current state of things it's fairly hard to notice unexpected issues in the output.
2023-11-13 04:45:13 -08:00
LATEX_BATCHMODE = YES
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>
2020-09-01 08:32:29 -07:00
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
Reference in New Issue Copy Permalink