GNOME.org
 

[evolution-data-server] Build developer documentation sections and types on the fly

commit e3a549bda9e9dec48de35336ff53efa863fe8faf
Author: Milan Crha <mcrha redhat com>
Date:   Thu Jun 23 15:45:23 2016 +0200

    Build developer documentation sections and types on the fly
    
    That also means less work for the developers/comment writers, as
    the new functions/comments are taken automatically into the generated
    documentation.

 camel/providers/imapx/camel-imapx-mailbox.c        |    2 +-
 docs/reference/camel/Makefile.am                   |   14 +-
 docs/reference/camel/camel-docs.sgml               |   25 +-
 docs/reference/camel/camel-sections.txt            | 4244 -------------------
 docs/reference/camel/camel.types                   |  198 -
 docs/reference/eds/Makefile.am                     |   41 +-
 docs/reference/eds/eds-docs.sgml                   |   47 +-
 docs/reference/eds/eds-sections.txt                | 4430 --------------------
 docs/reference/private/Makefile.am                 |   11 +-
 .../private/libedbus-private-docs.sgml.in          |   36 +-
 .../private/libedbus-private-sections.txt          | 1033 -----
 docs/reference/private/libedbus-private.types      |   56 -
 12 files changed, 138 insertions(+), 9999 deletions(-)
---
diff --git a/camel/providers/imapx/camel-imapx-mailbox.c b/camel/providers/imapx/camel-imapx-mailbox.c
index 59b8765..2ea134f 100644
--- a/camel/providers/imapx/camel-imapx-mailbox.c
+++ b/camel/providers/imapx/camel-imapx-mailbox.c
@@ -424,7 +424,7 @@ camel_imapx_mailbox_get_separator (CamelIMAPXMailbox *mailbox)
  *
  * Returns: the mailbox name as folder path.
  *
- * Since: 3.12.1
+ * Since: 3.16
  **/
 gchar *
 camel_imapx_mailbox_dup_folder_path (CamelIMAPXMailbox *mailbox)
diff --git a/docs/reference/camel/Makefile.am b/docs/reference/camel/Makefile.am
index 59b3b4c..0a0f8e3 100644
--- a/docs/reference/camel/Makefile.am
+++ b/docs/reference/camel/Makefile.am
@@ -12,7 +12,7 @@ DOC_SOURCE_DIR = $(top_srcdir)/camel
 HTML_DIR = $(datadir)/gtk-doc/html
 
 # Extra options to supply to gtkdoc-scan
-SCAN_OPTIONS = --deprecated-guards="CAMEL_DISABLE_DEPRECATED"
+SCAN_OPTIONS = --deprecated-guards="CAMEL_DISABLE_DEPRECATED" --rebuild-sections --rebuild-types
 
 # Extra options to pass to gtkdoc-scangobj
 SCANGOBJ_OPTIONS =
@@ -64,15 +64,23 @@ IGNORE_HFILES = \
        tests \
        $(NULL)
 
+GITIGNOREFILES = \
+       $(DOC_MODULE)-overrides.txt \
+       $(DOC_MODULE)-sections.txt \
+       $(DOC_MODULE).hierarchy \
+       $(DOC_MODULE).types \
+       $(NULL)
+
+DISTCLEANFILES = $(GITIGNOREFILES)
+
 # This includes the standard gtk-doc make rules, copied by gtkdocize.
 include $(top_srcdir)/gtk-doc.make
 
 # Other files to distribute
 EXTRA_DIST += \
        $(content_files) \
+       $(GITIGNOREFILES) \
        $(DOC_MODULE)-docs.sgml \
-       $(DOC_MODULE)-sections.txt \
-       camel.hierarchy \
        $(NULL)
 
 #TESTS = $(GTKDOC_CHECK)
diff --git a/docs/reference/camel/camel-docs.sgml b/docs/reference/camel/camel-docs.sgml
index 9c2f355..2df9f3d 100644
--- a/docs/reference/camel/camel-docs.sgml
+++ b/docs/reference/camel/camel-docs.sgml
@@ -38,7 +38,9 @@
       <title>Fundamentals</title>
       <xi:include href="xml/camel.xml"/>
       <xi:include href="xml/camel-debug.xml"/>
