summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
Diffstat (limited to 'docs')
-rw-r--r--docs/reference/CMakeLists.txt187
-rw-r--r--docs/reference/camel-docs.sgml.in (renamed from docs/reference/camel/camel-docs.sgml.in)4
-rw-r--r--docs/reference/camel/CMakeLists.txt41
-rw-r--r--docs/reference/evolution-data-server-docs.sgml.in (renamed from docs/reference/evolution-data-server/evolution-data-server-docs.sgml.in)8
-rw-r--r--docs/reference/evolution-data-server/CMakeLists.txt46
-rw-r--r--docs/reference/image-sources/cursor-alphabetic-indexes.odg (renamed from docs/reference/evolution-data-server/image-sources/cursor-alphabetic-indexes.odg)bin17856 -> 17856 bytes
-rw-r--r--docs/reference/image-sources/cursor-positions-filtered.odg (renamed from docs/reference/evolution-data-server/image-sources/cursor-positions-filtered.odg)bin19396 -> 19396 bytes
-rw-r--r--docs/reference/image-sources/cursor-positions-step.odg (renamed from docs/reference/evolution-data-server/image-sources/cursor-positions-step.odg)bin22688 -> 22688 bytes
-rw-r--r--docs/reference/image-sources/cursor-positions.odg (renamed from docs/reference/evolution-data-server/image-sources/cursor-positions.odg)bin17473 -> 17473 bytes
-rw-r--r--docs/reference/images/cursor-alphabetic-indexes.png (renamed from docs/reference/evolution-data-server/images/cursor-alphabetic-indexes.png)bin115122 -> 115122 bytes
-rw-r--r--docs/reference/images/cursor-positions-filtered.png (renamed from docs/reference/evolution-data-server/images/cursor-positions-filtered.png)bin145568 -> 145568 bytes
-rw-r--r--docs/reference/images/cursor-positions-step.png (renamed from docs/reference/evolution-data-server/images/cursor-positions-step.png)bin325691 -> 325691 bytes
-rw-r--r--docs/reference/images/cursor-positions.png (renamed from docs/reference/evolution-data-server/images/cursor-positions.png)bin131869 -> 131869 bytes
-rw-r--r--docs/reference/libedbus-private-docs.sgml.in (renamed from docs/reference/private/libedbus-private-docs.sgml.in)0
-rw-r--r--docs/reference/private/CMakeLists.txt13
-rw-r--r--docs/reference/xml/evolution-data-server-cursor-example.sgml.in (renamed from docs/reference/evolution-data-server/evolution-data-server-cursor-example.sgml.in)0
16 files changed, 190 insertions, 109 deletions
diff --git a/docs/reference/CMakeLists.txt b/docs/reference/CMakeLists.txt
index 9a9144b7e..c78ae1350 100644
--- a/docs/reference/CMakeLists.txt
+++ b/docs/reference/CMakeLists.txt
@@ -1,6 +1,187 @@
-add_subdirectory(camel)
-add_subdirectory(evolution-data-server)
+# We need to use our own CMake module until the one upstream is fixed
+find_package(GtkDoc NO_DEFAULT_PATH PATHS "${CMAKE_SOURCE_DIR}/cmake/modules")
+
+set(INSTALL_DOCDIR "${SHARE_INSTALL_PREFIX}/gtk-doc/html")
+
+# ******************************
+# Camel Documentation
+# ******************************
+
+set(CAMEL_SOURCEDIRS
+ ${CMAKE_SOURCE_DIR}/src/camel
+ ${CMAKE_SOURCE_DIR}/src/camel/providers/local
+ ${CMAKE_SOURCE_DIR}/src/camel/providers/imapx
+ ${CMAKE_SOURCE_DIR}/src/camel/providers/nntp
+ ${CMAKE_SOURCE_DIR}/src/camel/providers/pop3
+ ${CMAKE_SOURCE_DIR}/src/camel/providers/sendmail
+ ${CMAKE_SOURCE_DIR}/src/camel/providers/smtp
+)
+
+set(CAMEL_DEPENDENCIES
+ camel
+ camellocal
+ camelimapx
+ camelnntp
+ camelpop3
+ camelsendmail
+ camelsmtp
+)
+
+set(CAMEL_IGNORE_HEADERS
+ addresses.h
+ address-data.h
+ camel-charset-map-private.h
+ camel-enumtypes.h
+ camel-i18n.h
+ camel-imapx-tokenise.h
+ camel-imapx-utils.h
+ camel-local-private.h
+ camel-nntp-private.h
+ camel-nntp-resp-codes.h
+ camel-search-private.h
+ camel-test.h
+ camel-test-provider.h
+ camel-win32.h
+ folders.h
+ messages.h
+ session.h
+)
+
+set(CAMEL_XML ${CMAKE_CURRENT_BINARY_DIR}/camel-docs.sgml)
+configure_file(
+ ${CMAKE_CURRENT_SOURCE_DIR}/camel-docs.sgml.in
+ ${CAMEL_XML}
+ @ONLY
+)
+
+gtk_doc_add_module(
+ camel
+ XML ${CAMEL_XML}
+ SOURCE ${CAMEL_SOURCEDIRS}
+ LIBRARIES ${CAMEL_DEPENDENCIES}
+ IGNOREHEADERS ${CAMEL_IGNORE_HEADERS}
+ SCANOPTS "--deprecated-guards=CAMEL_DISABLE_DEPRECATED"
+)
+
+add_custom_target(camel-documentation ALL DEPENDS doc-camel)
+
+install(DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}/camel/html
+ DESTINATION ${INSTALL_DOCDIR}/camel)
+
+# ******************************
+# Evolution Data Server documentation
+# ******************************
+
+set(EDS_SOURCEDIRS
+ ${CMAKE_SOURCE_DIR}/src/libedataserver
+ ${CMAKE_BINARY_DIR}/src/libedataserver
+ ${CMAKE_SOURCE_DIR}/src/libebackend
+ ${CMAKE_SOURCE_DIR}/src/addressbook/libebook
+ ${CMAKE_SOURCE_DIR}/src/addressbook/libebook-contacts
+ ${CMAKE_SOURCE_DIR}/src/addressbook/libedata-book
+ ${CMAKE_SOURCE_DIR}/src/calendar/libecal
+ ${CMAKE_SOURCE_DIR}/src/calendar/libedata-cal
+ ${CMAKE_SOURCE_DIR}/tests/test-server-utils
+)
+
+set(EDS_DEPENDENCIES
+ camel
+ edataserver-private
+ edbus-private
+ egdbus-book
+ egdbus-cal
+ ebackend
+ edataserver
+ ebook
+ ebook-contacts
+ edata-book
+ ecal
+ edata-cal
+ etestserverutils
+)
+
+set(EDS_IGNORE_HEADERS
+ e-alphabet-index-private.h
+ e-backend-enumtypes.h
+ e-book-enumtypes.h
+ e-book-contacts-enumtypes.h
+ e-book-view-private.h
+ e-cal-enumtypes.h
+ e-cal-view-private.h
+ e-client-private.h
+ e-data-cal-types.h
+ e-phone-number-private.h
+ e-source-enumtypes.h
+ e-transliterator-private.h
+ libedataserver-private.h
+ ximian-vcard.h
+)
+
+set(EDS_EXAMPLE ${CMAKE_CURRENT_BINARY_DIR}/xml/evolution-data-server-cursor-example.sgml)
+configure_file(${CMAKE_CURRENT_SOURCE_DIR}/xml/evolution-data-server-cursor-example.sgml.in
+ ${EDS_EXAMPLE}
+ @ONLY
+)
+
+set(EDS_XML ${CMAKE_CURRENT_BINARY_DIR}/evolution-data-server-docs.sgml)
+configure_file(
+ ${CMAKE_CURRENT_SOURCE_DIR}/evolution-data-server-docs.sgml.in
+ ${EDS_XML}
+ @ONLY
+)
+
+file(GLOB EDS_IMAGES "${CMAKE_CURRENT_SOURCE_DIR}/images/*.png")
+
+gtk_doc_add_module(
+ evolution-data-server
+ XML ${EDS_XML}
+ SOURCE ${EDS_SOURCEDIRS}
+ LIBRARIES ${EDS_DEPENDENCIES}
+ IGNOREHEADERS ${EDS_IGNORE_HEADERS}
+ CONTENT_FILES ${EDS_EXAMPLE} ${EDS_IMAGES}
+ SCANOPTS "--deprecated-guards=EDS_DISABLE_DEPRECATED"
+)
+
+add_custom_target(evolution-data-server-documentation ALL DEPENDS doc-evolution-data-server)
+
+install(DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}/evolution-data-server/html
+ DESTINATION ${INSTALL_DOCDIR}/evolution-data-server)
+
+# ******************************
+# Private documentation
+# ******************************
if(WITH_PRIVATE_DOCS)
- add_subdirectory(private)
+ set(EDBUS_PRIVATE_XML ${CMAKE_CURRENT_BINARY_DIR}/libedbus-private-docs.sgml)
+ configure_file(
+ ${CMAKE_CURRENT_SOURCE_DIR}/libedbus-private-docs.sgml.in
+ ${EDBUS_PRIVATE_XML}
+ @ONLY
+ )
+
+ set(EDBUS_PRIVATE_SOURCEDIRS
+ ${CMAKE_BINARY_DIR}/src/private
+ )
+
+ set(EDBUS_PRIVATE_DEPENDENCIES
+ edbus-private
+ )
+
+ set(EDBUS_PRIVATE_IGNORE_HEADERS
+ e-dbus-localed.h
+ )
+
+ gtk_doc_add_module(
+ libedbus-private
+ XML ${EDBUS_PRIVATE_XML}
+ SOURCE ${EDBUS_PRIVATE_SOURCEDIRS}
+ LIBRARIES ${EDBUS_PRIVATE_DEPENDENCIES}
+ IGNOREHEADERS ${EDBUS_PRIVATE_IGNORE_HEADERS}
+ SCANOPTS "--deprecated-guards=EDS_DISABLE_DEPRECATED"
+ )
+
+ add_custom_target(private-documentation ALL DEPENDS doc-libedbus-private)
+
+ install(DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}/libedbus-private/html
+ DESTINATION ${INSTALL_DOCDIR}/libedbus-private)
endif(WITH_PRIVATE_DOCS)
diff --git a/docs/reference/camel/camel-docs.sgml.in b/docs/reference/camel-docs.sgml.in
index 2e66b6d4a..80aae313f 100644
--- a/docs/reference/camel/camel-docs.sgml.in
+++ b/docs/reference/camel-docs.sgml.in
@@ -1,6 +1,6 @@
<?xml version="1.0"?>
-<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
- "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd" [
+<!DOCTYPE book PUBLIC '-//OASIS//DTD DocBook XML V4.5//EN'
+ 'http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd' [
<!ENTITY % local.common.attrib "xmlns:xi CDATA #FIXED 'http://www.w3.org/2003/XInclude'">
]>
<book id="index" xmlns:xi="http://www.w3.org/2003/XInclude">
diff --git a/docs/reference/camel/CMakeLists.txt b/docs/reference/camel/CMakeLists.txt
deleted file mode 100644
index 55f7e7a37..000000000
--- a/docs/reference/camel/CMakeLists.txt
+++ /dev/null
@@ -1,41 +0,0 @@
-set(SOURCEDIRS
- ${CMAKE_SOURCE_DIR}/src/camel
- ${CMAKE_SOURCE_DIR}/src/camel/providers/local
- ${CMAKE_SOURCE_DIR}/src/camel/providers/imapx
- ${CMAKE_SOURCE_DIR}/src/camel/providers/nntp
- ${CMAKE_SOURCE_DIR}/src/camel/providers/pop3
- ${CMAKE_SOURCE_DIR}/src/camel/providers/sendmail
- ${CMAKE_SOURCE_DIR}/src/camel/providers/smtp
-)
-
-set(DEPENDENCIES
- camel
- camellocal
- camelimapx
- camelnntp
- camelpop3
- camelsendmail
- camelsmtp
-)
-
-set(IGNORE_HEADERS
- addresses.h
- address-data.h
- camel-charset-map-private.h
- camel-enumtypes.h
- camel-i18n.h
- camel-imapx-tokenise.h
- camel-imapx-utils.h
- camel-local-private.h
- camel-nntp-private.h
- camel-nntp-resp-codes.h
- camel-search-private.h
- camel-test.h
- camel-test-provider.h
- camel-win32.h
- folders.h
- messages.h
- session.h
-)
-
-add_gtkdoc(camel camel "CAMEL_DISABLE_DEPRECATED" SOURCEDIRS DEPENDENCIES IGNORE_HEADERS)
diff --git a/docs/reference/evolution-data-server/evolution-data-server-docs.sgml.in b/docs/reference/evolution-data-server-docs.sgml.in
index d9673b592..3d08da4d2 100644
--- a/docs/reference/evolution-data-server/evolution-data-server-docs.sgml.in
+++ b/docs/reference/evolution-data-server-docs.sgml.in
@@ -1,12 +1,12 @@
<?xml version="1.0"?>
-<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
- "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd" [
+<!DOCTYPE book PUBLIC '-//OASIS//DTD DocBook XML V4.5//EN'
+ 'http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd' [
<!ENTITY % local.common.attrib "xmlns:xi CDATA #FIXED 'http://www.w3.org/2003/XInclude'">
]>
-<book id="index" xmlns:xi="http://www.w3.org/2001/XInclude">
+<book id="index" xmlns:xi="http://www.w3.org/2003/XInclude">
<bookinfo>
<title>Evolution-Data-Server Reference Manual</title>
- <releaseinfo>Reference Manual for @PACKAGE_VERSION@</releaseinfo>
+ <releaseinfo>Reference Manual for @PROJECT_VERSION@</releaseinfo>
<abstract>
<para>
Evolution-Data-Server is a collection of libraries and services
diff --git a/docs/reference/evolution-data-server/CMakeLists.txt b/docs/reference/evolution-data-server/CMakeLists.txt
deleted file mode 100644
index e3c212251..000000000
--- a/docs/reference/evolution-data-server/CMakeLists.txt
+++ /dev/null
@@ -1,46 +0,0 @@
-configure_file(${CMAKE_CURRENT_SOURCE_DIR}/evolution-data-server-cursor-example.sgml.in
- ${CMAKE_CURRENT_BINARY_DIR}/xml/evolution-data-server-cursor-example.sgml
- @ONLY
-)
-
-set(SOURCEDIRS
- ${CMAKE_SOURCE_DIR}/src/libebackend
- ${CMAKE_SOURCE_DIR}/src/libedataserver
- ${CMAKE_BINARY_DIR}/src/libedataserver
- ${CMAKE_SOURCE_DIR}/src/addressbook/libebook
- ${CMAKE_SOURCE_DIR}/src/addressbook/libebook-contacts
- ${CMAKE_SOURCE_DIR}/src/addressbook/libedata-book
- ${CMAKE_SOURCE_DIR}/src/calendar/libecal
- ${CMAKE_SOURCE_DIR}/src/calendar/libedata-cal
- ${CMAKE_SOURCE_DIR}/tests/test-server-utils
-)
-
-set(DEPENDENCIES
- ebackend
- edataserver
- ebook
- ebook-contacts
- edata-book
- ecal
- edata-cal
- etestserverutils
-)
-
-set(IGNORE_HEADERS
- e-alphabet-index-private.h
- e-backend-enumtypes.h
- e-book-enumtypes.h
- e-book-contacts-enumtypes.h
- e-book-view-private.h
- e-cal-enumtypes.h
- e-cal-view-private.h
- e-client-private.h
- e-data-cal-types.h
- e-phone-number-private.h
- e-source-enumtypes.h
- e-transliterator-private.h
- libedataserver-private.h
- ximian-vcard.h
-)
-
-add_gtkdoc(evolution-data-server e "EDS_DISABLE_DEPRECATED" SOURCEDIRS DEPENDENCIES IGNORE_HEADERS)
diff --git a/docs/reference/evolution-data-server/image-sources/cursor-alphabetic-indexes.odg b/docs/reference/image-sources/cursor-alphabetic-indexes.odg
index 7abc20418..7abc20418 100644
--- a/docs/reference/evolution-data-server/image-sources/cursor-alphabetic-indexes.odg
+++ b/docs/reference/image-sources/cursor-alphabetic-indexes.odg
Binary files differ
diff --git a/docs/reference/evolution-data-server/image-sources/cursor-positions-filtered.odg b/docs/reference/image-sources/cursor-positions-filtered.odg
index bc863cc92..bc863cc92 100644
--- a/docs/reference/evolution-data-server/image-sources/cursor-positions-filtered.odg
+++ b/docs/reference/image-sources/cursor-positions-filtered.odg
Binary files differ
diff --git a/docs/reference/evolution-data-server/image-sources/cursor-positions-step.odg b/docs/reference/image-sources/cursor-positions-step.odg
index a0306b63c..a0306b63c 100644
--- a/docs/reference/evolution-data-server/image-sources/cursor-positions-step.odg
+++ b/docs/reference/image-sources/cursor-positions-step.odg
Binary files differ
diff --git a/docs/reference/evolution-data-server/image-sources/cursor-positions.odg b/docs/reference/image-sources/cursor-positions.odg
index 059ef84ff..059ef84ff 100644
--- a/docs/reference/evolution-data-server/image-sources/cursor-positions.odg
+++ b/docs/reference/image-sources/cursor-positions.odg
Binary files differ
diff --git a/docs/reference/evolution-data-server/images/cursor-alphabetic-indexes.png b/docs/reference/images/cursor-alphabetic-indexes.png
index e58671427..e58671427 100644
--- a/docs/reference/evolution-data-server/images/cursor-alphabetic-indexes.png
+++ b/docs/reference/images/cursor-alphabetic-indexes.png
Binary files differ
diff --git a/docs/reference/evolution-data-server/images/cursor-positions-filtered.png b/docs/reference/images/cursor-positions-filtered.png
index 028dfed09..028dfed09 100644
--- a/docs/reference/evolution-data-server/images/cursor-positions-filtered.png
+++ b/docs/reference/images/cursor-positions-filtered.png
Binary files differ
diff --git a/docs/reference/evolution-data-server/images/cursor-positions-step.png b/docs/reference/images/cursor-positions-step.png
index 29f8718c1..29f8718c1 100644
--- a/docs/reference/evolution-data-server/images/cursor-positions-step.png
+++ b/docs/reference/images/cursor-positions-step.png
Binary files differ
diff --git a/docs/reference/evolution-data-server/images/cursor-positions.png b/docs/reference/images/cursor-positions.png
index eff780c27..eff780c27 100644
--- a/docs/reference/evolution-data-server/images/cursor-positions.png
+++ b/docs/reference/images/cursor-positions.png
Binary files differ
diff --git a/docs/reference/private/libedbus-private-docs.sgml.in b/docs/reference/libedbus-private-docs.sgml.in
index 990232dc8..990232dc8 100644
--- a/docs/reference/private/libedbus-private-docs.sgml.in
+++ b/docs/reference/libedbus-private-docs.sgml.in
diff --git a/docs/reference/private/CMakeLists.txt b/docs/reference/private/CMakeLists.txt
deleted file mode 100644
index 26c305333..000000000
--- a/docs/reference/private/CMakeLists.txt
+++ /dev/null
@@ -1,13 +0,0 @@
-set(SOURCEDIRS
- ${CMAKE_BINARY_DIR}/src/private
-)
-
-set(DEPENDENCIES
- edbus-private
-)
-
-set(IGNORE_HEADERS
- e-dbus-localed.h
-)
-
-add_gtkdoc(libedbus-private e-dbus "EDS_DISABLE_DEPRECATED" SOURCEDIRS DEPENDENCIES IGNORE_HEADERS)
diff --git a/docs/reference/evolution-data-server/evolution-data-server-cursor-example.sgml.in b/docs/reference/xml/evolution-data-server-cursor-example.sgml.in
index be999ae2d..be999ae2d 100644
--- a/docs/reference/evolution-data-server/evolution-data-server-cursor-example.sgml.in
+++ b/docs/reference/xml/evolution-data-server-cursor-example.sgml.in