Added proper dependency lists to the gtk-doc mess.

2000-12-19  Federico Mena Quintero  <federico@helixcode.com>

	Added proper dependency lists to the gtk-doc mess.

	* calendar/cal-client/Makefile.am (TARGET_DIR): Removed unused
	variable.
	(SOURCE_FILES): New variable with the list of source files we
	depend on.
	(IGNORED_SOURCE_HEADERS): New variable with the headers we ignore
	for the gtkdoc-scan phase.
	(scan_generated):
	(tmpl_dependencies):
	(tmpl_sources):
	(tmpl_generated);
	(sgml_dependencies):
	(sgml_generated): Lists of stuff that is generated and that other
	stuff depends on.
	(all): Added the $(sgml_generated) as the final target.
	(install-data-local): Added an installation hook; gtk-doc seems to
	want some of its generated files to be installed.

	* calendar/cal-client/evolution-cal-client-sections.txt: Updated.

	* calendar/cal-util/Makefile.am: Made the same changes as for
	calendar/cal-client/Makefile.am.

	* calendar/cal-util/evolution-cal-util-sections.txt: Updated.

	* Makefile.am (local_entities): Added alarm-generation.sgml.
	(all): Made the main target be the html/index.html.

svn path=/trunk/; revision=7084

5 files changed, 184 insertions, 67 deletions

diff --git a/doc/devel/calendar/cal-client/Makefile.am b/doc/devel/calendar/cal-client/Makefile.am
index 44d43639a8..363c15b326 100644
--- a/doc/devel/calendar/cal-client/Makefile.am
+++ b/doc/devel/calendar/cal-client/Makefile.am
@@ -1,11 +1,6 @@
-## Process this file with automake to produce Makefile.in
-
 # The name of the module.
 DOC_MODULE=evolution-cal-client
 
-# The top-level SGML file.
-DOC_MAIN_SGML_FILE=evolution-cal-client.sgml
-
 # The directory containing the source code (if it contains documentation).
 DOC_SOURCE_DIR=$(EVOLUTION_DIR)/calendar/cal-client
 
@@ -22,41 +17,87 @@ LDFLAGS="								\
 	$(BONOBO_VFS_GNOME_LIBS)					\
 	$(top_builddir)/calendar/cal-client/.libs/libcal-client.a	\
 	$(top_builddir)/calendar/cal-util/.libs/libcal-util.a		\
-	$(top_builddir)/libical/src/libical/libical.a			\
+	$(top_builddir)/libical/src/libical/.libs/libical.a		\
 	$(top_builddir)/libversit/.libs/libversit.al			\
 	"
 
-HTML_DIR=$(datadir)/gnome/html
+DOC_DIR=$(datadir)/gnome/html
 
-TARGET_DIR=$(HTML_DIR)/$(DOC_MODULE)
+DOC_DIR_INSTALL_FILES =				\
+	 evolution-cal-client.args		\
+	 evolution-cal-client.hierarchy		\
+	 evolution-cal-client.signals		\
+	 evolution-cal-client.types		\
+	 evolution-cal-client-decl.txt		\
+	 evolution-cal-client-sections.txt
 
-tmpl_sources =					\
-	tmpl/cal-client.sgml			\
-	tmpl/evolution-cal-client-unused.sgml
+SOURCE_FILES =							\
+	$(top_srcdir)/calendar/cal-client/cal-client.c		\
+	$(top_srcdir)/calendar/cal-client/cal-client.h		\
+	$(top_srcdir)/calendar/cal-client/cal-client-types.c	\
+	$(top_srcdir)/calendar/cal-client/cal-client-types.h
 
-evolution_cal_client_docdir = $(HTML_DIR)
-evolution_cal_client_doc_DATA =			\
+IGNORED_HEADER_FILES =		\
+	cal-listener.h		\
+	evolution-calendar.h
+
+scan_generated =				\
+	evolution-cal-client-decl.txt		\
+	evolution-cal-client.args		\
 	evolution-cal-client.hierarchy		\
-	evolution-cal-client.types		\
+	evolution-cal-client.signals		\
+	evolution-cal-client.types
+
+tmpl_dependencies =				\
 	evolution-cal-client-decl.txt		\
-	evolution-cal-client-sections.txt
+	evolution-cal-client-sections.txt	\
+	evolution-cal-client.args		\
+	evolution-cal-client.hierarchy		\
+	evolution-cal-client.signals
 
-EXTRA_DIST = 					\
-	$(evolution_cal_client_doc_DATA)
+tmpl_sources =					\
+	tmpl/cal-client.sgml			\
+	tmpl/evolution-cal-client-unused.sgml
 
