2018-11-20 14:06:17 +01:00
|
|
|
#
|
|
|
|
|
# api documentation
|
|
|
|
|
#
|
2007-03-14 00:16:05 +00:00
|
|
|
find_package(Doxygen)
|
|
|
|
|
|
2018-11-20 13:56:39 +01:00
|
|
|
# build doc always
|
|
|
|
|
add_custom_target(doc ALL)
|
|
|
|
|
|
2007-03-14 00:16:05 +00:00
|
|
|
if(DOXYGEN_EXECUTABLE)
|
2019-01-24 08:09:52 +01:00
|
|
|
option(DBUS_ENABLE_DOXYGEN_DOCS "build DOXYGEN documentation (requires Doxygen)" ON)
|
2019-01-24 08:12:19 +01:00
|
|
|
endif()
|
2007-03-14 00:16:05 +00:00
|
|
|
|
2019-01-24 08:11:00 +01:00
|
|
|
if(DBUS_ENABLE_DOXYGEN_DOCS)
|
|
|
|
|
set(top_srcdir ${CMAKE_SOURCE_DIR})
|
2019-01-10 19:42:52 +01:00
|
|
|
configure_file(../Doxyfile.in ${CMAKE_BINARY_DIR}/Doxyfile )
|
2018-11-16 23:01:03 +01:00
|
|
|
add_custom_command(
|
|
|
|
|
OUTPUT ${CMAKE_CURRENT_BINARY_DIR}/api/html/index.html
|
2007-03-14 00:16:05 +00:00
|
|
|
COMMAND ${DOXYGEN_EXECUTABLE} ${CMAKE_BINARY_DIR}/Doxyfile
|
2013-06-20 16:46:15 +02:00
|
|
|
WORKING_DIRECTORY ${CMAKE_BINARY_DIR}
|
2007-03-14 00:16:05 +00:00
|
|
|
)
|
2018-11-20 13:56:39 +01:00
|
|
|
add_custom_target(apidoc
|
|
|
|
|
COMMAND ${DOXYGEN_EXECUTABLE} ${CMAKE_BINARY_DIR}/Doxyfile
|
|
|
|
|
WORKING_DIRECTORY ${CMAKE_BINARY_DIR}
|
|
|
|
|
)
|
|
|
|
|
add_dependencies(doc apidoc)
|
|
|
|
|
add_custom_target(devhelp2
|
2018-11-16 23:01:03 +01:00
|
|
|
DEPENDS ${CMAKE_CURRENT_BINARY_DIR}/api/html/index.html ${CMAKE_CURRENT_BINARY_DIR}/dbus.devhelp2
|
|
|
|
|
)
|
2018-11-20 13:56:39 +01:00
|
|
|
add_dependencies(doc devhelp2)
|
2019-01-15 11:56:36 +01:00
|
|
|
install(DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}/api/html/ DESTINATION ${CMAKE_INSTALL_DATADIR}/doc/dbus/api)
|
2019-01-24 08:12:19 +01:00
|
|
|
endif()
|
2007-03-15 12:10:07 +00:00
|
|
|
|
2018-11-16 23:01:03 +01:00
|
|
|
find_program(XSLTPROC_EXECUTABLE xsltproc)
|
|
|
|
|
if(XSLTPROC_EXECUTABLE)
|
|
|
|
|
message(STATUS "${XSLTPROC_EXECUTABLE} found")
|
|
|
|
|
set(DBUS_HAVE_XSLTPROC 1)
|
|
|
|
|
endif()
|
|
|
|
|
|
|
|
|
|
if(DBUS_HAVE_XSLTPROC)
|
|
|
|
|
add_custom_command(
|
|
|
|
|
OUTPUT dbus.devhelp2
|
2019-01-10 19:42:52 +01:00
|
|
|
COMMAND ${XSLTPROC_EXECUTABLE} -o dbus.devhelp2 ${CMAKE_CURRENT_SOURCE_DIR}/doxygen_to_devhelp.xsl api/xml/index.xml
|
|
|
|
|
DEPENDS doxygen_to_devhelp.xsl api/html/index.html
|
2018-11-16 23:01:03 +01:00
|
|
|
WORKING_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}
|
|
|
|
|
)
|
2019-01-15 11:56:36 +01:00
|
|
|
install(FILES ${CMAKE_CURRENT_BINARY_DIR}/dbus.devhelp2 DESTINATION ${CMAKE_INSTALL_DATADIR}/doc/dbus)
|
2018-11-16 23:01:03 +01:00
|
|
|
endif()
|
|
|
|
|
|
2010-02-10 09:26:52 +01:00
|
|
|
#
|
2018-11-20 14:06:17 +01:00
|
|
|
# docbook based documentation
|
2010-02-10 09:26:52 +01:00
|
|
|
#
|
2018-11-20 14:06:17 +01:00
|
|
|
find_package(DocBookXSL)
|
|
|
|
|
|
|
|
|
|
if(DOCBOOKXSL_DIR AND XSLTPROC_EXECUTABLE)
|
|
|
|
|
option(DBUS_ENABLE_XML_DOCS "build XML documentation" ON)
|
|
|
|
|
set(DBUS_XML_DOCS_ENABLED 1)
|
|
|
|
|
message(STATUS "xsltproc docbook generator found")
|
|
|
|
|
add_custom_target(xmldoc)
|
|
|
|
|
add_dependencies(doc xmldoc)
|
|
|
|
|
endif()
|
|
|
|
|
|
|
|
|
|
if(DBUS_ENABLE_XML_DOCS)
|
|
|
|
|
|
|
|
|
|
macro(DOCBOOK _sources _format)
|
|
|
|
|
get_filename_component(_infile ${_sources} ABSOLUTE)
|
|
|
|
|
get_filename_component(_name ${_infile} NAME)
|
|
|
|
|
if(${_format} STREQUAL "man")
|
|
|
|
|
string(REPLACE ".xml" "" _outname ${_name})
|
|
|
|
|
set(STYLESHEET "${DOCBOOKXSL_DIR}/manpages/docbook.xsl")
|
|
|
|
|
else()
|
|
|
|
|
string(REPLACE ".xml" ".html" _outname ${_name})
|
|
|
|
|
set(STYLESHEET "${DOCBOOKXSL_DIR}/html/docbook.xsl")
|
|
|
|
|
endif()
|
|
|
|
|
set(_outfile ${CMAKE_CURRENT_BINARY_DIR}/${_outname})
|
|
|
|
|
if(EXISTS ${_sources})
|
|
|
|
|
if(XSLTPROC_EXECUTABLE)
|
|
|
|
|
add_custom_target(${_outname}
|
|
|
|
|
${XSLTPROC_EXECUTABLE} --output ${_outfile} --nonet --xinclude --param passivetex.extensions '1' ${STYLESHEET} ${_infile}
|
|
|
|
|
DEPENDS ${_infile}
|
|
|
|
|
WORKING_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}
|
|
|
|
|
)
|
2019-01-24 08:11:00 +01:00
|
|
|
endif()
|
2018-11-20 14:06:17 +01:00
|
|
|
add_dependencies(xmldoc ${_outname})
|
2019-01-24 08:11:00 +01:00
|
|
|
if(${_format} STREQUAL "man")
|
2018-12-21 19:36:37 +01:00
|
|
|
install(FILES ${_outfile} DESTINATION ${CMAKE_INSTALL_DATADIR}/man/man1)
|
2018-11-20 14:06:17 +01:00
|
|
|
else()
|
2018-12-21 19:36:37 +01:00
|
|
|
install(FILES ${_outfile} DESTINATION ${CMAKE_INSTALL_DATADIR}/doc/dbus)
|
2018-11-20 14:06:17 +01:00
|
|
|
endif()
|
|
|
|
|
else()
|
|
|
|
|
message(STATUS "skipping xml doc generating for ${_infile}, file not found")
|
|
|
|
|
endif()
|
2019-01-24 08:12:19 +01:00
|
|
|
endmacro()
|
2007-03-15 12:10:07 +00:00
|
|
|
|
|
|
|
|
### copy tests to builddir so that generated tests and static tests
|
|
|
|
|
### are all in one place.
|
|
|
|
|
### todo how to add more filetypes
|
2019-01-24 08:09:52 +01:00
|
|
|
macro(COPYDIR _src _type)
|
|
|
|
|
foreach(FILE_TYPE ${_type})
|
|
|
|
|
foreach(DIR ${_src})
|
|
|
|
|
file(GLOB FILES "${DIR}/${FILE_TYPE}" )
|
|
|
|
|
file(MAKE_DIRECTORY ${CMAKE_BINARY_DIR}/${DIR})
|
|
|
|
|
foreach(FILE ${FILES})
|
|
|
|
|
get_filename_component(FILENAME ${FILE} NAME)
|
|
|
|
|
set(TARGET ${CMAKE_BINARY_DIR}/${DIR}/${FILENAME})
|
2019-01-24 08:08:41 +01:00
|
|
|
configure_file(${FILE} ${TARGET} COPYONLY)
|
2019-01-24 08:09:52 +01:00
|
|
|
if(CONFIG_VERBOSE)
|
|
|
|
|
message("FROM: ${FILE}\nTO: ${TARGET}\n")
|
2019-01-24 08:12:19 +01:00
|
|
|
endif()
|
|
|
|
|
endforeach()
|
|
|
|
|
endforeach()
|
|
|
|
|
endforeach()
|
|
|
|
|
endmacro()
|
2007-03-15 12:10:07 +00:00
|
|
|
|
|
|
|
|
COPYDIR(doc *.png)
|
|
|
|
|
COPYDIR(doc *.svg)
|
|
|
|
|
|
2019-01-10 19:42:52 +01:00
|
|
|
docbook(${CMAKE_CURRENT_SOURCE_DIR}/dbus-test-plan.xml html)
|
|
|
|
|
docbook(${CMAKE_CURRENT_SOURCE_DIR}/dbus-tutorial.xml html)
|
|
|
|
|
docbook(${CMAKE_CURRENT_SOURCE_DIR}/dbus-specification.xml html)
|
|
|
|
|
docbook(${CMAKE_CURRENT_SOURCE_DIR}/dbus-faq.xml html)
|
|
|
|
|
|
|
|
|
|
configure_file(dbus-cleanup-sockets.1.xml.in ${CMAKE_CURRENT_BINARY_DIR}/dbus-cleanup-sockets.1.xml)
|
|
|
|
|
configure_file(dbus-daemon.1.xml.in ${CMAKE_CURRENT_BINARY_DIR}/dbus-daemon.1.xml)
|
|
|
|
|
configure_file(dbus-launch.1.xml.in ${CMAKE_CURRENT_BINARY_DIR}/dbus-launch.1.xml)
|
|
|
|
|
configure_file(dbus-monitor.1.xml.in ${CMAKE_CURRENT_BINARY_DIR}/dbus-monitor.1.xml)
|
|
|
|
|
configure_file(dbus-send.1.xml.in ${CMAKE_CURRENT_BINARY_DIR}/dbus-send.1.xml)
|
|
|
|
|
configure_file(dbus-test-tool.1.xml.in ${CMAKE_CURRENT_BINARY_DIR}/dbus-test-tool.1.xml)
|
|
|
|
|
configure_file(dbus-update-activation-environment.1.xml.in ${CMAKE_CURRENT_BINARY_DIR}/dbus-update-activation-environment.1.xml)
|
|
|
|
|
configure_file(dbus-uuidgen.1.xml.in ${CMAKE_CURRENT_BINARY_DIR}/dbus-uuidgen.1.xml)
|
2018-11-20 14:06:17 +01:00
|
|
|
if(UNIX)
|
2019-01-10 19:42:52 +01:00
|
|
|
docbook(${CMAKE_CURRENT_BINARY_DIR}/dbus-daemon.1.xml man)
|
|
|
|
|
docbook(${CMAKE_CURRENT_BINARY_DIR}/dbus-monitor.1.xml man)
|
|
|
|
|
docbook(${CMAKE_CURRENT_BINARY_DIR}/dbus-send.1.xml man)
|
|
|
|
|
docbook(${CMAKE_CURRENT_BINARY_DIR}/dbus-test-tool.1.xml man)
|
|
|
|
|
docbook(${CMAKE_CURRENT_BINARY_DIR}/dbus-launch.1.xml man)
|
|
|
|
|
docbook(${CMAKE_CURRENT_BINARY_DIR}/dbus-uuidgen.1.xml man)
|
|
|
|
|
docbook(${CMAKE_CURRENT_BINARY_DIR}/dbus-cleanup-sockets.1.xml man)
|
|
|
|
|
docbook(${CMAKE_CURRENT_BINARY_DIR}/dbus-update-activation-environment.1.xml man)
|
2013-02-05 03:10:59 +01:00
|
|
|
endif()
|
2019-01-10 19:42:52 +01:00
|
|
|
docbook(${CMAKE_CURRENT_BINARY_DIR}/dbus-daemon.1.xml html)
|
|
|
|
|
docbook(${CMAKE_CURRENT_BINARY_DIR}/dbus-monitor.1.xml html)
|
|
|
|
|
docbook(${CMAKE_CURRENT_BINARY_DIR}/dbus-send.1.xml html)
|
|
|
|
|
docbook(${CMAKE_CURRENT_BINARY_DIR}/dbus-test-tool.1.xml html)
|
|
|
|
|
docbook(${CMAKE_CURRENT_BINARY_DIR}/dbus-launch.1.xml html)
|
|
|
|
|
docbook(${CMAKE_CURRENT_BINARY_DIR}/dbus-uuidgen.1.xml html)
|
|
|
|
|
docbook(${CMAKE_CURRENT_BINARY_DIR}/dbus-cleanup-sockets.1.xml html)
|
|
|
|
|
docbook(${CMAKE_CURRENT_BINARY_DIR}/dbus-update-activation-environment.1.xml html)
|
2018-11-20 14:06:17 +01:00
|
|
|
|
2010-02-10 09:26:52 +01:00
|
|
|
#
|
|
|
|
|
# handle html index file
|
|
|
|
|
#
|
2019-01-15 11:56:14 +01:00
|
|
|
configure_file(index.html.in ${CMAKE_CURRENT_BINARY_DIR}/index.html)
|
2018-12-21 19:36:37 +01:00
|
|
|
install(FILES ${CMAKE_CURRENT_BINARY_DIR}/index.html DESTINATION ${CMAKE_INSTALL_DATADIR}/doc/dbus)
|
2010-02-10 09:26:52 +01:00
|
|
|
|
2019-01-24 08:11:00 +01:00
|
|
|
set(EXTRA_DIST
|
2019-01-10 19:42:52 +01:00
|
|
|
busconfig.dtd
|
|
|
|
|
introspect.dtd
|
|
|
|
|
introspect.xsl
|
2010-02-10 09:26:52 +01:00
|
|
|
)
|
|
|
|
|
|
2018-12-21 19:36:37 +01:00
|
|
|
install(FILES ${EXTRA_DIST} DESTINATION ${CMAKE_INSTALL_DATADIR}/doc/dbus)
|
2007-03-15 12:10:07 +00:00
|
|
|
|
2018-11-20 14:06:17 +01:00
|
|
|
endif()
|