diff options
author | Ernestas Kulik <ernestask@gnome.org> | 2018-03-18 17:39:23 +0200 |
---|---|---|
committer | Ernestas Kulik <ernestask@gnome.org> | 2018-03-19 08:42:25 +0200 |
commit | 5548a19921ea0a71ea3251aae2cd4ac42b5e72f2 (patch) | |
tree | 105e6e41d1d020b986f3ee6715cc0f34bfd0f04a | |
parent | bcfd90bb59e2eed1a14719eefa21463dd17ba3c9 (diff) | |
download | nautilus-5548a19921ea0a71ea3251aae2cd4ac42b5e72f2.tar.gz |
query-editor: Document public functions in header
So it’s a bit clearer how the return values or parameters should be
managed.
-rw-r--r-- | src/nautilus-query-editor.h | 32 |
1 files changed, 32 insertions, 0 deletions
diff --git a/src/nautilus-query-editor.h b/src/nautilus-query-editor.h index 7f8c97753..9d20dfc58 100644 --- a/src/nautilus-query-editor.h +++ b/src/nautilus-query-editor.h @@ -43,12 +43,44 @@ struct _NautilusQueryEditorClass GtkWidget *nautilus_query_editor_new (void); +/** + * nautilus_query_editor_get_query: + * + * @editor: A #NautilusQueryEditor instance. + * + * Returns: (nullable) (transfer full): The #NautilusQuery for the editor. + */ NautilusQuery *nautilus_query_editor_get_query (NautilusQueryEditor *editor); +/** + * nautilus_query_editor_set_query: + * + * @editor: A #NautilusQueryEditor instance. + * @query: (nullable) (transfer full): The #NautilusQuery for the search. + */ void nautilus_query_editor_set_query (NautilusQueryEditor *editor, NautilusQuery *query); +/** + * nautilus_query_editor_get_location: + * + * @editor: A #NautilusQueryEditor instance. + * + * Returns: (nullable) (transfer full): The location of the current search. + */ GFile *nautilus_query_editor_get_location (NautilusQueryEditor *editor); +/** + * nautilus_query_editor_set_location: + * + * @editor: A #NautilusQueryEditor instance. + * @location: (nullable) (transfer full): The location in which the search will take place. + */ void nautilus_query_editor_set_location (NautilusQueryEditor *editor, GFile *location); +/** + * nautilus_query_editor_set_text: + * + * @editor: A #NautilusQueryEditor instance. + * @text: (not nullable) (transfer none): The search text. + */ void nautilus_query_editor_set_text (NautilusQueryEditor *editor, const gchar *text); |