From cf3e4ae47341f5e72d389b5b5e35a1a778c14977 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?P=C5=99emysl=20Janouch?= <p.janouch@gmail.com>
Date: Fri, 28 Jan 2011 17:39:40 +0100
Subject: Fix program messages and gtk-doc comments.

---
 src/ld-window-main.c | 25 +++++++++----------------
 src/ld-window-main.h |  5 -----
 2 files changed, 9 insertions(+), 21 deletions(-)

(limited to 'src')

diff --git a/src/ld-window-main.c b/src/ld-window-main.c
index d59d2fd..f7d9f8d 100644
--- a/src/ld-window-main.c
+++ b/src/ld-window-main.c
@@ -16,13 +16,6 @@
 #include "ld-window-main.h"
 
 
-/**
- * SECTION:ld-window-main
- * @short_description: The main application window.
- *
- * #LdWindowMain is the main window of the application.
- */
-
 struct _LdWindowMainPrivate
 {
 	GtkUIManager *ui_manager;
@@ -361,7 +354,7 @@ update_title (LdWindowMain *self)
 
 /*
  * action_set_sensitive:
- * @sensitive: The sensitivity state.
+ * @sensitive: the sensitivity state.
  *
  * Set sensitivity of an action.
  */
@@ -461,7 +454,7 @@ diagram_get_name (LdWindowMain *self)
 
 /*
  * diagram_set_filename:
- * @filename: The new filename. May be NULL for a new, yet unsaved, file.
+ * @filename: (allow-none): the new filename. %NULL for a new file.
  *
  * Set the filename corresponding to the currently opened diagram.
  * The function takes ownership of the string.
@@ -524,7 +517,7 @@ diagram_save (LdWindowMain *self)
 	{
 		GtkWidget *message_dialog;
 
-		g_warning ("Saving failed: %s", error->message);
+		g_warning ("saving failed: %s", error->message);
 		g_error_free (error);
 
 		message_dialog = gtk_message_dialog_new (GTK_WINDOW (self),
@@ -546,7 +539,7 @@ diagram_save (LdWindowMain *self)
 /*
  * diagram_get_file_filter:
  *
- * Return value: A new #GtkFileFilter object for diagrams.
+ * Return value: a new #GtkFileFilter object for diagrams.
  */
 static GtkFileFilter *
 diagram_get_file_filter (void)
@@ -596,7 +589,7 @@ diagram_show_open_dialog (LdWindowMain *self)
 		{
 			GtkWidget *message_dialog;
 
-			g_warning ("Loading failed: %s", error->message);
+			g_warning ("loading failed: %s", error->message);
 			g_error_free (error);
 
 			message_dialog = gtk_message_dialog_new (GTK_WINDOW (self),
@@ -649,15 +642,15 @@ diagram_show_save_as_dialog (LdWindowMain *self)
 
 /*
  * may_close_diagram:
- * @dialog_message: The dialog message to display to the user if the diagram
+ * @dialog_message: the dialog message to display to the user if the diagram
  *                  has been modified.
  *
  * When no changes have been made to the current diagram, the function
  * lets the caller proceed. Otherwise the user is asked for further actions.
  * If he chooses to save the diagram, the function will handle this action.
  *
- * Return value: FALSE if the current action should be cancelled.
- *               TRUE if the caller may proceed.
+ * Return value: %FALSE if the current action should be cancelled.
+ *               %TRUE if the caller may proceed.
  */
 static gboolean
 may_close_diagram (LdWindowMain *self, const gchar *dialog_message)
@@ -714,7 +707,7 @@ may_close_diagram (LdWindowMain *self, const gchar *dialog_message)
  * A variant on may_close_diagram() for the occasion of closing
  * the whole application.
  *
- * Return value: TRUE if the application may quit, FALSE otherwise.
+ * Return value: %TRUE if the application may quit, %FALSE otherwise.
  */
 static gboolean
 may_quit (LdWindowMain *self)
diff --git a/src/ld-window-main.h b/src/ld-window-main.h
index df65a9b..8d28150 100644
--- a/src/ld-window-main.h
+++ b/src/ld-window-main.h
@@ -31,11 +31,6 @@ typedef struct _LdWindowMainPrivate LdWindowMainPrivate;
 typedef struct _LdWindowMainClass LdWindowMainClass;
 
 
-/**
- * LdWindowMain:
- *
- * Object structure.
- */
 struct _LdWindowMain
 {
 /*< private >*/
-- 
cgit v1.2.3