-sgml/evolution-cal-client-doc.bottom: $(tmpl_sources)
-	$(MAKE) sgml
+tmpl_generated =				\
+	evolution-cal-client-unused.txt
 
-scan:
-	-(cd $(srcdir) \
-	&& env CFLAGS=$(CFLAGS) LDFLAGS=$(LDFLAGS) \
-		 gtkdoc-scanobj --module=$(DOC_MODULE) \
-	&& gtkdoc-scan --module=$(DOC_MODULE) --source-dir=$(DOC_SOURCE_DIR) --ignore-headers="cal-listener.h evolution-calendar.h" )
+sgml_dependencies =				\
+	evolution-cal-client-decl.txt		\
+	evolution-cal-client-sections.txt	\
+	evolution-cal-client.args		\
+	evolution-cal-client.hierarchy		\
+	evolution-cal-client.signals		\
+	tmpl/cal-client.sgml
+
+sgml_generated = 				\
+	sgml/cal-client.sgml			\
+	sgml/evolution-cal-client-doc.bottom	\
+	sgml/evolution-cal-client-doc.top	\
+	sgml/object_index.sgml			\
+	sgml/tree_index.sgml
 
-templates: scan
+EXTRA_DIST = 					\
+	 evolution-cal-client.args		\
+	 evolution-cal-client.hierarchy		\
+	 evolution-cal-client.signals		\
+	 evolution-cal-client.types		\
+	 evolution-cal-client-decl.txt		\
+	 evolution-cal-client-sections.txt
+
+all: $(sgml_generated)
+
+scan $(scan_generated): $(SOURCE_FILES)
+	-(cd $(srcdir)									\
+	  && env CFLAGS=$(CFLAGS) LDFLAGS=$(LDFLAGS)					\
+		 gtkdoc-scanobj --module=$(DOC_MODULE)					\
+	  && gtkdoc-scan --module=$(DOC_MODULE) --source-dir=$(DOC_SOURCE_DIR)		\
+			 --ignore-headers="$(IGNORED_HEADER_FILES)" )
+
+templates $(tmpl_sources) $(tmpl_generated): $(tmpl_dependencies)
 	cd $(srcdir) && gtkdoc-mktmpl --module=$(DOC_MODULE)
 
-sgml:
+sgml $(sgml_generated): $(sgml_dependencies)
 	cd $(srcdir) \
 	&& gtkdoc-mkdb --module=$(DOC_MODULE) --source-dir=$(DOC_SOURCE_DIR)
 
@@ -66,6 +107,12 @@ clean-local:
 maintainer-clean-local: clean
 	cd $(srcdir) && rm -rf sgml $(DOC_MODULE)-decl-list.txt $(DOC_MODULE)-decl.txt
 
+install-data-local:
+	$(mkinstalldirs) $(DOC_DIR)
+	for i in $(DOC_DIR_INSTALL_FILES); do		\
+		$(INSTALL_DATA) $$i $(DOC_DIR);		\
+	done
+
 dist-hook:
 	mkdir $(distdir)/sgml
 	mkdir $(distdir)/tmpl
@@ -73,4 +120,4 @@ dist-hook:
 	-cp $(srcdir)/sgml/*.sgml $(distdir)/sgml
 	-cp $(srcdir)/sgml/*.bottom $(srcdir)/sgml/*.top $(distdir)/sgml
 
-.PHONY : sgml templates scan
+.PHONY: scan templates sgml
diff --git a/doc/devel/calendar/cal-client/evolution-cal-client-decl.txt b/doc/devel/calendar/cal-client/evolution-cal-client-decl.txt
index 0574d70678..498285a370 100644
--- a/doc/devel/calendar/cal-client/evolution-cal-client-decl.txt
+++ b/doc/devel/calendar/cal-client/evolution-cal-client-decl.txt
@@ -24,6 +24,9 @@
 <STRUCT>
 <NAME>CalClientClass</NAME>
 </STRUCT>
+<STRUCT>
+<NAME>CalClientPrivate</NAME>
+</STRUCT>
 <ENUM>
 <NAME>CalClientLoadStatus</NAME>
 typedef enum {
@@ -47,7 +50,7 @@ struct CalClient {
 	GtkObject object;
 
 	/* Private data */
-	gpointer priv;
+	CalClientPrivate *priv;
 };
 </STRUCT>
 <FUNCTION>
@@ -76,6 +79,11 @@ CalClient *client, const char *str_uri
 CalClient *client, const char *str_uri
 </FUNCTION>
 <FUNCTION>
+<NAME>cal_client_is_loaded</NAME>
+<RETURNS>gboolean  </RETURNS>
+CalClient *client
+</FUNCTION>
+<FUNCTION>
 <NAME>cal_client_get_n_objects</NAME>
 <RETURNS>int  </RETURNS>
 CalClient *client, CalObjType type
