GNOME.org
 

[gedit] doc: fix some compilation warnings

commit e4b308a1741e3ba189bf1761d0c16c4ae4cc085a
Author: Sébastien Wilmet <swilmet gnome org>
Date:   Sat Mar 8 13:26:43 2014 +0100

    doc: fix some compilation warnings

 docs/reference/gedit-sections.txt |   73 -------------------------------------
 gedit/gedit-document.c            |    7 ++--
 gedit/gedit-document.h            |    1 +
 gedit/gedit-file-chooser-dialog.c |    4 +-
 gedit/gedit-message-bus.c         |    3 +-
 gedit/gedit-message.c             |    3 +-
 gedit/gedit-message.h             |    7 ++--
 gedit/gedit-statusbar.c           |    4 ++-
 gedit/gedit-utils.c               |   10 ++++-
 9 files changed, 24 insertions(+), 88 deletions(-)
---
diff --git a/docs/reference/gedit-sections.txt b/docs/reference/gedit-sections.txt
index dccd60b..bb60f05 100644
--- a/docs/reference/gedit-sections.txt
+++ b/docs/reference/gedit-sections.txt
@@ -49,7 +49,6 @@ gedit_document_get_short_name_for_display
 gedit_document_get_mime_type
 gedit_document_get_readonly
 gedit_document_load
-gedit_document_insert_file
 gedit_document_load_cancel
 gedit_document_save
 gedit_document_save_as
@@ -138,45 +137,11 @@ GEDIT_MESSAGE_BUS_GET_CLASS
 </SECTION>
 
 <SECTION>
-<FILE>gedit-message-type</FILE>
-<TITLE>GeditMessageType</TITLE>
-GeditMessageType
-gedit_message_type_get_type
-gedit_message_type_is_supported
-gedit_message_type_identifier
-gedit_message_type_is_valid_object_path
-gedit_message_type_new
-gedit_message_type_new_valist
-gedit_message_type_ref
-gedit_message_type_unref
-gedit_message_type_set
-gedit_message_type_set_valist
-gedit_message_type_instantiate
-gedit_message_type_instantiate_valist
-gedit_message_type_get_object_path
-gedit_message_type_get_method
-gedit_message_type_lookup
-gedit_message_type_foreach
-<SUBSECTION Standard>
-GEDIT_TYPE_MESSAGE_TYPE
-</SECTION>
-
-<SECTION>
 <FILE>gedit-message</FILE>
 <TITLE>GeditMessage</TITLE>
 GeditMessage
-gedit_message_get
-gedit_message_get_valist
-gedit_message_get_value
-gedit_message_set
-gedit_message_set_valist
-gedit_message_set_value
-gedit_message_set_valuesv
 gedit_message_get_object_path
 gedit_message_get_method
-gedit_message_has_key
-gedit_message_get_key_type
-gedit_message_validate
 <SUBSECTION Standard>
 GEDIT_MESSAGE
 GEDIT_IS_MESSAGE
@@ -195,13 +160,9 @@ GeditNotebook
 gedit_notebook_new
 gedit_notebook_add_tab
 gedit_notebook_remove_all_tabs
-gedit_notebook_reorder_tab
 gedit_notebook_move_tab
-gedit_notebook_set_always_show_tabs
 gedit_notebook_set_close_buttons_sensitive
 gedit_notebook_get_close_buttons_sensitive
-gedit_notebook_set_tab_drag_and_drop_enabled
-gedit_notebook_get_tab_drag_and_drop_enabled
 <SUBSECTION Standard>
 GEDIT_NOTEBOOK
 GEDIT_IS_NOTEBOOK
@@ -213,28 +174,10 @@ GEDIT_NOTEBOOK_GET_CLASS
 </SECTION>
 
 <SECTION>
