Merge lp:~midori/midori/gtkdoc into lp:midori

[Cris Dywan]

Add USE_APIDOCS to build API docs with CMake

[Cris Dywan (kalikiana)]

gtkdoc is a bitch… I kind got it to build something incomplete once, but then it started failing again in unexpected ways. And there's a ton of error messages.

[Paweł Forysiuk (tuxator)]

review: Approve

=== modified file 'CMakeLists.txt'
--- CMakeLists.txt	2013-09-26 22:40:31 +0000
+++ CMakeLists.txt	2013-09-27 16:43:59 +0000
@@ -134,6 +134,7 @@
 option(HALF_BRO_INCOM_WEBKIT2 "Serve as a guniea pig" OFF)
 option(USE_ZEITGEIST "Zeitgeist history integration" ON)
 option(USE_GRANITE "Fancy notebook and pop-overs" OFF)
+option(USE_APIDOCS "API documentation" OFF)
 
 if (USE_GRANITE)
     if (NOT USE_GTK3 AND NOT HALF_BRO_INCOM_WEBKIT2)
@@ -240,3 +241,7 @@
 enable_testing()
 add_subdirectory (tests)
 add_subdirectory (extensions)
+
+if (USE_APIDOCS)
+    add_subdirectory (docs/api)
+endif ()

=== added file 'cmake/GtkDoc.cmake'
--- cmake/GtkDoc.cmake	1970-01-01 00:00:00 +0000
+++ cmake/GtkDoc.cmake	2013-09-27 16:43:59 +0000
@@ -0,0 +1,61 @@
+# GtkDoc.cmake
+#
+# Macros for building Midori API documentation.
+# Copyright (C) 2013 Olivier Duchateau
+
+find_program (GTKDOC_SCAN_BIN gtkdoc-scan)
+find_program (GTKDOC_MKDB_BIN gtkdoc-mkdb)
+find_program (GTKDOC_MKHTML_BIN gtkdoc-mkhtml)
+find_program (GTKDOC_MKTMPL_BIN gtkdoc-mktmpl)
+
+if (GTKDOC_SCAN_BIN AND GTKDOC_MKTMPL_BIN AND GTKDOC_MKDB_BIN
+        AND GTKDOC_MKHTML_BIN)
+
+    set (GTKDOC_FOUND TRUE)
+
+    macro (gtkdoc_build module)
+        message("gtkdoc: module ${module}")
+        # file (MAKE_DIRECTORY "${CMAKE_CURRENT_BINARY_DIR}/${module}")
+        add_custom_target ("gtkdoc-scan_${module}" ALL
+            ${GTKDOC_SCAN_BIN} --module=${module}
+                --source-dir="${CMAKE_SOURCE_DIR}/${module}"
+                --output-dir="${CMAKE_CURRENT_BINARY_DIR}/${module}"
+                --rebuild-sections --rebuild-types
+                WORKING_DIRECTORY "${CMAKE_CURRENT_BINARY_DIR}")
+
+        add_custom_target ("gtkdoc-tmpl_${module}" ALL
+            ${GTKDOC_MKTMPL_BIN} --module=${module}
+            --output-dir="${CMAKE_CURRENT_BINARY_DIR}"
+            WORKING_DIRECTORY "${CMAKE_CURRENT_BINARY_DIR}/${module}"
+            DEPENDS "gtkdoc-scan_${module}")
+
+        add_custom_target ("gtkdoc-docbook_${module}" ALL
+            ${GTKDOC_MKDB_BIN} --module=${module}
+                --output-dir="xml"
+                --source-dir="${CMAKE_SOURCE_DIR}/${module}"
+                --source-suffixes=c,h --output-format=xml
+                --default-includes=${module}/${module}.h
+                --sgml-mode --main-sgml-file=${module}.sgml
+            WORKING_DIRECTORY "${CMAKE_CURRENT_BINARY_DIR}/${module}"
+            DEPENDS "gtkdoc-tmpl_${module}")
+
+        # Keep this target alone, otherwise build fails
+        add_custom_target ("gtkdoc-html_${module}" ALL
+            ${GTKDOC_MKHTML_BIN} ${module}
+            "${CMAKE_CURRENT_BINARY_DIR}/${module}/${module}.sgml"
+            WORKING_DIRECTORY "${CMAKE_CURRENT_BINARY_DIR}/${module}/html"
+            DEPENDS "gtkdoc-docbook_${module}")
+
+    endmacro (gtkdoc_build module)
+
+    macro (gtkdoc module)
+        file (MAKE_DIRECTORY "${CMAKE_CURRENT_BINARY_DIR}/${module}/html")
+        gtkdoc_build (${module})
+
+        set (DOC_DIR "html/midori-${MIDORI_MAJOR_VERSION}-${MIDORI_MINOR_VERSION}")
+        install (DIRECTORY "${CMAKE_CURRENT_BINARY_DIR}/${module}/html/"
+            DESTINATION "${CMAKE_INSTALL_DATADIR}/gtk-doc/${DOC_DIR}/${module}"
+            PATTERN "html/*"
+            PATTERN "index.sgml" EXCLUDE)
+    endmacro (gtkdoc module)
+endif ()

=== added file 'docs/api/CMakeLists.txt'
--- docs/api/CMakeLists.txt	1970-01-01 00:00:00 +0000
+++ docs/api/CMakeLists.txt	2013-09-27 16:43:59 +0000
@@ -0,0 +1,14 @@
+# Copyright (C) 2013 Olivier Duchateau
+
+include (GtkDoc)
+
+if (GTKDOC_FOUND)
+    list (APPEND MODULES "katze" "midori")
+    foreach (MOD ${MODULES})
+        if (EXISTS "${CMAKE_SOURCE_DIR}/${MOD}")
+            gtkdoc (${MOD})
+        endif ()
+    endforeach ()
+else ()
+    message (FATAL_ERROR "gtk-doc not found")
+endif ()