+      <xi:include href="xml/camel-enums.xml"/>
       <xi:include href="xml/camel-object.xml"/>
+      <xi:include href="xml/camel-object-bag.xml"/>
       <xi:include href="xml/camel-operation.xml"/>
       <xi:include href="xml/camel-url.xml"/>
     </chapter>
@@ -119,8 +121,6 @@
       <xi:include href="xml/camel-vee-summary.xml"/>
       <xi:include href="xml/camel-vtrash-folder.xml"/>
       <xi:include href="xml/camel-vee-data-cache.xml"/>
-      <xi:include href="xml/camel-vee-message-info-data.xml"/>
-      <xi:include href="xml/camel-vee-subfolder-data.xml"/>
     </chapter>
 
     <chapter id="Addresses">
@@ -175,12 +175,15 @@
       <xi:include href="xml/camel-async-closure.xml"/>
       <xi:include href="xml/camel-charset-map.xml"/>
       <xi:include href="xml/camel-file-utils.xml"/>
+      <xi:include href="xml/camel-html-parser.xml"/>
       <xi:include href="xml/camel-iconv.xml"/>
       <xi:include href="xml/camel-lock.xml"/>
       <xi:include href="xml/camel-lock-client.xml"/>
+      <xi:include href="xml/camel-lock-helper.xml"/>
       <xi:include href="xml/camel-memchunk.xml"/>
       <xi:include href="xml/camel-mempool.xml"/>
       <xi:include href="xml/camel-mime-utils.xml"/>
+      <xi:include href="xml/camel-mime-part-utils.xml"/>
       <xi:include href="xml/camel-movemail.xml"/>
       <xi:include href="xml/camel-msgport.xml"/>
       <xi:include href="xml/camel-net-utils.xml"/>
@@ -222,7 +225,9 @@
     <chapter id="IMAP">
       <title>IMAP Service</title>
       <xi:include href="xml/camel-imapx-command.xml"/>
+      <xi:include href="xml/camel-imapx-conn-manager.xml"/>
       <xi:include href="xml/camel-imapx-folder.xml"/>
+      <xi:include href="xml/camel-imapx-input-stream.xml"/>
       <xi:include href="xml/camel-imapx-job.xml"/>
       <xi:include href="xml/camel-imapx-logger.xml"/>
       <xi:include href="xml/camel-imapx-mailbox.xml"/>
@@ -283,6 +288,22 @@
     <title>Index of deprecated symbols</title>
     <xi:include href="xml/api-index-deprecated.xml"><xi:fallback /></xi:include>
   </index>
+  <index id="api-index-3.22" role="3.22">
+    <title>Index of new symbols in 3.22</title>
+    <xi:include href="xml/api-index-3.22.xml"><xi:fallback /></xi:include>
+  </index>
+  <index id="api-index-3.20" role="3.20">
+    <title>Index of new symbols in 3.20</title>
+    <xi:include href="xml/api-index-3.20.xml"><xi:fallback /></xi:include>
+  </index>
+  <index id="api-index-3.18" role="3.18">
+    <title>Index of new symbols in 3.18</title>
+    <xi:include href="xml/api-index-3.18.xml"><xi:fallback /></xi:include>
+  </index>
+  <index id="api-index-3.16" role="3.16">
+    <title>Index of new symbols in 3.16</title>
+    <xi:include href="xml/api-index-3.16.xml"><xi:fallback /></xi:include>
+  </index>
   <index id="api-index-3.12" role="3.12">
     <title>Index of new symbols in 3.12</title>
     <xi:include href="xml/api-index-3.12.xml"><xi:fallback /></xi:include>