@@ -86,21 +94,16 @@ CalClient *client, CalObjType type
 CalClient *client,const char *uid,CalComponent **comp
 </FUNCTION>
 <FUNCTION>
-<NAME>cal_client_get_uid_by_pilot_id</NAME>
-<RETURNS>CalClientGetStatus  </RETURNS>
-CalClient *client,unsigned long pilot_id,char **uid
-</FUNCTION>
-<FUNCTION>
-<NAME>cal_client_update_pilot_id</NAME>
-<RETURNS>void  </RETURNS>
-CalClient *client, char *uid,unsigned long pilot_id,unsigned long pilot_status
-</FUNCTION>
-<FUNCTION>
 <NAME>cal_client_get_uids</NAME>
 <RETURNS>GList  *</RETURNS>
 CalClient *client, CalObjType type
 </FUNCTION>
 <FUNCTION>
+<NAME>cal_client_get_changes</NAME>
+<RETURNS>GList  *</RETURNS>
+CalClient *client, CalObjType type, const char *change_id
+</FUNCTION>
+<FUNCTION>
 <NAME>cal_client_get_objects_in_range</NAME>
 <RETURNS>GList  *</RETURNS>
 CalClient *client, CalObjType type,time_t start, time_t end
@@ -112,13 +115,18 @@ CalClient *client, CalObjType type,time_t start, time_t end,CalRecurInstanceFn c
 </FUNCTION>
 <FUNCTION>
 <NAME>cal_client_get_alarms_in_range</NAME>
-<RETURNS>GList  *</RETURNS>
+<RETURNS>GSList  *</RETURNS>
 CalClient *client, time_t start, time_t end
 </FUNCTION>
 <FUNCTION>
+<NAME>cal_client_free_alarms</NAME>
+<RETURNS>void  </RETURNS>
+GSList *comp_alarms
+</FUNCTION>
+<FUNCTION>
 <NAME>cal_client_get_alarms_for_object</NAME>
 <RETURNS>gboolean  </RETURNS>
-CalClient *client, const char *uid,time_t start, time_t end,GList **alarms
+CalClient *client, const char *uid,time_t start, time_t end,CalComponentAlarms **alarms
 </FUNCTION>
 <FUNCTION>
 <NAME>cal_client_update_object</NAME>
@@ -130,3 +138,16 @@ CalClient *client, CalComponent *comp
 <RETURNS>gboolean  </RETURNS>
 CalClient *client, const char *uid
 </FUNCTION>
+<ENUM>
+<NAME>CalClientChangeType</NAME>
+typedef enum {
+	CAL_CLIENT_CHANGE_ADDED = 1 << 0,
+	CAL_CLIENT_CHANGE_MODIFIED = 1 << 1,
+	CAL_CLIENT_CHANGE_DELETED = 1 << 2
+} CalClientChangeType;
+</ENUM>
+<FUNCTION>
+<NAME>cal_client_change_list_free</NAME>
+<RETURNS>void  </RETURNS>
+GList *list
+</FUNCTION>
diff --git a/doc/devel/calendar/cal-client/evolution-cal-client-sections.txt b/doc/devel/calendar/cal-client/evolution-cal-client-sections.txt
index c37b223247..3e4eafbf48 100644
--- a/doc/devel/calendar/cal-client/evolution-cal-client-sections.txt
+++ b/doc/devel/calendar/cal-client/evolution-cal-client-sections.txt
@@ -7,17 +7,22 @@ CAL_CLIENT
 
 CalClientLoadStatus
 CalClientGetStatus
+
+CalClientChangeType
+
 cal_client_new
 cal_client_load_calendar
 cal_client_create_calendar
+cal_client_is_loaded
 cal_client_get_n_objects
+cal_client_get_uids
 cal_client_get_object
+cal_client_get_changes
+cal_client_change_list_free
 cal_client_get_objects_in_range
 cal_client_generate_instances
-cal_client_get_uid_by_pilot_id
-cal_client_update_pilot_id
-cal_client_get_uids
 cal_client_get_alarms_in_range
+cal_client_free_alarms
 cal_client_get_alarms_for_object
 cal_client_update_object
 cal_client_remove_object
@@ -33,5 +38,6 @@ cal_client_construct
 
 <SUBSECTION Private>
 CalClient
+CalClientPrivate
 
 </SECTION>
