Files
cvc5/docs/api/java/CMakeLists.txt
mudathirmahgoub 2e2d6b623c Fix javadoc custom tag warning (#8502)
Fix this warning
Note: Custom tags that could override future standard tags:  @apiNote. To avoid potential overrides, use at least one period character (.) in custom tag names.
2022-04-01 09:33:14 +00:00

46 lines
1.6 KiB
CMake

###############################################################################
# Top contributors (to current version):
# Gereon Kremer
#
# This file is part of the cvc5 project.
#
# Copyright (c) 2009-2021 by the authors listed in the file AUTHORS
# in the top-level source directory and their institutional affiliations.
# All rights reserved. See the file COPYING in the top-level source
# directory for licensing information.
# #############################################################################
#
# Build system configuration for java API documentation.
#
add_custom_target(docs-java)
if(BUILD_BINDINGS_JAVA)
find_package(Java REQUIRED)
# put generated doc in a place where sphinx can easily copy from
set(JAVADOC_OUTPUT_DIR ${CMAKE_CURRENT_BINARY_DIR}/build/api/java)
# used to trigger the rebuild
set(JAVADOC_INDEX_FILE ${JAVADOC_OUTPUT_DIR}/index.html)
get_target_property(CVC5_JAR_FILE cvc5jar JAR_FILE)
add_custom_command(
OUTPUT ${JAVADOC_INDEX_FILE}
COMMAND
${Java_JAVADOC_EXECUTABLE} io.github.cvc5
-sourcepath ${CMAKE_SOURCE_DIR}/src/api/java/:${CMAKE_BINARY_DIR}/src/api/java/
-d ${JAVADOC_OUTPUT_DIR}
-cp ${CVC5_JAR_FILE}
-tag "api.note:a:Note:"
-notimestamp
COMMAND find ${JAVADOC_OUTPUT_DIR} -type f -exec sed -i'orig' 's/<!-- Generated by javadoc [^>]* -->//' {} "\;"
COMMAND find ${SPHINX_GH_OUTPUT_DIR} -name '*orig' -delete
DEPENDS cvc5jar ${CVC5_JAR_FILE}
COMMENT "Generating javadocs"
)
add_custom_target(docs-java-javadoc DEPENDS ${JAVADOC_INDEX_FILE})
add_dependencies(docs-java docs-java-javadoc)
endif()