diff --git a/docs/reference/eds/Makefile.am b/docs/reference/eds/Makefile.am
index 874b264..8e955f2 100644
--- a/docs/reference/eds/Makefile.am
+++ b/docs/reference/eds/Makefile.am
@@ -28,11 +28,27 @@ DOC_SOURCE_DIR = \
        $(top_srcdir)/calendar/libedata-cal             \
        $(top_srcdir)/tests/test-server-utils
 
+# Exceptions, files which should not be documented
+IGNORE_HFILES = \
+       e-alphabet-index-private.h      \
+       e-backend-enumtypes.h           \
+       e-book-enumtypes.h              \
+       e-book-contacts-enumtypes.h     \
+       e-cal-enumtypes.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
+       $(NULL)
+
 # Extra options to pass to gtkdoc-scangobj. Not normally needed.
 SCANGOBJ_OPTIONS =
 
 # Extra options to supply to gtkdoc-scan
-SCAN_OPTIONS = --deprecated-guards="EDS_DISABLE_DEPRECATED"
+SCAN_OPTIONS = --deprecated-guards="EDS_DISABLE_DEPRECATED" --rebuild-sections --rebuild-types
 
 # Extra options to supply to gtkdoc-mkdb
 # We must enable the SGML mode so that we can have HTML tables
