added hook docs, and cleaned up some of the hook point names.

2004-10-28  Not Zed  <NotZed@Ximian.com>

        * mail-folder-cache.c (real_flush_updates):
        * em-message-browser.c (em_message_browser_new):
        * em-mailer-prefs.c (em_mailer_prefs_construct):
        * em-format-html-display.c (efhd_attachment_popup):
        * em-folder-view.c (emfv_popup, emfv_list_done_message_selected)
        (emfv_format_popup_event):
        * em-folder-tree.c (emft_popup):
        * em-folder-properties.c (emfp_dialog_got_folder):
        * em-folder-browser.c (em_folder_browser_new):
        * em-composer-utils.c (em_utils_reply_to_message):
        * em-composer-prefs.c (em_composer_prefs_construct):
        * em-account-editor.c (em_account_editor_construct): added hook
        docs, and cleaned up some of the hook point names.

svn path=/trunk/; revision=27749

12 files changed, 117 insertions, 11 deletions

diff --git a/mail/ChangeLog b/mail/ChangeLog
index 71059a35b7..5259b1ab06 100644
--- a/mail/ChangeLog
+++ b/mail/ChangeLog
@@ -1,3 +1,19 @@
+2004-10-28  Not Zed  <NotZed@Ximian.com>
+
+	* mail-folder-cache.c (real_flush_updates): 
+	* em-message-browser.c (em_message_browser_new): 
+	* em-mailer-prefs.c (em_mailer_prefs_construct): 
+	* em-format-html-display.c (efhd_attachment_popup): 
+	* em-folder-view.c (emfv_popup, emfv_list_done_message_selected) 
+	(emfv_format_popup_event): 
+	* em-folder-tree.c (emft_popup): 
+	* em-folder-properties.c (emfp_dialog_got_folder): 
+	* em-folder-browser.c (em_folder_browser_new): 
+	* em-composer-utils.c (em_utils_reply_to_message): 
+	* em-composer-prefs.c (em_composer_prefs_construct): 
+	* em-account-editor.c (em_account_editor_construct): added hook
+	docs, and cleaned up some of the hook point names.
+
 2004-10-22  Jeffrey Stedfast  <fejj@novell.com>
 
 	* em-folder-tree.c: Give the Rename item a different path than the