diff --git a/doc/devel/calendar/cal-client/tmpl/cal-client.sgml b/doc/devel/calendar/cal-client/tmpl/cal-client.sgml
index 06469ff3ee..6de1ab8045 100644
--- a/doc/devel/calendar/cal-client/tmpl/cal-client.sgml
+++ b/doc/devel/calendar/cal-client/tmpl/cal-client.sgml
@@ -84,6 +84,15 @@ GTK+ object for communication with personal calendar server.
   the requested object.  This could indicate a bug in the calendar
   client libraries or in the Wombat server.
 
+<!-- ##### ENUM CalClientChangeType ##### -->
+<para>
+
+</para>
+
+@CAL_CLIENT_CHANGE_ADDED: 
+@CAL_CLIENT_CHANGE_MODIFIED: 
+@CAL_CLIENT_CHANGE_DELETED: 
+
 <!-- ##### FUNCTION cal_client_new ##### -->
 <para>
 
@@ -112,6 +121,15 @@ GTK+ object for communication with personal calendar server.
 @Returns: 
 
 
+<!-- ##### FUNCTION cal_client_is_loaded ##### -->
+<para>
+
+</para>
+
+@client: 
+@Returns: 
+
+
 <!-- ##### FUNCTION cal_client_get_n_objects ##### -->
 <para>
 
@@ -122,6 +140,16 @@ GTK+ object for communication with personal calendar server.
 @Returns: 
 
 
+<!-- ##### FUNCTION cal_client_get_uids ##### -->
+<para>
+
+</para>
+
+@client: 
+@type: 
+@Returns: 
+
+
 <!-- ##### FUNCTION cal_client_get_object ##### -->
 <para>
 
@@ -135,72 +163,67 @@ GTK+ object for communication with personal calendar server.
 @ico: 
 
 
-<!-- ##### FUNCTION cal_client_get_objects_in_range ##### -->
+<!-- ##### FUNCTION cal_client_get_changes ##### -->
 <para>
 
 </para>
 
 @client: 
 @type: 
-@start: 
-@end: 
+@change_id: 
 @Returns: 
 
 
-<!-- ##### FUNCTION cal_client_generate_instances ##### -->
+<!-- ##### FUNCTION cal_client_change_list_free ##### -->
 <para>
 
 </para>
 
-@client: 
-@type: 
-@start: 
-@end: 
-@cb: 
-@cb_data: 
+@list: 
 
 
-<!-- ##### FUNCTION cal_client_get_uid_by_pilot_id ##### -->
+<!-- ##### FUNCTION cal_client_get_objects_in_range ##### -->
 <para>
 
 </para>
 
 @client: 
-@pilot_id: 
-@uid: 
+@type: 
+@start: 
+@end: 
 @Returns: 
 
 
-<!-- ##### FUNCTION cal_client_update_pilot_id ##### -->
+<!-- ##### FUNCTION cal_client_generate_instances ##### -->
 <para>
 
 </para>
 
 @client: 
-@uid: 
-@pilot_id: 
-@pilot_status: 
+@type: 
+@start: 
+@end: 
+@cb: 
+@cb_data: 
 
 
-<!-- ##### FUNCTION cal_client_get_uids ##### -->
+<!-- ##### FUNCTION cal_client_get_alarms_in_range ##### -->
 <para>
 
 </para>
 
 @client: 
-@type: 
+@start: 
+@end: 
 @Returns: 
 
 
-<!-- ##### FUNCTION cal_client_get_alarms_in_range ##### -->
+<!-- ##### FUNCTION cal_client_free_alarms ##### -->
 <para>
 
 </para>
 
-@client: 
-@start: 
-@end: 
-@Returns: 
+@comp_alarms: 
 
 
 <!-- ##### FUNCTION cal_client_get_alarms_for_object ##### -->
diff --git a/doc/devel/calendar/cal-client/tmpl/evolution-cal-client-unused.sgml b/doc/devel/calendar/cal-client/tmpl/evolution-cal-client-unused.sgml
index 5576dbd57f..a0c23894d9 100644
--- a/doc/devel/calendar/cal-client/tmpl/evolution-cal-client-unused.sgml
+++ b/doc/devel/calendar/cal-client/tmpl/evolution-cal-client-unused.sgml
@@ -1,3 +1,13 @@
+<!-- ##### FUNCTION cal_client_update_pilot_id ##### -->
+<para>
+
+</para>
+
+@client: 
+@uid: 
+@pilot_id: 
+@pilot_status: 
+
 <!-- ##### FUNCTION cal_client_get_events_in_range ##### -->
 <para>
 
@@ -8,3 +18,13 @@
 @end: 
 @Returns: 
 
+<!-- ##### FUNCTION cal_client_get_uid_by_pilot_id ##### -->
+<para>
+
+</para>
+
+@client: 
+@pilot_id: 
+@uid: 
+@Returns: 
+