@@ -73,20 +89,6 @@ CFILE_GLOB = \
        $(top_srcdir)/calendar/libedata-cal/*.c         \
        $(top_srcdir)/tests/test-server-utils/*.c
 
-# Exceptions, files which should not be documented
-LIBEBOOK_IGNORE_FILES =        \
-       e-book-enumtypes.h              \
-       e-book-contacts-enumtypes.h     \
-       e-phone-number-private.h
-
-LIBECAL_IGNORE_FILES = \
-       e-cal-enumtypes.h               \
-       e-data-cal-types.h
-
-IGNORE_HFILES = config.h \
-       $(LIBEBOOK_IGNORE_FILES)        \
-       $(LIBECAL_IGNORE_FILES)
-
 HTML_IMAGES = \
        $(IMAGE_DIR)/cursor-positions.png               \
        $(IMAGE_DIR)/cursor-positions-filtered.png      \
@@ -138,11 +140,18 @@ GTKDOC_LIBS = \
        $(CAMEL_LIBS) $(E_DATA_SERVER_LIBS) $(E_BACKEND_LIBS)                   \
        $(EVOLUTION_ADDRESSBOOK_LIBS) $(EVOLUTION_CALENDAR_LIBS)
 
+GITIGNOREFILES = \
+       $(DOC_MODULE)-overrides.txt \
+       $(DOC_MODULE)-sections.txt \
+       $(DOC_MODULE).hierarchy \
+       $(DOC_MODULE).types \
+       $(NULL)
+
 eds-cursor-example.sgml: eds-cursor-example.sgml.in
        sed -e 's|\ SRCDIR\@|$(abs_top_srcdir)|g' $< > $(@)
 
 BUILT_SOURCES = eds-cursor-example.sgml
-DISTCLEANFILES = $(BUILT_SOURCES)
+DISTCLEANFILES = $(BUILT_SOURCES) $(GITIGNOREFILES)
 
 # This includes the standard gtk-doc make rules, copied by gtkdocize.
 include $(top_srcdir)/gtk-doc.make
diff --git a/docs/reference/eds/eds-docs.sgml b/docs/reference/eds/eds-docs.sgml
index a92e5f8..8dcad26 100644
--- a/docs/reference/eds/eds-docs.sgml
+++ b/docs/reference/eds/eds-docs.sgml
@@ -80,6 +80,7 @@
     <chapter>
       <title>Data Sources</title>
       <xi:include href="xml/e-source.xml"/>
+      <xi:include href="xml/e-source-enums.xml"/>
       <xi:include href="xml/e-source-registry.xml"/>
     </chapter>
 
@@ -95,7 +96,10 @@
       <xi:include href="xml/e-source-calendar.xml"/>
       <xi:include href="xml/e-source-camel.xml"/>
       <xi:include href="xml/e-source-collection.xml"/>
+      <xi:include href="xml/e-source-contacts.xml"/>
       <xi:include href="xml/e-source-goa.xml"/>
+      <xi:include href="xml/e-source-ldap.xml"/>
+      <xi:include href="xml/e-source-local.xml"/>
       <xi:include href="xml/e-source-mail-account.xml"/>
       <xi:include href="xml/e-source-mail-composition.xml"/>
       <xi:include href="xml/e-source-mail-identity.xml"/>
@@ -103,7 +107,6 @@
       <xi:include href="xml/e-source-mail-submission.xml"/>
       <xi:include href="xml/e-source-mail-transport.xml"/>
       <xi:include href="xml/e-source-mdn.xml"/>
-      <xi:include href="xml/e-source-memo-list.xml"/>
       <xi:include href="xml/e-source-offline.xml"/>
       <xi:include href="xml/e-source-openpgp.xml"/>
       <xi:include href="xml/e-source-proxy.xml"/>
@@ -112,9 +115,9 @@
       <xi:include href="xml/e-source-revision-guards.xml"/>
       <xi:include href="xml/e-source-security.xml"/>
       <xi:include href="xml/e-source-smime.xml"/>
-      <xi:include href="xml/e-source-task-list.xml"/>
       <xi:include href="xml/e-source-uoa.xml"/>
       <xi:include href="xml/e-source-webdav.xml"/>
+      <xi:include href="xml/e-source-weather.xml"/>
       <xi:include href="xml/e-source-backend-summary-setup.xml"/>
     </chapter>
   </part>
@@ -150,12 +153,14 @@
     <chapter>
       <title>Abstract Classes for Backends</title>
       <xi:include href="xml/e-backend.xml"/>
+      <xi:include href="xml/e-backend-enums.xml"/>
       <xi:include href="xml/e-backend-factory.xml"/>
       <xi:include href="xml/e-data-factory.xml"/>
       <xi:include href="xml/e-dbus-server.xml"/>
       <xi:include href="xml/e-extensible.xml"/>
       <xi:include href="xml/e-extension.xml"/>
       <xi:include href="xml/e-module.xml"/>
+      <xi:include href="xml/e-subprocess-factory.xml"/>
     </chapter>
 
     <chapter>
@@ -164,6 +169,7 @@
       <xi:include href="xml/e-collection-backend-factory.xml"/>
       <xi:include href="xml/e-oauth2-support.xml"/>
       <xi:include href="xml/e-server-side-source.xml"/>
+      <xi:include href="xml/e-server-side-source-credentials-provider.xml"/>
       <xi:include href="xml/e-source-registry-server.xml"/>
     </chapter>
 
@@ -179,6 +185,7 @@
       <xi:include href="xml/e-data-book-cursor-sqlite.xml"/>
       <xi:include href="xml/e-data-book-factory.xml"/>
       <xi:include href="xml/e-data-book-view.xml"/>
+      <xi:include href="xml/e-subprocess-book-factory.xml"/>
     </chapter>
 
     <chapter>
@@ -193,6 +200,7 @@
       <xi:include href="xml/e-data-cal.xml"/>
       <xi:include href="xml/e-data-cal-factory.xml"/>
       <xi:include href="xml/e-data-cal-view.xml"/>
+      <xi:include href="xml/e-subprocess-cal-factory.xml"/>
     </chapter>
   </part>
 
@@ -202,16 +210,26 @@
       <title>Available for clients and backends</title>
       <xi:include href="xml/e-data-server-util.xml"/>
       <xi:include href="xml/e-categories.xml"/>
+      <xi:include href="xml/e-cancellable-locks.xml"/>
+      <xi:include href="xml/e-cache-reaper.xml"/>
+      <xi:include href="xml/e-cache-reaper-utils.xml"/>
       <xi:include href="xml/e-collator.xml"/>
       <xi:include href="xml/e-debug-log.xml"/>
+      <xi:include href="xml/e-error.xml"/>
       <xi:include href="xml/e-flag.xml"/>
+      <xi:include href="xml/e-free-form-exp.xml"/>
+      <xi:include href="xml/e-gdbus-templates.xml"/>
       <xi:include href="xml/e-memory.xml"/>
+      <xi:include href="xml/e-network-monitor.xml"/>
       <xi:include href="xml/e-operation-pool.xml"/>
       <xi:include href="xml/e-secret-store.xml"/>
       <xi:include href="xml/e-sexp.xml"/>
+      <xi:include href="xml/e-soup-ssl-trust.xml"/>
       <xi:include href="xml/e-time-utils.xml"/>
       <xi:include href="xml/e-uid.xml"/>
+      <xi:include href="xml/e-webdav-discover.xml"/>
       <xi:include href="xml/e-xml-hash-utils.xml"/>
+      <xi:include href="xml/e-xml-utils.xml"/>
       <xi:include href="xml/eds-version.xml"/>
     </chapter>
 
@@ -244,6 +262,15 @@
       <xi:include href="xml/e-cal-check-timezones.xml"/>
       <xi:include href="xml/e-timezone-cache.xml"/>
       <xi:include href="xml/e-cal-backend-util.xml"/>
+      <xi:include href="xml/e-cal-types.xml"/>
+    </chapter>
+
+    <chapter>
+      <title>Credentials</title>
+      <xi:include href="xml/e-source-credentials-provider.xml"/>
+      <xi:include href="xml/e-source-credentials-provider-impl.xml"/>
+      <xi:include href="xml/e-source-credentials-provider-impl-password.xml"/>
+      <xi:include href="xml/e-source-credentials-provider-impl-google.xml"/>
     </chapter>
   </part>
 
@@ -295,6 +322,22 @@
     <title>Index of deprecated symbols</title>
     <xi:include href="xml/api-index-deprecated.xml"><xi:fallback /></xi:include>
   </index>
+  <index id="api-index-3.22" role="3.22">
+    <title>Index of new symbols in 3.22</title>
+    <xi:include href="xml/api-index-3.22.xml"><xi:fallback /></xi:include>
+  </index>
+  <index id="api-index-3.20" role="3.20">
+    <title>Index of new symbols in 3.20</title>
+    <xi:include href="xml/api-index-3.20.xml"><xi:fallback /></xi:include>
+  </index>
+  <index id="api-index-3.18" role="3.18">
+    <title>Index of new symbols in 3.18</title>
+    <xi:include href="xml/api-index-3.18.xml"><xi:fallback /></xi:include>
+  </index>
+  <index id="api-index-3.16" role="3.16">
+    <title>Index of new symbols in 3.16</title>
+    <xi:include href="xml/api-index-3.16.xml"><xi:fallback /></xi:include>
+  </index>
   <index id="api-index-3.12" role="3.12">
     <title>Index of new symbols in 3.12</title>
     <xi:include href="xml/api-index-3.12.xml"><xi:fallback /></xi:include>
diff --git a/docs/reference/private/Makefile.am b/docs/reference/private/Makefile.am
index c6534c3..b2774ff 100644
--- a/docs/reference/private/Makefile.am
+++ b/docs/reference/private/Makefile.am
@@ -7,7 +7,7 @@ DOC_MODULE = libedbus-private
 DOC_MAIN_SGML_FILE = $(DOC_MODULE)-docs.sgml
 
 # Extra options to supply to gtkdoc-scan
-SCAN_OPTIONS = --deprecated-guards="EDS_DISABLE_DEPRECATED"
+SCAN_OPTIONS = --deprecated-guards="EDS_DISABLE_DEPRECATED" --rebuild-sections --rebuild-types
 
 # The directory containing the source code. Relative to $(srcdir).
 DOC_SOURCE_DIR = $(top_srcdir)/private
@@ -39,8 +39,15 @@ MKDB_OPTIONS = --output-format=xml --sgml-mode --name-space=e-dbus
 $(DOC_MAIN_SGML_FILE): $(DOC_MAIN_SGML_FILE).in
        sed -e 's|\ SRCDIR\@|$(abs_top_builddir)|g' $< > $(@)
 
+GITIGNOREFILES = \
+       $(DOC_MODULE)-overrides.txt \
+       $(DOC_MODULE)-sections.txt \
+       $(DOC_MODULE).hierarchy \
+       $(DOC_MODULE).types \
+       $(NULL)
+
 BUILT_SOURCES = $(DOC_MAIN_SGML_FILE)
-DISTCLEANFILES = $(BUILT_SOURCES)
+DISTCLEANFILES = $(BUILT_SOURCES) $(GITIGNOREFILES)
 
 # This includes the standard gtk-doc make rules, copied by gtkdocize.
 include $(top_srcdir)/gtk-doc.make
diff --git a/docs/reference/private/libedbus-private-docs.sgml.in 
b/docs/reference/private/libedbus-private-docs.sgml.in
index 331e515..7d6999e 100644
--- a/docs/reference/private/libedbus-private-docs.sgml.in
+++ b/docs/reference/private/libedbus-private-docs.sgml.in
@@ -10,21 +10,16 @@
 
   <chapter>
     <title>D-Bus API Reference</title>
-    <xi:include href="xml/e-dbus-object.xml"/>
-    <xi:include href="xml/e-dbus-source.xml"/>
-    <xi:include href="xml/e-dbus-source-removable.xml"/>
-    <xi:include href="xml/e-dbus-source-writable.xml"/>
-    <xi:include href="xml/e-dbus-source-remote-creatable.xml"/>
-    <xi:include href="xml/e-dbus-source-remote-deletable.xml"/>
-    <xi:include href="xml/e-dbus-source-oauth2-support.xml"/>
-    <xi:include href="xml/e-dbus-source-manager.xml"/>
-    <xi:include href="xml/e-dbus-object-manager-client.xml"/>
-    <xi:include href="xml/e-dbus-authenticator.xml"/>
-    <xi:include href="xml/e-dbus-address-book.xml"/>
     <xi:include href="xml/e-dbus-address-book-cursor.xml"/>
     <xi:include href="xml/e-dbus-address-book-factory.xml"/>
-    <xi:include href="xml/e-dbus-calendar.xml"/>
+    <xi:include href="xml/e-dbus-address-book.xml"/>
+    <xi:include href="xml/e-dbus-authenticator.xml"/>
     <xi:include href="xml/e-dbus-calendar-factory.xml"/>
+    <xi:include href="xml/e-dbus-calendar.xml"/>
+    <xi:include href="xml/e-dbus-direct-book.xml"/>
+    <xi:include href="xml/e-dbus-source-manager.xml"/>
+    <xi:include href="xml/e-dbus-source.xml"/>
+    <xi:include href="xml/e-dbus-subprocess-backend.xml"/>
     <xi:include href="xml/e-dbus-user-prompter.xml"/>
   </chapter>
 
@@ -50,6 +45,23 @@
     <xi:include href="xml/api-index-full.xml"><xi:fallback /></xi:include>
   </index>
 
+  <index id="api-index-3.18" role="3.18">
+    <title>Index of new symbols in 3.18</title>
+    <xi:include href="xml/api-index-3.18.xml"><xi:fallback /></xi:include>
+  </index>
+  <index id="api-index-3.16" role="3.16">
+    <title>Index of new symbols in 3.16</title>
+    <xi:include href="xml/api-index-3.16.xml"><xi:fallback /></xi:include>
+  </index>
+  <index id="api-index-3.10" role="3.10">
+    <title>Index of new symbols in 3.10</title>
+    <xi:include href="xml/api-index-3.10.xml"><xi:fallback /></xi:include>
+  </index>
+  <index id="api-index-3.8" role="3.8">
+    <title>Index of new symbols in 3.8</title>
+    <xi:include href="xml/api-index-3.8.xml"><xi:fallback /></xi:include>
+  </index>
+
   <xi:include href="xml/annotation-glossary.xml"><xi:fallback /></xi:include>
 
 </book>
[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]