diff options
author | Milan Crha <mcrha@redhat.com> | 2018-11-05 11:57:25 +0100 |
---|---|---|
committer | Allen Winter <allen.winter@kdab.com> | 2018-11-11 18:55:46 -0500 |
commit | 153e2eb4d5990acfa9d46968ec1594bd9eee21fc (patch) | |
tree | 3736fd47212cebce86214bcdf0da0bb990e6cbe3 /doc | |
parent | 323996b2d1ea358f91c9d5f1db5060e5be6a9628 (diff) | |
download | libical-git-153e2eb4d5990acfa9d46968ec1594bd9eee21fc.tar.gz |
libical-glib documentation doesn't go through gtkdoc-scangobj
Using gtkdoc-scangobj adds also glib GObject hierarchy, properties and
signals into the documentation. This adds also an ENABLE_GTK_DOC option
which can be used to disable the gtk-doc usage explicitly, rather than
ignore the build when necessary binaries are not found. It also extracts
the commands into a GtkDoc.cmake module, rather than have it inline
on the place where it's used.
Diffstat (limited to 'doc')
-rw-r--r-- | doc/reference/libical-glib/CMakeLists.txt | 77 | ||||
-rw-r--r-- | doc/reference/libical-glib/libical-glib-docs.sgml.in (renamed from doc/reference/libical-glib/libical-glib-docs.xml.in) | 0 |
2 files changed, 11 insertions, 66 deletions
diff --git a/doc/reference/libical-glib/CMakeLists.txt b/doc/reference/libical-glib/CMakeLists.txt index 4013d570..e1a6a4eb 100644 --- a/doc/reference/libical-glib/CMakeLists.txt +++ b/doc/reference/libical-glib/CMakeLists.txt @@ -1,12 +1,4 @@ -find_program(GTKDOC_SCAN gtkdoc-scan DOC "a tool to scan header files for public symbols") -find_program(GTKDOC_MKDB gtkdoc-mkdb DOC "a tool to generate docbook files") -find_program(GTKDOC_MKHTML gtkdoc-mkhtml DOC "a tool to generate documentation in html format") -find_program(GTKDOC_FIXXREF gtkdoc-fixxref DOC "a tool to fix cross references in html files") - -if(NOT (GTKDOC_SCAN AND GTKDOC_MKDB AND GTKDOC_MKHTML AND GTKDOC_FIXXREF)) - message(WARNING "Cannot find all gtk-doc binaries, skipping API reference generation for libical-glib") - return() -endif() +include(GtkDoc) # To regenerate libical-glib-docs.xml.in from current sources use these steps: # a) delete ${CMAKE_CURRENT_BINARY_DIR}/libical-glib-docs.xml @@ -22,67 +14,20 @@ endif() # e) compare the changes in the file and return back what should be left, # like the replacement of the "[Insert title here]" and the <bookinfo/> content -configure_file( - ${CMAKE_CURRENT_SOURCE_DIR}/libical-glib-docs.xml.in - ${CMAKE_CURRENT_BINARY_DIR}/libical-glib-docs.xml - @ONLY -) - -set(OUTPUT_DOCDIR ${SHARE_INSTALL_DIR}/gtk-doc/html/libical-glib) - -add_custom_command(OUTPUT xml/libical-glib-doc.bottom - COMMAND ${GTKDOC_SCAN} --module=libical-glib - --source-dir="${CMAKE_BINARY_DIR}/src/libical-glib" - --deprecated-guards="LIBICAL_GLIB_DISABLE_DEPRECATED" - --ignore-headers=libical-glib-private.h - --rebuild-sections - --rebuild-types +if(ENABLE_GTK_DOC) - COMMAND ${GTKDOC_MKDB} - --module=libical-glib - --name-space=i-cal - --main-sgml-file="${CMAKE_CURRENT_BINARY_DIR}/libical-glib-docs.xml" - --xml-mode - --output-format=xml - --source-dir="${CMAKE_BINARY_DIR}/src/libical-glib" - COMMAND ${CMAKE_COMMAND} -E make_directory "${CMAKE_CURRENT_BINARY_DIR}/html" - DEPENDS "${CMAKE_CURRENT_BINARY_DIR}/libical-glib-docs.xml" -) - -if(APPLE) - add_custom_command(OUTPUT html/index.html - COMMAND env XML_CATALOG_FILES="/usr/local/etc/xml/catalog" ${GTKDOC_MKHTML} - --path=.. - libical-glib - ../libical-glib-docs.xml - WORKING_DIRECTORY "${CMAKE_CURRENT_BINARY_DIR}/html" - DEPENDS "${CMAKE_CURRENT_BINARY_DIR}/libical-glib-docs.xml" - "${CMAKE_CURRENT_BINARY_DIR}/xml/libical-glib-doc.bottom" - COMMENT "Generating libical-glib documentation" + set(SOURCEDIRS + ${CMAKE_BINARY_DIR}/src/libical-glib ) -else() - add_custom_command(OUTPUT html/index.html - COMMAND ${GTKDOC_MKHTML} - --path=.. - libical-glib - ../libical-glib-docs.xml - WORKING_DIRECTORY "${CMAKE_CURRENT_BINARY_DIR}/html" - DEPENDS "${CMAKE_CURRENT_BINARY_DIR}/libical-glib-docs.xml" - "${CMAKE_CURRENT_BINARY_DIR}/xml/libical-glib-doc.bottom" - COMMENT "Generating libical-glib documentation" + + set(DEPENDENCIES + ical-glib ) -endif() -add_custom_target(documentation ALL - COMMAND ${GTKDOC_FIXXREF} - --module=libical-glib - --module-dir=. - --extra-dir=.. - --html-dir=${OUTPUT_DOCDIR} - DEPENDS html/index.html - COMMENT "Generating libical-glib documentation" + set(IGNORE_HEADERS + libical-glib-private.h ) -add_dependencies(documentation ical-glib) + add_gtkdoc(libical-glib libical-glib "LIBICAL_GLIB_DISABLE_DEPRECATED" SOURCEDIRS DEPENDENCIES IGNORE_HEADERS) -install(DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}/html/ DESTINATION ${OUTPUT_DOCDIR}) +endif(ENABLE_GTK_DOC) diff --git a/doc/reference/libical-glib/libical-glib-docs.xml.in b/doc/reference/libical-glib/libical-glib-docs.sgml.in index b202e198..b202e198 100644 --- a/doc/reference/libical-glib/libical-glib-docs.xml.in +++ b/doc/reference/libical-glib/libical-glib-docs.sgml.in |