diff --git a/mail/em-account-editor.c b/mail/em-account-editor.c
index f2d56c3463..5febf6c59f 100644
--- a/mail/em-account-editor.c
+++ b/mail/em-account-editor.c
@@ -2414,9 +2414,25 @@ em_account_editor_construct(EMAccountEditor *emae, EAccount *account, em_account
 	gui->providers = g_list_sort(camel_provider_list(TRUE), (GCompareFunc)provider_compare);
 
 	if (type == EMAE_NOTEBOOK) {
+		/** @HookPoint-EMConfig: Mail Account Editor
+		 * @Id: org.gnome.evolution.mail.config.accountEditor
+		 * @Type: E_CONFIG_BOOK
+		 * @Class: org.gnome.evolution.mail.config:1.0
+		 * @Target: EMConfigTargetAccount
+		 *
+		 * The account editor window.
+		 */
 		ec = em_config_new(E_CONFIG_BOOK, "org.gnome.evolution.mail.config.accountEditor");
 		items = emae_editor_items;
 	} else {
+		/** @HookPoint-EMConfig: New Mail Account Druid
+		 * @Id: org.gnome.evolution.mail.config.accountDruid
+		 * @Type: E_CONFIG_DRUID
+		 * @Class: org.gnome.evolution.mail.config:1.0
+		 * @Target: EMConfigTargetAccount
+		 *
+		 * The new mail account druid.
+		 */
 		ec = em_config_new(E_CONFIG_DRUID, "org.gnome.evolution.mail.config.accountDruid");
 		items = emae_druid_items;
 	}
diff --git a/mail/em-composer-prefs.c b/mail/em-composer-prefs.c
index 0fbd59e920..19d072f1cd 100644
--- a/mail/em-composer-prefs.c
+++ b/mail/em-composer-prefs.c
@@ -892,6 +892,14 @@ em_composer_prefs_construct (EMComposerPrefs *prefs)
 	prefs->gui = gui;
 	prefs->sig_script_gui = glade_xml_new (EVOLUTION_GLADEDIR "/mail-config.glade", "vbox_add_script_signature", NULL);
 
+	/** @HookPoint-EMConfig: Mail Composer Preferences
+	 * @Id: org.gnome.evolution.mail.composerPrefs
+	 * @Type: E_CONFIG_BOOK
+	 * @Class: org.gnome.evolution.mail.config:1.0
+	 * @Target: EMConfigTargetPrefs
+	 *
+	 * The mail composer preferences settings page.
+	 */
 	ec = em_config_new(E_CONFIG_BOOK, "org.gnome.evolution.mail.composerPrefs");
 	l = NULL;
 	for (i=0;i<sizeof(emcp_items)/sizeof(emcp_items[0]);i++)
diff --git a/mail/em-composer-utils.c b/mail/em-composer-utils.c
index 01b3561659..12156559ef 100644
--- a/mail/em-composer-utils.c
+++ b/mail/em-composer-utils.c
@@ -1762,8 +1762,7 @@ em_utils_reply_to_message(CamelFolder *folder, const char *uid, CamelMimeMessage
 
 	g_return_if_fail(message != NULL);
 
-	/**
-	 * @Event: message.replying
+	/** @Event: message.replying
 	 * @Title: Message being replied to
 	 * @Target: EMEventTargetMessage
 	 * 
diff --git a/mail/em-folder-browser.c b/mail/em-folder-browser.c
index 07444c7f98..03ce51f33c 100644
--- a/mail/em-folder-browser.c
+++ b/mail/em-folder-browser.c
@@ -287,6 +287,13 @@ GtkWidget *em_folder_browser_new(void)
 {
 	EMFolderBrowser *emfb = g_object_new(em_folder_browser_get_type(), 0);
 
+	/** @HookPoint-EMMenu: Main Mail Menu
+	 * @Id: org.gnome.evolution.mail.browser
+	 * @Class: org.gnome.evolution.mail.bonobomenu:1.0
+	 * @Target: EMMenuTargetSelect
+	 *
+	 * The main menu of mail view of the main application window.
+	 */
 	((EMFolderView *)emfb)->menu = em_menu_new("org.gnome.evolution.mail.browser");
 
 	return (GtkWidget *)emfb;
diff --git a/mail/em-folder-properties.c b/mail/em-folder-properties.c
index 3134664bde..37df32199d 100644
--- a/mail/em-folder-properties.c
+++ b/mail/em-folder-properties.c
@@ -274,6 +274,14 @@ emfp_dialog_got_folder (char *uri, CamelFolder *folder, void *data)
 	gtk_widget_ensure_style (dialog);
 	gtk_container_set_border_width ((GtkContainer *) ((GtkDialog *) dialog)->vbox, 12);
 
+	/** @HookPoint-EMConfig: Folder Properties Window
+	 * @Id: org.gnome.evolution.mail.folderConfig
+	 * @Type: E_CONFIG_BOOK
+	 * @Class: org.gnome.evolution.mail.config:1.0
+	 * @Target: EMConfigTargetFolder
+	 *
+	 * The folder properties window.
+	 */
 	ec = em_config_new(E_CONFIG_BOOK, "org.gnome.evolution.mail.folderConfig");
 	prop_data->config = ec;
 	l = NULL;
diff --git a/mail/em-folder-tree.c b/mail/em-folder-tree.c
index 172423d626..98b6304edc 100644
--- a/mail/em-folder-tree.c
+++ b/mail/em-folder-tree.c
@@ -2808,8 +2808,14 @@ emft_popup (EMFolderTree *emft, GdkEvent *event)
 			info_flags |= CAMEL_FOLDER_VIRTUAL | CAMEL_FOLDER_NOINFERIORS;
 	}
 
-	/* handle right-click by opening a context menu */
-	emp = em_popup_new ("org.gnome.mail.storageset.popup.select");
+	/** @HookPoint-EMPopup: Folder Tree Context Menu
+	 * @Id: org.gnome.evolution.mail.foldertree.popup
+	 * @Class: org.gnome.evolution.mail.popup:1.0
+	 * @Target: EMPopupTargetFolder
+	 *
+	 * This is the context menu shown on the folder tree.
+	 */
+	emp = em_popup_new ("org.gnome.evolution.mail.foldertree.popup");
 	
 	/* FIXME: pass valid fi->flags here */
 	target = em_popup_target_new_folder (emp, uri, info_flags, flags);
diff --git a/mail/em-folder-view.c b/mail/em-folder-view.c
index 282a9a24af..2349fd9d91 100644
--- a/mail/em-folder-view.c
+++ b/mail/em-folder-view.c
@@ -1014,7 +1014,14 @@ emfv_popup(EMFolderView *emfv, GdkEvent *event)
 	EMPopupTargetSelect *target;
 	int i;
 
-	emp = em_popup_new("org.gnome.mail.folderview.popup.select");
+	/** @HookPoint-EMPopup: Message List Context Menu
+	 * @Id: org.gnome.evolution.mail.folderview.popup.select
+	 * @Type: EMPopup
+	 * @Target: EMPopupTargetSelect
+	 *
+	 * This is the context menu shown on the message list or over a message.
+	 */
+	emp = em_popup_new("org.gnome.mail.folderview.popup");
 	target = em_folder_view_get_popup_target(emfv, emp);
 
 	for (i=0;i<sizeof(emfv_popup_items)/sizeof(emfv_popup_items[0]);i++)
@@ -1997,8 +2004,7 @@ emfv_list_done_message_selected(CamelFolder *folder, const char *uid, CamelMimeM
 		return;
 	}
 		
-	/**
-	 * @Event: message.reading
+	/** @Event: message.reading
 	 * @Title: Viewing a message
 	 * @Target: EMEventTargetMessage
 	 * 
@@ -2210,7 +2216,25 @@ emfv_format_popup_event(EMFormatHTMLDisplay *efhd, GdkEventButton *event, const
 	/* FIXME: this maybe should just fit on em-html-display, it has access to the
 	   snooped part type */
 
-	emp = em_popup_new("org.gnome.evolution.mail.folderview.popup.uri");
+	/** @HookPoint-EMPopup: Inline URI Context Menu
+	 * @Id: org.gnome.evolution.mail.folderview.popup
+	 * @Class: org.gnome.evolution.mail.popup:1.0
+	 * @Target: EMPopupTargetURI
+	 *
+	 * This is the context menu shown when clicking on inline URIs,
+	 * including addresses or normal HTML links that are displayed inside
+	 * the message view.
+	 */
+
+	/** @HookPoint-EMPopup: Inline Object Context Menu
+	 * @Id: org.gnome.evolution.mail.folderview.popup
+	 * @Class: org.gnome.evolution.mail.popup:1.0
+	 * @Target: EMPopupTargetPart
+	 *
+	 * This is the context menu shown when clicking on inline
+	 * content such as a picture.
+	 */
+	emp = em_popup_new("org.gnome.evolution.mail.folderview.popup");
 	if (part)
 		target = (EPopupTarget *)em_popup_target_new_part(emp, part, NULL);
 	else {
diff --git a/mail/em-format-html-display.c b/mail/em-format-html-display.c
index bf452a8fd0..a621dd7254 100644
--- a/mail/em-format-html-display.c
+++ b/mail/em-format-html-display.c
@@ -1090,7 +1090,15 @@ efhd_attachment_popup(GtkWidget *w, GdkEventButton *event, struct _attach_puri *
 		return FALSE;
 	}
 
-	emp = em_popup_new("org.gnome.mail.formathtmldisplay.popup.part");
+	/** @HookPoint-EMPopup: Attachment Button Context Menu
+	 * @Id: org.gnome.evolution.mail.formathtmldisplay.popup
+	 * @Class: org.gnome.evolution.mail.popup:1.0
+	 * @Target: EMPopupTargetPart
+	 *
+	 * This is the drop-down menu shown when a user clicks on the down arrow
+	 * of the attachment button in inline mail content.
+	 */
+	emp = em_popup_new("org.gnome.evolution.mail.formathtmldisplay.popup");
 	target = em_popup_target_new_part(emp, info->puri.part, info->handle?info->handle->mime_type:NULL);
 	target->target.widget = w;
 
diff --git a/mail/em-mailer-prefs.c b/mail/em-mailer-prefs.c
index b7f37bb7b2..ce6482b4e9 100644
--- a/mail/em-mailer-prefs.c
+++ b/mail/em-mailer-prefs.c
@@ -717,6 +717,14 @@ em_mailer_prefs_construct (EMMailerPrefs *prefs)
 	gui = glade_xml_new (EVOLUTION_GLADEDIR "/mail-config.glade", "preferences_toplevel", NULL);
 	prefs->gui = gui;
 
+	/** @HookPoint-EMConfig: Mail Preferences Page
+	 * @Id: org.gnome.evolution.mail.prefs
+	 * @Type: E_CONFIG_BOOK
+	 * @Class: org.gnome.evolution.mail.config:1.0
+	 * @Target: EMConfigTargetPrefs
+	 *
+	 * The main mail preferences page.
+	 */
 	ec = em_config_new(E_CONFIG_BOOK, "org.gnome.evolution.mail.prefs");
 	l = NULL;
 	for (i=0;i<sizeof(emmp_items)/sizeof(emmp_items[0]);i++)
diff --git a/mail/em-message-browser.c b/mail/em-message-browser.c
index 1c78ba1093..caf93e7e41 100644
--- a/mail/em-message-browser.c
+++ b/mail/em-message-browser.c
@@ -176,6 +176,13 @@ GtkWidget *em_message_browser_new(void)
 {
 	EMMessageBrowser *emmb = g_object_new(em_message_browser_get_type(), 0);
 
+	/** @HookPoint-EMMenu: Standalone Mssage View Menu
+	 * @Id: org.gnome.evolution.mail.messagebrowser
+	 * @Class: org.gnome.evolution.mail.bonobomenu:1.0
+	 * @Target: EMMenuTargetSelect
+	 *
+	 * The main menu of standalone message viewer.
+	 */
 	((EMFolderView *)emmb)->menu = em_menu_new("org.gnome.evolution.mail.messagebrowser");
 
 	return (GtkWidget *)emmb;
diff --git a/mail/mail-folder-cache.c b/mail/mail-folder-cache.c
index 16b7177df5..9c96112514 100644
--- a/mail/mail-folder-cache.c
+++ b/mail/mail-folder-cache.c
@@ -245,8 +245,7 @@ real_flush_updates(void *o, void *event_data, void *data)
 			EMEvent *e = em_event_peek();
 			EMEventTargetFolder *t = em_event_target_new_folder(e, up->uri, up->new?EM_EVENT_FOLDER_NEWMAIL:0);
 
-			/**
-			 * @Event: folder.changed
+			/** @Event: folder.changed
 			 * @Title: Folder changed
 			 * @Target: EMEventTargetFolder
 			 *