From 1ed28fbdfde938dff9a13ede17d11486de3638b1 Mon Sep 17 00:00:00 2001 From: Ben Clayton Date: Mon, 11 Apr 2022 22:27:34 +0000 Subject: [PATCH] tint: Re-enable doxygen Remove the default override for TINT_BUILD_DOCS. Update the Doxyfile to only consider Tint. Re-enable Kokoro checks. Fixed: tint:1498 Bug: dawn:1339 Change-Id: I8bf5d7085452b42a6ed564c0f86ed7cbd85128b0 Reviewed-on: https://dawn-review.googlesource.com/c/dawn/+/86381 Kokoro-Run: Ben Clayton Reviewed-by: Ryan Harrison Kokoro: Kokoro Commit-Queue: Ben Clayton --- CMakeLists.txt | 3 --- Doxyfile | 7 ++----- infra/kokoro/linux/docker.sh | 22 ++++++++++------------ 3 files changed, 12 insertions(+), 20 deletions(-) diff --git a/CMakeLists.txt b/CMakeLists.txt index 2d7d0eedc3..73554e9388 100644 --- a/CMakeLists.txt +++ b/CMakeLists.txt @@ -258,9 +258,6 @@ else() set(TINT_BUILD_TESTS_DEFAULT ON) endif() -# Forcing building docs off right now, since currently this will try to build docs for both Tint & Dawn, and Dawn isn't annotated yet. -set(TINT_BUILD_DOCS_DEFAULT OFF) - option_if_not_defined(TINT_BUILD_SAMPLES "Build samples" ON) option_if_not_defined(TINT_BUILD_DOCS "Build documentation" ${TINT_BUILD_DOCS_DEFAULT}) option_if_not_defined(TINT_DOCS_WARN_AS_ERROR "When building documentation, treat warnings as errors" OFF) diff --git a/Doxyfile b/Doxyfile index 08eac608fb..c28c2680e5 100644 --- a/Doxyfile +++ b/Doxyfile @@ -786,11 +786,8 @@ WARN_LOGFILE = # Note: If this tag is empty the current directory is searched. INPUT = CODE_OF_CONDUCT.md \ - src/tint/fuzzers/tint_spirv_tools_fuzzer \ - src \ - tools/src \ - src/tint/fuzzers/tint_spirv_tools_fuzzer \ - src/tint/fuzzers/tint_ast_fuzzer + src/tint \ + tools/src # This tag can be used to specify the character encoding of the source files # that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses diff --git a/infra/kokoro/linux/docker.sh b/infra/kokoro/linux/docker.sh index 87184a8c44..46804f9b61 100755 --- a/infra/kokoro/linux/docker.sh +++ b/infra/kokoro/linux/docker.sh @@ -139,18 +139,16 @@ if [ "$BUILD_SYSTEM" == "cmake" ]; then cd ${BUILD_DIR} - # TODO(crbug.com/tint/1498): Doxygen is currently disabled. - # - # status "Running Doxygen" - # echo "NOTE: This will fail on first warning. Run with -DTINT_DOCS_WARN_AS_ERROR=OFF to see all warnings". - # echo "" - # show_cmds - # # NOTE: If we upgrade Doxygen to a more recent version, we can set DOXYGEN_WARN_AS_ERROR to - # # "FAIL_ON_WARNINGS" instead of "YES" in our CMakeLists.txt so see all warnings, and then - # # fail. See https://www.doxygen.nl/manual/config.html#cfg_warn_as_error - # cmake ${SRC_DIR} ${CMAKE_FLAGS} ${COMMON_CMAKE_FLAGS} - # cmake --build . --target tint-docs - # hide_cmds + status "Running Doxygen" + echo "NOTE: This will fail on first warning. Run with -DTINT_DOCS_WARN_AS_ERROR=OFF to see all warnings". + echo "" + show_cmds + # NOTE: If we upgrade Doxygen to a more recent version, we can set DOXYGEN_WARN_AS_ERROR to + # "FAIL_ON_WARNINGS" instead of "YES" in our CMakeLists.txt so see all warnings, and then + # fail. See https://www.doxygen.nl/manual/config.html#cfg_warn_as_error + cmake ${SRC_DIR} ${CMAKE_FLAGS} ${COMMON_CMAKE_FLAGS} + cmake --build . --target tint-docs + hide_cmds status "Building dawn in '${BUILD_DIR}'" show_cmds