* Deleted an unusued file

* Added some documentation

pmo-trunk-r631

diff --git a/src/modest-tny-msg-actions.h b/src/modest-tny-msg-actions.h
index ce0c62c..8e43fad 100644 (file)
--- a/src/modest-tny-msg-actions.h
+++ b/src/modest-tny-msg-actions.h
@@ -50,11 +50,22 @@ TnyMimePart *modest_tny_msg_actions_find_body_part (TnyMsg * self, gboolean want
  * 
  * search for the nth (mime) part in the message
  * 
- * Returns: the TnyMsgMimePart for the found part, or NULL if no matching part is foundi; must be unref'd
+ * Returns: the TnyMsgMimePart for the found part, or NULL if no
+ * matching part is foundi; must be unref'd
  */
 TnyMimePart* modest_tny_msg_actions_find_nth_part (TnyMsg *msg, gint index);
 
 
+/**
+ * modest_tny_msg_actions_find_body:
+ * @self: 
+ * @want_html: 
+ * 
+ * gets the body of a message as text, if @want_html is true, try HTML mail
+ * first.
+ * 
+ * Returns: the body of the message as text
+ **/
 gchar* modest_tny_msg_actions_find_body (TnyMsg *self, gboolean want_html);
 
 #endif /* __MODEST_TNY_MSG_ACTIONS_H__ */

diff --git a/src/widgets/modest-edit-msg-window.h b/src/widgets/modest-edit-msg-window.h
index 8b7439e..bb1bb85 100644 (file)
--- a/src/widgets/modest-edit-msg-window.h
+++ b/src/widgets/modest-edit-msg-window.h
@@ -91,12 +91,47 @@ ModestWindow*   modest_edit_msg_window_new         (ModestWidgetFactory *factory
 void         modest_edit_msg_window_set_msg     (ModestEditMsgWindow *self, 
                                                 TnyMsg *msg);
 
+
+/**
+ * modest_edit_msg_window_get_widget_factory:
+ * @edit_window: a #ModestEditMsgWindow
+ * 
+ * gets the #ModestWidgetFactory associated with the edit message window
+ * 
+ * Returns: the widget factory
+ **/
 ModestWidgetFactory *   modest_edit_msg_window_get_widget_factory    (ModestEditMsgWindow *edit_window);
 
+
+/**
+ * modest_edit_msg_window_get_account_store:
+ * @edit_window: a #ModestEditMsgWindow
+ * 
+ * gets the account store associated with the edit message window
+ * 
+ * Returns: the account store
+ **/
 TnyAccountStore *       modest_edit_msg_window_get_account_store     (ModestEditMsgWindow *edit_window);
 
+/**
+ * modest_edit_msg_window_get_msg_data:
+ * @edit_window: a #ModestEditMsgWindow
+ * 
+ * gets the message data already present in the edit message
+ * window. The message data must be freed with
+ * modest_edit_msg_window_free_msg_data
+ * 
+ * Returns: the message data
+ **/
 MsgData *               modest_edit_msg_window_get_msg_data          (ModestEditMsgWindow *edit_window);
 
+/**
+ * modest_edit_msg_window_free_msg_data:
+ * @edit_window: a #ModestEditMsgWindow
+ * @data: 
+ * 
+ * frees the message data passed as argument
+ **/
 void                    modest_edit_msg_window_free_msg_data         (ModestEditMsgWindow *edit_window,
                                                                      MsgData *data);
 

diff --git a/src/widgets/modest-folder-view.h b/src/widgets/modest-folder-view.h
index 19bcd54..2ebec08 100644 (file)
--- a/src/widgets/modest-folder-view.h
+++ b/src/widgets/modest-folder-view.h
@@ -99,10 +99,6 @@ GtkWidget* modest_folder_view_new         (ModestTnyAccountStore *account_store,
  */
 void  modest_folder_view_set_title (ModestFolderView *self, const gchar *title);
 
-
-/* FIXME: this is ugly */
-const gchar* modest_folder_view_get_selected_account (ModestFolderView *self);
-
 G_END_DECLS
 
 #endif /* __MODEST_FOLDER_VIEW_H__ */

diff --git a/src/widgets/modest-main-window.h b/src/widgets/modest-main-window.h
index d59ce03..aca4c33 100644 (file)
--- a/src/widgets/modest-main-window.h
+++ b/src/widgets/modest-main-window.h
@@ -70,8 +70,24 @@ GType modest_main_window_get_type (void) G_GNUC_CONST;
 ModestWindow* modest_main_window_new (ModestWidgetFactory *factory,
                                      TnyAccountStore *account_store);
 
+/**
+ * modest_main_window_get_widget_factory:
+ * @edit_window: a #ModestMainWindow
+ * 
+ * gets the #ModestWidgetFactory associated with the main window
+ * 
+ * Returns: the widget factory
+ **/
 ModestWidgetFactory *   modest_main_window_get_widget_factory    (ModestMainWindow *main_window);
 
+/**
+ * modest_main_window_get_account_store:
+ * @edit_window: a #ModestMainWindow
+ * 
+ * gets the account store associated with the main window
+ * 
+ * Returns: the account store
+ **/
 TnyAccountStore *       modest_main_window_get_account_store     (ModestMainWindow *main_window);
 
 

diff --git a/src/widgets/modest-tny-stream-gtkhtml.h b/src/widgets/modest-tny-stream-gtkhtml.h
index d523e9c..42fd05a 100644 (file)
--- a/src/widgets/modest-tny-stream-gtkhtml.h
+++ b/src/widgets/modest-tny-stream-gtkhtml.h
@@ -60,6 +60,15 @@ struct _ModestTnyStreamGtkhtmlClass {
 
 GType       modest_tny_stream_gtkhtml_get_type    (void) G_GNUC_CONST;
 
+
+/**
+ * modest_tny_stream_gtkhtml_new:
+ * @stream: a #GtkHTMLStream
+ * 
+ * creates a new #ModestTnyStreamGtkhtml
+ * 
+ * Returns: a new #ModestTnyStreamGtkhtml
+ **/
 GObject*    modest_tny_stream_gtkhtml_new         (GtkHTMLStream* stream);
 
 

diff --git a/src/widgets/modest-toolbar.h b/src/widgets/modest-toolbar.h
deleted file mode 100644 (file)
index 4c069c5..0000000
--- a/src/widgets/modest-toolbar.h
+++ /dev/null
@@ -1,87 +0,0 @@
-/* Copyright (c) 2006, Nokia Corporation
- * All rights reserved.
- *
- * Redistribution and use in source and binary forms, with or without
- * modification, are permitted provided that the following conditions are
- * met:
- *
- * * Redistributions of source code must retain the above copyright
- *   notice, this list of conditions and the following disclaimer.
- * * Redistributions in binary form must reproduce the above copyright
- *   notice, this list of conditions and the following disclaimer in the
- *   documentation and/or other materials provided with the distribution.
- * * Neither the name of the Nokia Corporation nor the names of its
- *   contributors may be used to endorse or promote products derived from
- *   this software without specific prior written permission.
- *
- * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS
- * IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
- * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
- * PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER
- * OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
- * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
- * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
- * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
- * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
- * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
- * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
- */
-
-#ifndef __MODEST_TOOLBAR_H__
-#define __MODEST_TOOLBAR_H__
-
-#include <gtk/gtk.h>
-#include <modest-icon-factory.h>
-#include <modest-icon-names.h>
-
-G_BEGIN_DECLS
-
-/* convenience macros */
-#define MODEST_TYPE_TOOLBAR             (modest_toolbar_get_type())
-#define MODEST_TOOLBAR(obj)             (G_TYPE_CHECK_INSTANCE_CAST((obj),MODEST_TYPE_TOOLBAR,ModestToolbar))
-#define MODEST_TOOLBAR_CLASS(klass)     (G_TYPE_CHECK_CLASS_CAST((klass),MODEST_TYPE_TOOLBAR,GtkToolbar))
-#define MODEST_IS_TOOLBAR(obj)          (G_TYPE_CHECK_INSTANCE_TYPE((obj),MODEST_TYPE_TOOLBAR))
-#define MODEST_IS_TOOLBAR_CLASS(klass)  (G_TYPE_CHECK_CLASS_TYPE((klass),MODEST_TYPE_TOOLBAR))
-#define MODEST_TOOLBAR_GET_CLASS(obj)   (G_TYPE_INSTANCE_GET_CLASS((obj),MODEST_TYPE_TOOLBAR,ModestToolbarClass))
-
-typedef struct _ModestToolbar      ModestToolbar;
-typedef struct _ModestToolbarClass ModestToolbarClass;
-
-/* typedef enum _ModestToolbarButton ModestToolbarButton; */
-typedef enum _ModestToolbarButton {
-       MODEST_TOOLBAR_BUTTON_MAIL_SEND,
-       MODEST_TOOLBAR_BUTTON_NEW_MAIL,
-       MODEST_TOOLBAR_BUTTON_REPLY,
-       MODEST_TOOLBAR_BUTTON_REPLY_ALL,
-       MODEST_TOOLBAR_BUTTON_FORWARD,
-       MODEST_TOOLBAR_BUTTON_PRINT,
-       MODEST_TOOLBAR_BUTTON_DELETE,
-       MODEST_TOOLBAR_BUTTON_NEXT,
-       MODEST_TOOLBAR_BUTTON_PREV,
-       MODEST_TOOLBAR_BUTTON_STOP,
-       MODEST_TOOLBAR_BUTTON_SEND_RECEIVE,
-
-       MODEST_TOOLBAR_SEPARATOR,
-       MODEST_TOOLBAR_BUTTON_NUM
-} ModestToolbarButton;
-
-struct _ModestToolbar {
-        GtkToolbar parent;
-       /* insert public members, if any */
-};
-
-struct _ModestToolbarClass {
-       GtkToolbarClass parent_class;
-       
-       void (* button_clicked) (ModestToolbar* obj, ModestToolbarButton button_id);
-};
-
-/* member functions */
-GType        modest_toolbar_get_type    (void) G_GNUC_CONST;
-
-ModestToolbar*   modest_toolbar_new     (const GSList *buttons);
-
-G_END_DECLS
-
-#endif /* __MODEST_TOOLBAR_H__ */
-