diff options
author | Jamie Murphy <hello@itsjamie.dev> | 2022-07-12 09:56:14 -0700 |
---|---|---|
committer | Jamie Murphy <hello@itsjamie.dev> | 2022-07-12 09:56:14 -0700 |
commit | b8cb45146b026b0c80c36dece405b1b9e430217c (patch) | |
tree | 04944635a4210f068346343c16dd2f709cafb075 | |
parent | 7ee3b78e44f59a2661d3372199a5ad31a3d121d2 (diff) | |
download | gnome-todo-b8cb45146b026b0c80c36dece405b1b9e430217c.tar.gz |
project: Fix documentation comments
-rw-r--r-- | src/core/gtd-manager.c | 2 | ||||
-rw-r--r-- | src/core/gtd-manager.h | 2 | ||||
-rw-r--r-- | src/core/gtd-provider.c | 19 | ||||
-rw-r--r-- | src/core/gtd-task-list.c | 12 | ||||
-rw-r--r-- | src/core/gtd-task.c | 26 | ||||
-rw-r--r-- | src/core/gtd-task.h | 32 | ||||
-rw-r--r-- | src/gui/gtd-max-size-layout.c | 8 | ||||
-rw-r--r-- | src/gui/gtd-menu-button.c | 42 | ||||
-rw-r--r-- | src/gui/gtd-menu-button.h | 2 | ||||
-rw-r--r-- | src/gui/gtd-omni-area-addin.h | 4 | ||||
-rw-r--r-- | src/gui/gtd-window.c | 8 | ||||
-rw-r--r-- | src/gui/gtd-window.h | 14 | ||||
-rw-r--r-- | src/gui/gtd-workspace.c | 2 |
13 files changed, 95 insertions, 78 deletions
diff --git a/src/core/gtd-manager.c b/src/core/gtd-manager.c index 87c77646..b499b76c 100644 --- a/src/core/gtd-manager.c +++ b/src/core/gtd-manager.c @@ -760,7 +760,7 @@ gtd_manager_set_is_first_run (GtdManager *self, * @self: a #GtdManager * @title: (nullable): the title of the error * @description: (nullable): detailed description of the error - * @function: (nullable): function to be called when the notification is dismissed + * @function: (scope call)(nullable): function to be called when the notification is dismissed * @user_data: user data * * Reports an error. diff --git a/src/core/gtd-manager.h b/src/core/gtd-manager.h index 0b993f4e..68d661ba 100644 --- a/src/core/gtd-manager.h +++ b/src/core/gtd-manager.h @@ -62,7 +62,7 @@ gboolean gtd_manager_get_is_first_run (GtdManager void gtd_manager_set_is_first_run (GtdManager *manager, gboolean is_first_run); -void gtd_manager_emit_error_message (GtdManager *manager, +void gtd_manager_emit_error_message (GtdManager *self, const gchar *title, const gchar *description, GtdErrorActionFunc function, diff --git a/src/core/gtd-provider.c b/src/core/gtd-provider.c index 60ed85ff..1d69a802 100644 --- a/src/core/gtd-provider.c +++ b/src/core/gtd-provider.c @@ -315,7 +315,8 @@ gtd_provider_get_icon (GtdProvider *provider) /** * gtd_provider_create_task: * @provider: a #GtdProvider - * @task: a #GtdTask + * @list: a #GtdTaskLast + * @title: The task title * @due_date: (nullable): a #GDateTime * @cancellable: (nullable): a #GCancellable * @callback: (scope async): a callback @@ -348,7 +349,7 @@ gtd_provider_create_task (GtdProvider *provider, * gtd_provider_create_task_finish: * @self: a #GtdProvider * @result: a #GAsyncResult - * @error: (direction out)(nullable): return location for a #GError + * @error: (out)(nullable): return location for a #GError * * Finishes creating the task. * @@ -397,7 +398,7 @@ gtd_provider_update_task (GtdProvider *provider, * gtd_provider_update_task_finish: * @self: a #GtdProvider * @result: a #GAsyncResult - * @error: (direction out)(nullable): return location for a #GError + * @error: (out)(nullable): return location for a #GError * * Finishes updating the task list. * @@ -446,7 +447,7 @@ gtd_provider_remove_task (GtdProvider *provider, * gtd_provider_remove_task_finish: * @self: a #GtdProvider * @result: a #GAsyncResult - * @error: (direction out)(nullable): return location for a #GError + * @error: (out)(nullable): return location for a #GError * * Finishes removing the task. * @@ -495,7 +496,7 @@ gtd_provider_create_task_list (GtdProvider *provider, * gtd_provider_create_task_list_finish: * @self: a #GtdProvider * @result: a #GAsyncResult - * @error: (direction out)(nullable): return location for a #GError + * @error: (out)(nullable): return location for a #GError * * Finishes creating the task list. The provider will emit the * GtdProvider:list-added signal after creating the task list. @@ -542,15 +543,15 @@ gtd_provider_update_task_list (GtdProvider *provider, } /** - * gtd_provider_create_task_list_finish: + * gtd_provider_update_task_list_finish: * @self: a #GtdProvider * @result: a #GAsyncResult - * @error: (direction out)(nullable): return location for a #GError + * @error: (out)(nullable): return location for a #GError * * Finishes updating the task list. The provider will emit the * GtdProvider:list-updated signal after updating the task list. * - * Returns: %TRUE if task list was successfully created, %FALSE otherwise + * Returns: %TRUE if task list was successfully updated, %FALSE otherwise */ gboolean gtd_provider_update_task_list_finish (GtdProvider *self, @@ -595,7 +596,7 @@ gtd_provider_remove_task_list (GtdProvider *provider, * gtd_provider_remove_task_list_finish: * @self: a #GtdProvider * @result: a #GAsyncResult - * @error: (direction out)(nullable): return location for a #GError + * @error: (out)(nullable): return location for a #GError * * Finishes removing the task list. The provider will emit the * GtdProvider:list-removed signal after removing the task list. diff --git a/src/core/gtd-task-list.c b/src/core/gtd-task-list.c index 08287141..faa9fff7 100644 --- a/src/core/gtd-task-list.c +++ b/src/core/gtd-task-list.c @@ -938,7 +938,7 @@ gtd_task_list_set_is_removable (GtdTaskList *list, /** * gtd_task_list_get_task_by_id: - * @list: a #GtdTaskList + * @self: a #GtdTaskList * @id: the id of the task * * Retrieves a task from @self with the given @id. @@ -1118,6 +1118,16 @@ gtd_task_list_import_task (GtdTaskList *self, data); } +/** + * gtd_task_list_import_task_finish: + * @self: a #GtdTaskList + * @result: a #GAsyncResult + * @error: a #GError + * + * Imports task into @self + * + * Returns: (transfer full): a #GTask + */ GTask * gtd_task_list_import_task_finish (GtdTaskList *self, GAsyncResult *result, diff --git a/src/core/gtd-task.c b/src/core/gtd-task.c index 7c97afe7..6c8e661c 100644 --- a/src/core/gtd-task.c +++ b/src/core/gtd-task.c @@ -531,7 +531,7 @@ gtd_task_get_complete (GtdTask *self) /** * gtd_task_set_complete: - * @task: a #GtdTask + * @self: a #GtdTask * @complete: the new value * * Updates the complete state of @task. @@ -552,7 +552,7 @@ gtd_task_set_complete (GtdTask *task, /** * gtd_task_get_creation_date: - * @task: a #GtdTask + * @self: a #GtdTask * * Returns the #GDateTime that represents the task's creation date. * The value is referenced for thread safety. Returns %NULL if @@ -571,7 +571,7 @@ gtd_task_get_creation_date (GtdTask *task) /** * gtd_task_set_creation_date: - * @task: a #GtdTask + * @self: a #GtdTask * * Sets the creation date of @task. */ @@ -591,7 +591,7 @@ gtd_task_set_creation_date (GtdTask *task, /** * gtd_task_get_completion_date: - * @task: a #GtdTask + * @self: a #GtdTask * * Returns the #GDateTime that represents the task's completion date. * Returns %NULL if no date is set. @@ -609,7 +609,7 @@ gtd_task_get_completion_date (GtdTask *task) /** * gtd_task_get_description: - * @task: a #GtdTask + * @self: a #GtdTask * * Retrieves the description of the task. * @@ -625,7 +625,7 @@ gtd_task_get_description (GtdTask *task) /** * gtd_task_set_description: - * @task: a #GtdTask + * @self: a #GtdTask * @description: (nullable): the new description, or %NULL * * Updates the description of @task. The string is not stripped off of @@ -652,7 +652,7 @@ gtd_task_set_description (GtdTask *task, /** * gtd_task_get_due_date: - * @task: a #GtdTask + * @self: a #GtdTask * * Returns the #GDateTime that represents the task's due date. * The value is referenced for thread safety. Returns %NULL if @@ -671,7 +671,7 @@ gtd_task_get_due_date (GtdTask *task) /** * gtd_task_set_due_date: - * @task: a #GtdTask + * @self: a #GtdTask * @dt: (nullable): a #GDateTime * * Updates the internal @GtdTask::due-date property. @@ -754,7 +754,7 @@ gtd_task_get_list (GtdTask *task) /** * gtd_task_set_list: - * @task: a #GtdTask + * @self: a #GtdTask * @list: (nullable): a #GtdTaskList * * Sets the parent #GtdTaskList of @task. @@ -783,7 +783,7 @@ gtd_task_set_list (GtdTask *task, /** * gtd_task_get_position: - * @task: a #GtdTask + * @self: a #GtdTask * * Returns the position of @task inside the parent #GtdTaskList, * or -1 if not set. @@ -800,7 +800,7 @@ gtd_task_get_position (GtdTask *self) /** * gtd_task_set_position: - * @task: a #GtdTask + * @self: a #GtdTask * @position: the priority of @task, or -1 * * Sets the @task position inside the parent #GtdTaskList. It @@ -823,7 +823,7 @@ gtd_task_set_position (GtdTask *self, /** * gtd_task_get_title: - * @task: a #GtdTask + * @self: a #GtdTask * * Retrieves the title of the task, or %NULL. * @@ -843,7 +843,7 @@ gtd_task_get_title (GtdTask *task) /** * gtd_task_set_title: - * @task: a #GtdTask + * @self: a #GtdTask * @title: (nullable): the new title, or %NULL * * Updates the title of @task. The string is stripped off of diff --git a/src/core/gtd-task.h b/src/core/gtd-task.h index 170f4a2e..0c2b5aab 100644 --- a/src/core/gtd-task.h +++ b/src/core/gtd-task.h @@ -51,14 +51,14 @@ struct _GtdTaskClass GDateTime* (*get_due_date) (GtdTask *self); void (*set_due_date) (GtdTask *self, - GDateTime *due_date); + GDateTime *dt); gboolean (*get_important) (GtdTask *self); void (*set_important) (GtdTask *self, gboolean important); - gint64 (*get_position) (GtdTask *task); - void (*set_position) (GtdTask *task, + gint64 (*get_position) (GtdTask *self); + void (*set_position) (GtdTask *self, gint64 position); const gchar* (*get_title) (GtdTask *self); @@ -70,26 +70,26 @@ struct _GtdTaskClass GtdTask* gtd_task_new (void); -gboolean gtd_task_get_complete (GtdTask *task); +gboolean gtd_task_get_complete (GtdTask *self); -void gtd_task_set_complete (GtdTask *task, +void gtd_task_set_complete (GtdTask *self, gboolean complete); -GDateTime* gtd_task_get_creation_date (GtdTask *task); +GDateTime* gtd_task_get_creation_date (GtdTask *self); -void gtd_task_set_creation_date (GtdTask *task, +void gtd_task_set_creation_date (GtdTask *self, GDateTime *dt); -GDateTime* gtd_task_get_completion_date (GtdTask *task); +GDateTime* gtd_task_get_completion_date (GtdTask *self); -const gchar* gtd_task_get_description (GtdTask *task); +const gchar* gtd_task_get_description (GtdTask *self); -void gtd_task_set_description (GtdTask *task, +void gtd_task_set_description (GtdTask *self, const gchar *description); -GDateTime* gtd_task_get_due_date (GtdTask *task); +GDateTime* gtd_task_get_due_date (GtdTask *self); -void gtd_task_set_due_date (GtdTask *task, +void gtd_task_set_due_date (GtdTask *self, GDateTime *dt); gboolean gtd_task_get_important (GtdTask *self); @@ -97,9 +97,9 @@ gboolean gtd_task_get_important (GtdTask *sel void gtd_task_set_important (GtdTask *self, gboolean important); -GtdTaskList* gtd_task_get_list (GtdTask *task); +GtdTaskList* gtd_task_get_list (GtdTask *self); -void gtd_task_set_list (GtdTask *task, +void gtd_task_set_list (GtdTask *self, GtdTaskList *list); gint64 gtd_task_get_position (GtdTask *self); @@ -107,9 +107,9 @@ gint64 gtd_task_get_position (GtdTask *sel void gtd_task_set_position (GtdTask *self, gint64 position); -const gchar* gtd_task_get_title (GtdTask *task); +const gchar* gtd_task_get_title (GtdTask *self); -void gtd_task_set_title (GtdTask *task, +void gtd_task_set_title (GtdTask *self, const gchar *title); gint gtd_task_compare (GtdTask *t1, diff --git a/src/gui/gtd-max-size-layout.c b/src/gui/gtd-max-size-layout.c index 391b08fd..348b2edd 100644 --- a/src/gui/gtd-max-size-layout.c +++ b/src/gui/gtd-max-size-layout.c @@ -334,7 +334,7 @@ gtd_max_size_layout_get_max_height (GtdMaxSizeLayout *self) /** * gtd_max_size_layout_set_max_height: * @self: a #GtdMaxSizeLayout - * @with_chars: maximum height of the widget @self is attached to + * @max_height: maximum height of the widget @self is attached to * * Sets the maximum height @self has. */ @@ -373,7 +373,7 @@ gtd_max_size_layout_get_max_width (GtdMaxSizeLayout *self) /** * gtd_max_size_layout_set_max_width: * @self: a #GtdMaxSizeLayout - * @with_chars: maximum width of the widget @self is attached to + * @max_width: maximum width of the widget @self is attached to * * Sets the maximum width @self has. */ @@ -411,7 +411,7 @@ gtd_max_size_layout_get_max_width_chars (GtdMaxSizeLayout *self) /** * gtd_max_size_layout_set_max_width_chars: * @self: a #GtdMaxSizeLayout - * @with_chars: maximum width of the widget @self is attached to, in character length + * @max_width_chars: maximum width of the widget @self is attached to, in character length * * Sets the maximum width @self has, in characters length. It is a programming * error to set a value smaller than #GtdMaxSizeLayout:width-layout. @@ -451,7 +451,7 @@ gtd_max_size_layout_get_width_chars (GtdMaxSizeLayout *self) /** * gtd_max_size_layout_set_width_chars: * @self: a #GtdMaxSizeLayout - * @with_chars: minimum width of the widget @self is attached to, in character length + * @width_chars: minimum width of the widget @self is attached to, in character length * * Sets the minimum width @self has, in characters length. It is a programming * error to set a value bigger than #GtdMaxSizeLayout:max-width-layout. diff --git a/src/gui/gtd-menu-button.c b/src/gui/gtd-menu-button.c index d53f2060..e9f12beb 100644 --- a/src/gui/gtd-menu-button.c +++ b/src/gui/gtd-menu-button.c @@ -541,7 +541,7 @@ gtd_menu_button_new (void) /** * gtd_menu_button_set_menu_model: - * @menu_button: a #GtdMenuButton + * @self: a #GtdMenuButton * @menu_model: (nullable): a #GMenuModel, or %NULL to unset and disable the * button * @@ -588,7 +588,7 @@ gtd_menu_button_set_menu_model (GtdMenuButton *self, /** * gtd_menu_button_get_menu_model: - * @menu_button: a #GtdMenuButton + * @self: a #GtdMenuButton * * Returns the #GMenuModel used to generate the popup. * @@ -606,7 +606,7 @@ gtd_menu_button_get_menu_model (GtdMenuButton *self) /** * gtd_menu_button_set_align_widget: - * @menu_button: a #GtdMenuButton + * @self: a #GtdMenuButton * @align_widget: (allow-none): a #GtkWidget * * Sets the #GtkWidget to use to line the menu with when popped up. @@ -637,7 +637,7 @@ gtd_menu_button_set_align_widget (GtdMenuButton *self, /** * gtd_menu_button_get_align_widget: - * @menu_button: a #GtdMenuButton + * @self: a #GtdMenuButton * * Returns the parent #GtkWidget to use to line up with menu. * @@ -655,7 +655,7 @@ gtd_menu_button_get_align_widget (GtdMenuButton *self) /** * gtd_menu_button_set_direction: - * @menu_button: a #GtdMenuButton + * @self: a #GtdMenuButton * @direction: a #GtkArrowType * * Sets the direction in which the popup will be popped up, as @@ -694,7 +694,7 @@ gtd_menu_button_set_direction (GtdMenuButton *self, /** * gtd_menu_button_get_direction: - * @menu_button: a #GtdMenuButton + * @self: a #GtdMenuButton * * Returns the direction the popup will be pointing at when popped up. * @@ -712,7 +712,7 @@ gtd_menu_button_get_direction (GtdMenuButton *self) /** * gtd_menu_button_set_popover: - * @menu_button: a #GtdMenuButton + * @self: a #GtdMenuButton * @popover: (nullable): a #GtkPopover, or %NULL to unset and disable the button * * Sets the #GtkPopover that will be popped up when the @menu_button is clicked, @@ -764,7 +764,7 @@ gtd_menu_button_set_popover (GtdMenuButton *self, /** * gtd_menu_button_get_popover: - * @menu_button: a #GtdMenuButton + * @self: a #GtdMenuButton * * Returns the #GtkPopover that pops out of the button. * If the button is not using a #GtkPopover, this function @@ -784,7 +784,7 @@ gtd_menu_button_get_popover (GtdMenuButton *self) /** * gtd_menu_button_set_icon_name: - * @menu_button: a #GtdMenuButton + * @self: a #GtdMenuButton * @icon_name: the icon name * * Sets the name of an icon to show inside the menu button. @@ -817,12 +817,12 @@ gtd_menu_button_set_gicon (GtdMenuButton *self, } /** - * gtd_menu_button_get_icon_name: - * @menu_button: a #GtdMenuButton + * gtd_menu_button_get_gicon: + * @self: a #GtdMenuButton * * Gets the name of the icon shown in the button. * - * Returns: the name of the icon shown in the button + * Returns: (transfer full): the name of the icon shown in the button */ GIcon* gtd_menu_button_get_gicon (GtdMenuButton *self) @@ -836,7 +836,7 @@ gtd_menu_button_get_gicon (GtdMenuButton *self) /** * gtd_menu_button_set_label: - * @menu_button: a #GtdMenuButton + * @self: a #GtdMenuButton * @label: the label * * Sets the label to show inside the menu button. @@ -872,7 +872,7 @@ gtd_menu_button_set_label (GtdMenuButton *self, /** * gtd_menu_button_get_label: - * @menu_button: a #GtdMenuButton + * @self: a #GtdMenuButton * * Gets the label shown in the button * @@ -898,7 +898,7 @@ gtd_menu_button_get_label (GtdMenuButton *self) /** * gtd_menu_button_set_has_frame: - * @menu_button: a #GtdMenuButton + * @self: a #GtdMenuButton * @has_frame: whether the button should have a visible frame * * Sets the style of the button. @@ -920,7 +920,7 @@ gtd_menu_button_set_has_frame (GtdMenuButton *self, /** * gtd_menu_button_get_has_frame: - * @menu_button: a #GtdMenuButton + * @self: a #GtdMenuButton * * Returns whether the button has a frame. * @@ -938,7 +938,7 @@ gtd_menu_button_get_has_frame (GtdMenuButton *self) /** * gtd_menu_button_popup: - * @menu_button: a #GtdMenuButton + * @self: a #GtdMenuButton * * Pop up the menu. */ @@ -954,7 +954,7 @@ gtd_menu_button_popup (GtdMenuButton *self) /** * gtd_menu_button_popdown: - * @menu_button: a #GtdMenuButton + * @self: a #GtdMenuButton * * Dismiss the menu. */ @@ -970,7 +970,7 @@ gtd_menu_button_popdown (GtdMenuButton *self) /** * gtd_menu_button_set_create_popup_func: - * @menu_button: a #GtdMenuButton + * @self: a #GtdMenuButton * @func: (nullable): function to call when a popuop is about to * be shown, but none has been provided via other means, or %NULL * to reset to default behavior. @@ -1011,7 +1011,7 @@ gtd_menu_button_set_create_popup_func (GtdMenuButton *self, /** * gtd_menu_button_set_use_underline: - * @menu_button: a #GtdMenuButton + * @self: a #GtdMenuButton * @use_underline: %TRUE if underlines in the text indicate mnemonics * * If true, an underline in the text indicates the next character should be @@ -1037,7 +1037,7 @@ gtd_menu_button_set_use_underline (GtdMenuButton *self, /** * gtd_menu_button_get_use_underline: - * @menu_button: a #GtdMenuButton + * @self: a #GtdMenuButton * * Returns whether an embedded underline in the text indicates a * mnemonic. See gtd_menu_button_set_use_underline(). diff --git a/src/gui/gtd-menu-button.h b/src/gui/gtd-menu-button.h index 091fcf7f..191806a4 100644 --- a/src/gui/gtd-menu-button.h +++ b/src/gui/gtd-menu-button.h @@ -34,7 +34,7 @@ struct _GtdMenuButtonClass /** * GtdMenuButtonCreatePopupFunc: - * @menu_button: the #GtdMenuButton + * @self: the #GtdMenuButton * * User-provided callback function to create a popup for @menu_button on demand. * This function is called when the popoup of @menu_button is shown, but none has diff --git a/src/gui/gtd-omni-area-addin.h b/src/gui/gtd-omni-area-addin.h index 7a6bc977..28e3bd93 100644 --- a/src/gui/gtd-omni-area-addin.h +++ b/src/gui/gtd-omni-area-addin.h @@ -34,10 +34,10 @@ struct _GtdOmniAreaAddinInterface GTypeInterface parent; void (*load) (GtdOmniAreaAddin *self, - GtdOmniArea *omni_area); + GtdOmniArea *omni_bar); void (*unload) (GtdOmniAreaAddin *self, - GtdOmniArea *omni_area); + GtdOmniArea *omni_bar); }; void gtd_omni_area_addin_load (GtdOmniAreaAddin *self, diff --git a/src/gui/gtd-window.c b/src/gui/gtd-window.c index 1545f8cf..81ee0e3e 100644 --- a/src/gui/gtd-window.c +++ b/src/gui/gtd-window.c @@ -541,6 +541,14 @@ gtd_window_cancel_notification (GtdWindow *self, gtd_notification_widget_cancel (self->notification_widget, notification); } +/** + * gtd_window_get_current_workspace: + * @self: a #GtdWindow + * + * Retrieves the currently active workspace + * + * Returns: (transfer full): a #GtdWorkspace + */ GtdWorkspace* gtd_window_get_current_workspace (GtdWindow *self) { diff --git a/src/gui/gtd-window.h b/src/gui/gtd-window.h index 594662d9..63034f95 100644 --- a/src/gui/gtd-window.h +++ b/src/gui/gtd-window.h @@ -30,21 +30,19 @@ G_BEGIN_DECLS G_DECLARE_FINAL_TYPE (GtdWindow, gtd_window, GTD, WINDOW, AdwApplicationWindow) -GtkWidget* gtd_window_new (GtdApplication *application); +GtkWidget* gtd_window_new (GtdApplication *application); -GtdManager* gtd_window_get_manager (GtdWindow *window); +void gtd_window_notify (GtdWindow *window, + GtdNotification *notification); -void gtd_window_notify (GtdWindow *window, - GtdNotification *notification); - -void gtd_window_cancel_notification (GtdWindow *window, - GtdNotification *notification); +void gtd_window_cancel_notification (GtdWindow *window, + GtdNotification *notification); void gtd_window_embed_widget_in_header (GtdWindow *self, GtkWidget *widget, GtkPositionType position); -GtdWorkspace* gtd_window_get_current_workspace (GtdWindow *self); +GtdWorkspace* gtd_window_get_current_workspace (GtdWindow *self); G_END_DECLS diff --git a/src/gui/gtd-workspace.c b/src/gui/gtd-workspace.c index d0c96ccc..ad1b1c03 100644 --- a/src/gui/gtd-workspace.c +++ b/src/gui/gtd-workspace.c @@ -105,7 +105,7 @@ gtd_workspace_get_priority (GtdWorkspace *self) } /** - * gtd_workspace_get_priority: + * gtd_workspace_get_icon: * @self: a #GtdWorkspace * * Retrieves the icon of @self. It is mandatory to implement |