* code cleanup

* added documentation

pmo-trunk-r254

diff --git a/src/modest-viewer-window.c b/src/modest-viewer-window.c
index e88f5b7..342a7aa 100644 (file)
--- a/src/modest-viewer-window.c
+++ b/src/modest-viewer-window.c
@@ -28,8 +28,6 @@ struct _ModestViewerWindowPrivate {
 /* globals */
 static GtkWindowClass *parent_class = NULL;
 
-/* uncomment the following if you have defined any signals */
-/* static guint signals[LAST_SIGNAL] = {0}; */
 
 GType
 modest_viewer_window_get_type (void)
@@ -94,9 +92,6 @@ modest_viewer_window_finalize (GObject *obj)
        if (priv->user_data)
                g_free(priv->user_data);
 
-//     if (priv->msg_view)
-//             gtk_widget_destroy(GTK_WIDGET(priv->msg_view));
-
        G_OBJECT_CLASS(parent_class)->finalize (obj);
 }
 
@@ -143,8 +138,6 @@ gpointer modest_viewer_window_get_data(ModestViewerWindow *viewer_win)
        }
        priv = MODEST_VIEWER_WINDOW_GET_PRIVATE(viewer_win);
 
-       // g_message("get priv->data = %p", priv->user_data);
-
        return priv->user_data;
 }
 
@@ -159,7 +152,5 @@ ModestTnyMsgView
        }
        priv = MODEST_VIEWER_WINDOW_GET_PRIVATE(viewer_win);
 
-       // g_message("get priv->data = %p", priv->user_data);
-
        return priv->msg_view;
 }

diff --git a/src/modest-viewer-window.h b/src/modest-viewer-window.h
index 98a3277..ef26bb9 100644 (file)
--- a/src/modest-viewer-window.h
+++ b/src/modest-viewer-window.h
@@ -5,7 +5,6 @@
 #define __MODEST_VIEWER_WINDOW_H__
 
 #include <gtk/gtkwindow.h>
-/* other include files */
 
 G_BEGIN_DECLS
 
@@ -22,31 +21,35 @@ typedef struct _ModestViewerWindowClass ModestViewerWindowClass;
 
 struct _ModestViewerWindow {
         GtkWindow parent;
-       /* insert public members, if any */
 };
 
 struct _ModestViewerWindowClass {
        GtkWindowClass parent_class;
-       /* insert signal callback declarations, eg. */
-       /* void (* my_event) (ModestViewerWindow* obj); */
 };
 
 /* member functions */
 GType        modest_viewer_window_get_type    (void) G_GNUC_CONST;
 
-/* typical parameter-less _new function */
-/* if this is a kind of GtkWidget, it should probably return at GtkWidget*, */
-/*    otherwise probably a GObject*. */
 GtkWidget*   modest_viewer_window_new (ModestUI *ui, TnyMsgIface *msg);
 
+/**
+ * modest_viewer_window_get_data:
+ * @viewer_win: a ModestViewerWindow instance
+ *
+ * Retrieves the data pointer that was set at creation of this instance
+ *
+ * Returns: the data pointer
+ */
 gpointer modest_viewer_window_get_data(ModestViewerWindow *viewer_win);
 
+/**
+ * modest_viewer_window_get_tiny_msg_view:
+ * @viewer_win: a ModestViewerWindow instance
+ *
+ * Returns: the ModestTnyMsgView widget from the viewer instance
+ */
 ModestTnyMsgView *modest_viewer_window_get_tiny_msg_view(ModestViewerWindow *viewer_win);
 
-/* fill in other public functions, eg.: */
-/*     void       modest_viewer_window_do_something (ModestViewerWindow *self, const gchar* param); */
-/*     gboolean   modest_viewer_window_has_foo      (ModestViewerWindow *self, gint value); */
-
 
 G_END_DECLS