-<FILE>gedit-print-job-preview</FILE>
-GeditPrintJobPreviewPrivate
-<TITLE>GeditPrintJobPreview</TITLE>
-GeditPrintJobPreview
-gedit_print_job_preview_new
-<SUBSECTION Standard>
-GEDIT_PRINT_JOB_PREVIEW
-GEDIT_IS_PRINT_JOB_PREVIEW
-GEDIT_TYPE_PRINT_JOB_PREVIEW
-gedit_print_job_preview_get_type
-GEDIT_PRINT_JOB_PREVIEW_CLASS
-GEDIT_IS_PRINT_JOB_PREVIEW_CLASS
-GEDIT_PRINT_JOB_PREVIEW_GET_CLASS
-</SECTION>
-
-<SECTION>
 <FILE>gedit-print-job</FILE>
 <TITLE>GeditPrintJob</TITLE>
 GeditPrintJob
 gedit_print_job_new
-gedit_print_job_save_config
-gedit_print_dialog_new
 <SUBSECTION Standard>
 GEDIT_PRINT_JOB
 GEDIT_IS_PRINT_JOB
@@ -323,7 +266,6 @@ gedit_view_paste_clipboard
 gedit_view_delete_selection
 gedit_view_select_all
 gedit_view_scroll_to_cursor
-gedit_view_set_colors
 gedit_view_set_font
 <SUBSECTION Standard>
 GEDIT_VIEW
@@ -341,7 +283,6 @@ GEDIT_VIEW_GET_CLASS
 GeditViewActivatable
 gedit_view_activatable_activate
 gedit_view_activatable_deactivate
-gedit_view_activatable_update_state
 <SUBSECTION Standard>
 GEDIT_TYPE_VIEW_ACTIVATABLE
 GEDIT_VIEW_ACTIVATABLE
@@ -373,7 +314,6 @@ gedit_window_get_group
 gedit_window_get_side_panel
 gedit_window_get_bottom_panel
 gedit_window_get_statusbar
-gedit_window_get_ui_manager
 gedit_window_get_state
 gedit_window_get_tab_from_location
 gedit_window_get_message_bus
@@ -446,11 +386,6 @@ gedit_encoding_get_current
 </SECTION>
 
 <SECTION>
-<FILE>gedit-help</FILE>
-gedit_help_display
-</SECTION>
-
-<SECTION>
 <FILE>gedit-metadata-manager</FILE>
 gedit_metadata_manager_shutdown
 gedit_metadata_manager_get
@@ -465,24 +400,16 @@ IS_VALID_BOOLEAN
 gedit_utils_menu_position_under_widget
 gedit_utils_menu_position_under_tree_view
 gedit_utils_escape_underscores
-gedit_utils_escape_slashes
 gedit_utils_str_middle_truncate
-g_utf8_caselessnmatch
 gedit_utils_set_atk_name_description
 gedit_utils_set_atk_relation
-gedit_utils_uri_exists
-gedit_utils_get_stdin
 gedit_warning
 gedit_utils_make_valid_utf8
 gedit_utils_uri_get_dirname
 gedit_utils_replace_home_dir_with_tilde
 gedit_utils_get_current_workspace
 gedit_utils_get_window_workspace
-gedit_utils_activate_url
-gedit_utils_is_valid_uri
-gedit_utils_get_glade_widgets
 gedit_utils_make_canonical_uri_from_shell_arg
-gedit_utils_format_uri_for_display
 </SECTION>
 
 <SECTION>
