diff options
| -rw-r--r-- | pluma/pluma-app.c | 8 | ||||
| -rw-r--r-- | pluma/pluma-document.c | 19 | ||||
| -rw-r--r-- | pluma/pluma-file-chooser-dialog.c | 2 | ||||
| -rw-r--r-- | pluma/pluma-message-bus.c | 12 | ||||
| -rw-r--r-- | pluma/pluma-message-type.c | 6 | ||||
| -rw-r--r-- | pluma/pluma-message.c | 4 | ||||
| -rw-r--r-- | pluma/pluma-status-combo-box.c | 6 | ||||
| -rw-r--r-- | pluma/pluma-tab.c | 6 | ||||
| -rw-r--r-- | pluma/pluma-utils.c | 19 | ||||
| -rw-r--r-- | pluma/pluma-window.c | 24 |
10 files changed, 71 insertions, 35 deletions
diff --git a/pluma/pluma-app.c b/pluma/pluma-app.c index d9e713e4..90ed1b64 100644 --- a/pluma/pluma-app.c +++ b/pluma/pluma-app.c @@ -350,7 +350,7 @@ app_weak_notify (gpointer data, * Returns the #PlumaApp object. This object is a singleton and * represents the running pluma instance. * - * Return value: the #PlumaApp pointer + * Return value: (transfer none): the #PlumaApp pointer */ PlumaApp * pluma_app_get_default (void) @@ -555,7 +555,7 @@ pluma_app_create_window_real (PlumaApp *app, * * Create a new #PlumaWindow part of @app. * - * Return value: the new #PlumaWindow + * Return value: (transfer none): the new #PlumaWindow */ PlumaWindow * pluma_app_create_window (PlumaApp *app, @@ -592,7 +592,7 @@ _pluma_app_restore_window (PlumaApp *app, * * Returns all the windows currently present in #PlumaApp. * - * Return value: (transfer none): the list of #PlumaWindows objects. + * Return value: (element-type Pluma.Window) (transfer none): the list of #PlumaWindows objects. * The list should not be freed */ const GList * @@ -609,7 +609,7 @@ pluma_app_get_windows (PlumaApp *app) * * Retrives the #PlumaWindow currently active. * - * Return value: the active #PlumaWindow + * Return value: (transfer none): the active #PlumaWindow */ PlumaWindow * pluma_app_get_active_window (PlumaApp *app) diff --git a/pluma/pluma-document.c b/pluma/pluma-document.c index 85890566..b2745422 100644 --- a/pluma/pluma-document.c +++ b/pluma/pluma-document.c @@ -1039,6 +1039,13 @@ set_uri (PlumaDocument *doc, } } + +/** + * pluma_document_get_location: + * @doc: a #PlumaDocument + * + * Returns: (allow-none) (transfer full): a new #GFile + */ GFile * pluma_document_get_location (PlumaDocument *doc) { @@ -1777,7 +1784,7 @@ compute_num_of_lines (const gchar *text) } /** - * pluma_document_set_search_text" + * pluma_document_set_search_text: * @doc: * @text: (allow-none): * @flags: @@ -1876,7 +1883,7 @@ pluma_document_get_can_search_again (PlumaDocument *doc) * @start: (allow-none): * @end: (allow-none): * @match_start: (allow-none): - * @match_end: (allow=none): + * @match_end: (allow-none): **/ gboolean pluma_document_search_forward (PlumaDocument *doc, @@ -1953,7 +1960,7 @@ pluma_document_search_forward (PlumaDocument *doc, * @start: (allow-none): * @end: (allow-none): * @match_start: (allow-none): - * @match_end: (allow=none): + * @match_end: (allow-none): **/ gboolean pluma_document_search_backward (PlumaDocument *doc, @@ -2156,6 +2163,12 @@ pluma_document_set_language (PlumaDocument *doc, set_language (doc, lang, TRUE); } +/** + * pluma_document_get_language: + * @doc: + * + * Return value: (transfer none): + */ GtkSourceLanguage * pluma_document_get_language (PlumaDocument *doc) { diff --git a/pluma/pluma-file-chooser-dialog.c b/pluma/pluma-file-chooser-dialog.c index f23a4c0a..76c11d8a 100644 --- a/pluma/pluma-file-chooser-dialog.c +++ b/pluma/pluma-file-chooser-dialog.c @@ -463,7 +463,7 @@ pluma_file_chooser_dialog_new_valist (const gchar *title, * @action: Open or save mode for the dialog * @first_button_text: (allow-none): stock ID or text to go in * the first button, or %NULL - * @Varargs: (allow-none): response ID for the first button, then + * @...: (allow-none): response ID for the first button, then * additional (button, id) pairs, ending with %NULL * * Creates a new #PlumaFileChooserDialog. This function is analogous to diff --git a/pluma/pluma-message-bus.c b/pluma/pluma-message-bus.c index 84551bff..fd16c752 100644 --- a/pluma/pluma-message-bus.c +++ b/pluma/pluma-message-bus.c @@ -523,7 +523,7 @@ pluma_message_bus_init (PlumaMessageBus *self) * * Get the default application #PlumaMessageBus. * - * Return value: the default #PlumaMessageBus + * Return value: (transfer none): the default #PlumaMessageBus * */ PlumaMessageBus * @@ -794,7 +794,7 @@ foreach_type (const gchar *key, /** * pluma_message_bus_foreach: * @bus: the #PlumaMessagebus - * @func: the callback function + * @func: (scope call): the callback function * @userdata: the user data to supply to the callback function * * Calls @func for each message type registered on the bus @@ -872,7 +872,7 @@ pluma_message_bus_disconnect (PlumaMessageBus *bus, * @bus: a #PlumaMessageBus * @object_path: the object path * @method: the method - * @callback: the connected callback + * @callback: (scope call): the connected callback * @userdata: the userdata with which the callback was connected * * Disconnects a previously connected message callback by matching the @@ -915,7 +915,7 @@ pluma_message_bus_block (PlumaMessageBus *bus, * @bus: a #PlumaMessageBus * @object_path: the object path * @method: the method - * @callback: the callback to block + * @callback: (scope call): the callback to block * @userdata: the userdata with which the callback was connected * * Blocks evoking the callback that matches provided @callback and @userdata. @@ -956,7 +956,7 @@ pluma_message_bus_unblock (PlumaMessageBus *bus, * @bus: a #PlumaMessageBus * @object_path: the object path * @method: the method - * @callback: the callback to block + * @callback: (scope call): the callback to block * @userdata: the userdata with which the callback was connected * * Unblocks the callback that matches provided @callback and @userdata. @@ -1131,7 +1131,7 @@ pluma_message_bus_send (PlumaMessageBus *bus, * specifies key (string) value pairs used to construct the message * arguments. To send a message asynchronously use pluma_message_bus_send(). * - * Return value: the constructed #PlumaMessage. The caller owns a reference + * Return value: (transfer full): the constructed #PlumaMessage. The caller owns a reference * to the #PlumaMessage and should call g_object_unref() when * it is no longer needed */ diff --git a/pluma/pluma-message-type.c b/pluma/pluma-message-type.c index f399887b..77c7eca6 100644 --- a/pluma/pluma-message-type.c +++ b/pluma/pluma-message-type.c @@ -398,7 +398,7 @@ pluma_message_type_set_valist (PlumaMessageType *message_type, * Instantiate a new message from the message type with specific values * for the message arguments. * - * Return value: the newly created message + * Return value: (transfer full): the newly created message * */ PlumaMessage * @@ -423,7 +423,7 @@ pluma_message_type_instantiate_valist (PlumaMessageType *message_type, * Instantiate a new message from the message type with specific values * for the message arguments. * - * Return value: the newly created message + * Return value: (transfer full): the newly created message * */ PlumaMessage * @@ -509,7 +509,7 @@ foreach_gtype (const gchar *key, /** * pluma_message_type_foreach: * @message_type: the #PlumaMessageType - * @func: the callback function + * @func: (scope call): the callback function * @user_data: user data supplied to the callback function * * Calls @func for each argument in the message type. diff --git a/pluma/pluma-message.c b/pluma/pluma-message.c index 0e138b04..e6123243 100644 --- a/pluma/pluma-message.c +++ b/pluma/pluma-message.c @@ -367,8 +367,8 @@ pluma_message_set_value (PlumaMessage *message, /** * pluma_message_set_valuesv: * @message: the #PlumaMessage - * @keys: (array-length=n_values): keys to set values for - * @values: (array-length=n_values): values to set + * @keys: (array length=n_values): keys to set values for + * @values: (array length=n_values): values to set * @n_values: number of arguments to set values for * * Set message argument values. diff --git a/pluma/pluma-status-combo-box.c b/pluma/pluma-status-combo-box.c index e446b371..8b8d0004 100644 --- a/pluma/pluma-status-combo-box.c +++ b/pluma/pluma-status-combo-box.c @@ -409,6 +409,12 @@ pluma_status_combo_box_remove_item (PlumaStatusComboBox *combo, GTK_WIDGET (item)); } +/** + * pluma_status_combo_box_get_items: + * @combo: + * + * Returns: (element-type Gtk.Widget) (transfer container): + */ GList * pluma_status_combo_box_get_items (PlumaStatusComboBox *combo) { diff --git a/pluma/pluma-tab.c b/pluma/pluma-tab.c index 02fc2582..79339a90 100644 --- a/pluma/pluma-tab.c +++ b/pluma/pluma-tab.c @@ -1619,7 +1619,7 @@ _pluma_tab_new_from_uri (const gchar *uri, * * Gets the #PlumaView inside @tab. * - * Returns: the #PlumaView inside @tab + * Returns: (transfer none): the #PlumaView inside @tab */ PlumaView * pluma_tab_get_view (PlumaTab *tab) @@ -1633,7 +1633,7 @@ pluma_tab_get_view (PlumaTab *tab) * * Gets the #PlumaDocument associated to @tab. * - * Returns: the #PlumaDocument associated to @tab + * Returns: (transfer none): the #PlumaDocument associated to @tab */ PlumaDocument * pluma_tab_get_document (PlumaTab *tab) @@ -1958,7 +1958,7 @@ _pluma_tab_get_icon (PlumaTab *tab) * * Gets the #PlumaTab associated with @doc. * - * Returns: the #PlumaTab associated with @doc + * Returns: (transfer none): the #PlumaTab associated with @doc */ PlumaTab * pluma_tab_get_from_document (PlumaDocument *doc) diff --git a/pluma/pluma-utils.c b/pluma/pluma-utils.c index 09c7897d..a739401a 100644 --- a/pluma/pluma-utils.c +++ b/pluma/pluma-utils.c @@ -202,6 +202,14 @@ pluma_utils_menu_position_under_tree_view (GtkMenu *menu, } } +/** + * pluma_gtk_button_new_with_stock_icon: + * @label: + * @stock_id: + * + * Returns: (transfer full): + */ + GtkWidget * pluma_gtk_button_new_with_stock_icon (const gchar *label, const gchar *stock_id) @@ -216,6 +224,15 @@ pluma_gtk_button_new_with_stock_icon (const gchar *label, return button; } +/** + * pluma_dialog_add_button: + * @dialog: + * @text: + * @stock_id: + * @response_id: + * + * Returns: (transfer none): + */ GtkWidget * pluma_dialog_add_button (GtkDialog *dialog, const gchar *text, @@ -1373,7 +1390,7 @@ pluma_utils_uri_for_display (const gchar *uri) * * Create a list of valid uri's from a uri-list drop. * - * Return value: a string array which will hold the uris or %NULL if there + * Return value: (transfer full): a string array which will hold the uris or %NULL if there * were no valid uris. g_strfreev should be used when the * string array is no longer used */ diff --git a/pluma/pluma-window.c b/pluma/pluma-window.c index 2432aeaf..35571dfe 100644 --- a/pluma/pluma-window.c +++ b/pluma/pluma-window.c @@ -3954,7 +3954,7 @@ pluma_window_init (PlumaWindow *window) * * Gets the active #PlumaView. * - * Returns: the active #PlumaView + * Returns: (transfer none): the active #PlumaView */ PlumaView * pluma_window_get_active_view (PlumaWindow *window) @@ -3977,7 +3977,7 @@ pluma_window_get_active_view (PlumaWindow *window) * * Gets the active #PlumaDocument. * - * Returns: the active #PlumaDocument + * Returns: (transfer none): the active #PlumaDocument */ PlumaDocument * pluma_window_get_active_document (PlumaWindow *window) @@ -4009,7 +4009,7 @@ _pluma_window_get_notebook (PlumaWindow *window) * Creates a new #PlumaTab and adds the new tab to the #PlumaNotebook. * In case @jump_to is %TRUE the #PlumaNotebook switches to that new #PlumaTab. * - * Returns: a new #PlumaTab + * Returns: (transfer none): a new #PlumaTab */ PlumaTab * pluma_window_create_tab (PlumaWindow *window, @@ -4049,7 +4049,7 @@ pluma_window_create_tab (PlumaWindow *window, * Whether @create is %TRUE, creates a new empty document if location does * not refer to an existing file * - * Returns: a new #PlumaTab + * Returns: (transfer none): a new #PlumaTab */ PlumaTab * pluma_window_create_tab_from_uri (PlumaWindow *window, @@ -4093,7 +4093,7 @@ pluma_window_create_tab_from_uri (PlumaWindow *window, * * Gets the active #PlumaTab in the @window. * - * Returns: the active #PlumaTab in the @window. + * Returns: (transfer none): the active #PlumaTab in the @window. */ PlumaTab * pluma_window_get_active_tab (PlumaWindow *window) @@ -4303,7 +4303,7 @@ pluma_window_set_active_tab (PlumaWindow *window, * * Gets the #GtkWindowGroup in which @window resides. * - * Returns: the #GtkWindowGroup + * Returns: (transfer none): the #GtkWindowGroup */ GtkWindowGroup * pluma_window_get_group (PlumaWindow *window) @@ -4327,7 +4327,7 @@ _pluma_window_is_removing_tabs (PlumaWindow *window) * * Gets the #GtkUIManager associated with the @window. * - * Returns: the #GtkUIManager of the @window. + * Returns: (transfer none): the #GtkUIManager of the @window. */ GtkUIManager * pluma_window_get_ui_manager (PlumaWindow *window) @@ -4343,7 +4343,7 @@ pluma_window_get_ui_manager (PlumaWindow *window) * * Gets the side #PlumaPanel of the @window. * - * Returns: the side #PlumaPanel. + * Returns: (transfer none): the side #PlumaPanel. */ PlumaPanel * pluma_window_get_side_panel (PlumaWindow *window) @@ -4359,7 +4359,7 @@ pluma_window_get_side_panel (PlumaWindow *window) * * Gets the bottom #PlumaPanel of the @window. * - * Returns: the bottom #PlumaPanel. + * Returns: (transfer none): the bottom #PlumaPanel. */ PlumaPanel * pluma_window_get_bottom_panel (PlumaWindow *window) @@ -4375,7 +4375,7 @@ pluma_window_get_bottom_panel (PlumaWindow *window) * * Gets the #PlumaStatusbar of the @window. * - * Returns: the #PlumaStatusbar of the @window. + * Returns: (transfer none): the #PlumaStatusbar of the @window. */ GtkWidget * pluma_window_get_statusbar (PlumaWindow *window) @@ -4587,7 +4587,7 @@ _pluma_window_is_fullscreen (PlumaWindow *window) * * Gets the #PlumaTab that matches with the given @location. * - * Returns: the #PlumaTab that matches with the given @location. + * Returns: (transfer none): the #PlumaTab that matches with the given @location. */ PlumaTab * pluma_window_get_tab_from_location (PlumaWindow *window, @@ -4656,7 +4656,7 @@ pluma_window_get_message_bus (PlumaWindow *window) * * Gets the #PlumaTab that matches @uri. * - * Returns: the #PlumaTab associated with @uri. + * Returns: (transfer none): the #PlumaTab associated with @uri. * * Deprecated: 2.24: Use pluma_window_get_tab_from_location() instead. */ |