xref: /aosp_15_r20/external/ot-br-posix/doc/CMakeLists.txt (revision 4a64e381480ef79f0532b2421e44e6ee336b8e0d)
1#
2#  Copyright (c) 2021, The OpenThread Authors.
3#  All rights reserved.
4#
5#  Redistribution and use in source and binary forms, with or without
6#  modification, are permitted provided that the following conditions are met:
7#  1. Redistributions of source code must retain the above copyright
8#     notice, this list of conditions and the following disclaimer.
9#  2. Redistributions in binary form must reproduce the above copyright
10#     notice, this list of conditions and the following disclaimer in the
11#     documentation and/or other materials provided with the distribution.
12#  3. Neither the name of the copyright holder nor the
13#     names of its contributors may be used to endorse or promote products
14#     derived from this software without specific prior written permission.
15#
16#  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
17#  AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
18#  IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
19#  ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
20#  LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
21#  CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
22#  SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
23#  INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
24#  CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
25#  ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
26#  POSSIBILITY OF SUCH DAMAGE.
27#
28
29find_package(Doxygen)
30
31if (DOXYGEN_FOUND)
32    set(DOXYGEN_IN ${CMAKE_CURRENT_SOURCE_DIR}/Doxyfile.in)
33    set(DOXYGEN_OUT ${CMAKE_CURRENT_BINARY_DIR}/Doxyfile)
34
35    configure_file(${DOXYGEN_IN} ${DOXYGEN_OUT} @ONLY)
36    message("Doxygen build started")
37
38    add_custom_target(otbr-doc)
39
40    add_custom_target(doxygen ALL
41        COMMAND ${DOXYGEN_EXECUTABLE} ${DOXYGEN_OUT}
42        WORKING_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}
43        COMMENT "Generating documentation with Doxygen"
44        VERBATIM)
45    add_dependencies(otbr-doc doxygen)
46
47    if(OTBR_DBUS)
48        set(DBUS_DOC_SRC ${CMAKE_BINARY_DIR}/src/dbus/server/index.html)
49        set(DBUS_DOC_TARGET ${CMAKE_CURRENT_BINARY_DIR}/html/dbus-api.html)
50        add_custom_target(otbr-dbus-server-doc-copy ALL
51            COMMAND cp ${DBUS_DOC_SRC} ${DBUS_DOC_TARGET}
52            VERBATIM
53        )
54        add_dependencies(otbr-dbus-server-doc-copy doxygen otbr-dbus-server-doc)
55        add_dependencies(otbr-doc otbr-dbus-server-doc-copy)
56    endif()
57else()
58    message("Doxygen must be installed to generate doxygen documentation")
59endif()
60