diff --git a/gedit/gedit-document.c b/gedit/gedit-document.c
index 5460752..e0a3030 100644
--- a/gedit/gedit-document.c
+++ b/gedit/gedit-document.c
@@ -1151,7 +1151,7 @@ gedit_document_set_location (GeditDocument *doc,
 
 /**
  * gedit_document_get_uri_for_display:
- * @doc:
+ * @doc: a #GeditDocument.
  *
  * Note: this never returns %NULL.
  **/
@@ -1173,7 +1173,7 @@ gedit_document_get_uri_for_display (GeditDocument *doc)
 
 /**
  * gedit_document_get_short_name_for_display:
- * @doc:
+ * @doc: a #GeditDocument.
  *
  * Note: this never returns %NULL.
  **/
@@ -1224,7 +1224,7 @@ gedit_document_get_content_type (GeditDocument *doc)
 
 /**
  * gedit_document_get_mime_type:
- * @doc:
+ * @doc: a #GeditDocument.
  *
  * Note: this never returns %NULL.
  **/
@@ -1778,6 +1778,7 @@ gedit_document_save (GeditDocument          *doc,
  * @location: the location where to save the document.
  * @encoding: the #GeditEncoding to encode the document.
  * @newline_type: the #GeditDocumentNewlineType for the document.
+ * @compression_type: the compression type for the file.
  * @flags: optionnal #GeditDocumentSaveFlags.
  *
  * Save the document to a new location. This results in the "save" signal
diff --git a/gedit/gedit-document.h b/gedit/gedit-document.h
index 46fd34e..d47abcb 100644
--- a/gedit/gedit-document.h
+++ b/gedit/gedit-document.h
@@ -86,6 +86,7 @@ typedef enum
  * @GEDIT_DOCUMENT_SAVE_IGNORE_MTIME: save file despite external modifications.
  * @GEDIT_DOCUMENT_SAVE_IGNORE_BACKUP: write the file directly without attempting to backup.
  * @GEDIT_DOCUMENT_SAVE_PRESERVE_BACKUP: preserve previous backup file, needed to support autosaving.
+ * @GEDIT_DOCUMENT_SAVE_IGNORE_INVALID_CHARS: do not save invalid characters.
  */
 typedef enum
 {
diff --git a/gedit/gedit-file-chooser-dialog.c b/gedit/gedit-file-chooser-dialog.c
index e39873e..d6e9b20 100644
--- a/gedit/gedit-file-chooser-dialog.c
+++ b/gedit/gedit-file-chooser-dialog.c
@@ -450,6 +450,7 @@ gedit_file_chooser_dialog_new_valist (const gchar          *title,
  * @title: (allow-none): Title of the dialog, or %NULL
  * @parent: (allow-none): Transient parent of the dialog, or %NULL
  * @action: Open or save mode for the dialog
+ * @encoding: the encoding
  * @first_button_text: (allow-none): text to go in the first button, or %NULL
  * @...: (allow-none): response ID for the first button, then
  * additional (button, id) pairs, ending with %NULL
@@ -458,8 +459,7 @@ gedit_file_chooser_dialog_new_valist (const gchar          *title,
  * gtk_dialog_new_with_buttons().
  *
  * Return value: a new #GeditFileChooserDialog
- *
- **/
+ */
 GtkWidget *
 gedit_file_chooser_dialog_new (const gchar          *title,
                               GtkWindow            *parent,
diff --git a/gedit/gedit-message-bus.c b/gedit/gedit-message-bus.c
index 52faa29..3a8053a 100644
--- a/gedit/gedit-message-bus.c
+++ b/gedit/gedit-message-bus.c
@@ -1183,13 +1183,13 @@ create_message (GeditMessageBus *bus,
  * @bus: a #GeditMessageBus
  * @object_path: the object path
  * @method: the method
+ * @first_property: the first property
  * @...: NULL terminated list of key/value pairs
  *
  * This provides a convenient way to quickly send a message @method at
  * @object_path asynchronously over the bus. The variable argument list
  * specifies key (string) value pairs used to construct the message arguments.
  * To send a message synchronously use gedit_message_bus_send_sync().
- *
  */
 void
 gedit_message_bus_send (GeditMessageBus *bus,
@@ -1227,6 +1227,7 @@ gedit_message_bus_send (GeditMessageBus *bus,
  * @bus: a #GeditMessageBus
  * @object_path: the object path
  * @method: the method
+ * @first_property: the first property
  * @...: (allow-none): %NULL terminated list of key/value pairs
  *
  * This provides a convenient way to quickly send a message @method at
diff --git a/gedit/gedit-message.c b/gedit/gedit-message.c
index efff11e..0378e8d 100644
--- a/gedit/gedit-message.c
+++ b/gedit/gedit-message.c
@@ -38,8 +38,7 @@
  * who is the sender and who is the receiver. There is no explicit distinction
  * between methods and signals.
  *
- * Since: 2.25.3
- *
+ * Since: 2.26
  */
 
 enum
diff --git a/gedit/gedit-message.h b/gedit/gedit-message.h
index 1ead223..8b59514 100644
--- a/gedit/gedit-message.h
+++ b/gedit/gedit-message.h
@@ -35,10 +35,9 @@ G_BEGIN_DECLS
 #define GEDIT_IS_MESSAGE_CLASS(klass)          (G_TYPE_CHECK_CLASS_TYPE ((klass), GEDIT_TYPE_MESSAGE))
 #define GEDIT_MESSAGE_GET_CLASS(obj)           (G_TYPE_INSTANCE_GET_CLASS ((obj), GEDIT_TYPE_MESSAGE, 
GeditMessageClass))
 
-typedef struct _GeditMessage             GeditMessage;
-typedef struct _GeditMessageClass        GeditMessageClass;
-typedef struct _GeditMessagePrivate      GeditMessagePrivate;
-typedef struct _GeditMessageClassPrivate GeditMessageClassPrivate;
+typedef struct _GeditMessage        GeditMessage;
+typedef struct _GeditMessageClass   GeditMessageClass;
+typedef struct _GeditMessagePrivate GeditMessagePrivate;
 
 struct _GeditMessage
 {
diff --git a/gedit/gedit-statusbar.c b/gedit/gedit-statusbar.c
index edce4ce..081f930 100644
--- a/gedit/gedit-statusbar.c
+++ b/gedit/gedit-statusbar.c
@@ -193,13 +193,15 @@ remove_message_timeout (GeditStatusbar *statusbar)
  * @statusbar: a #GeditStatusbar
  * @context_id: message context_id
  * @format: message to flash on the statusbar
+ * @...: the arguments to insert in @format
  *
  * Flash a temporary message on the statusbar.
  */
 void
 gedit_statusbar_flash_message (GeditStatusbar *statusbar,
                               guint           context_id,
-                              const gchar    *format, ...)
+                              const gchar    *format,
+                              ...)
 {
        const guint32 flash_length = 3000; /* three seconds */
        va_list args;
diff --git a/gedit/gedit-utils.c b/gedit/gedit-utils.c
index 4bf4d55..2802ce2 100644
--- a/gedit/gedit-utils.c
+++ b/gedit/gedit-utils.c
@@ -416,8 +416,11 @@ gedit_utils_make_valid_utf8 (const char *name)
 
 /**
  * gedit_utils_uri_get_dirname:
+ * @uri: the URI.
  *
  * Note: this function replace home dir with ~
+ *
+ * Returns: the directory name.
  */
 gchar *
 gedit_utils_uri_get_dirname (const gchar *uri)
@@ -623,12 +626,15 @@ gedit_utils_get_current_workspace (GdkScreen *screen)
 
 /**
  * gedit_utils_get_window_workspace:
+ * @gtkwindow: a #GtkWindow.
  *
- * Get the workspace the window is on
+ * Get the workspace the window is on.
  *
  * This function gets the workspace that the #GtkWindow is visible on,
  * it returns GEDIT_ALL_WORKSPACES if the window is sticky, or if
- * the window manager doesn support this function
+ * the window manager doesn't support this function.
+ *
+ * Returns: the workspace the window is on.
  */
 guint
 gedit_utils_get_window_workspace (GtkWindow *gtkwindow)
[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]