[gtk/wip/matthiasc/listview-fixups: 11/15] signalistitemfactory: Tweak the docs
- From: Matthias Clasen <matthiasc src gnome org>
- To: commits-list gnome org
- Cc:
- Subject: [gtk/wip/matthiasc/listview-fixups: 11/15] signalistitemfactory: Tweak the docs
- Date: Fri, 13 Dec 2019 03:59:17 +0000 (UTC)
commit a8699311f3f55be9b2bc960383970c74bb84f7e9
Author: Matthias Clasen <mclasen redhat com>
Date: Thu Dec 12 22:35:44 2019 -0500
signalistitemfactory: Tweak the docs
gtk/gtksignallistitemfactory.c | 22 +++++++++++-----------
1 file changed, 11 insertions(+), 11 deletions(-)
---
diff --git a/gtk/gtksignallistitemfactory.c b/gtk/gtksignallistitemfactory.c
index fa6aca49fd..c1c8ada1f6 100644
--- a/gtk/gtksignallistitemfactory.c
+++ b/gtk/gtksignallistitemfactory.c
@@ -35,31 +35,31 @@
* that user code can connect to to manage listitems.
* Signals are emitted for every listitem in the same order:
*
- * 1. GtkSignalListItemFactory::setup is emitted to set up permanent things
+ * 1. #GtkSignalListItemFactory::setup is emitted to set up permanent things
* on the listitem. This usually means constructing the widgets used in the
* row and adding them to the listitem.
*
- * 2. GtkSignalListItemFactory::bind is called to bind the item passed via
- * GtkListItem:item to the widgets that have been created in step 1 or to
+ * 2. #GtkSignalListItemFactory::bind is emitted to bind the item passed via
+ * #GtkListItem:item to the widgets that have been created in step 1 or to
* add item-specific widgets. Signals are connected to listen to changes -
* both to changes in the item to update the widgets or to changes in the
* widgets to update the item. After this signal has been called, the
* listitem may be shown in a list widget.
*
- * 3. GtkSignalListItemFactory::unbind is called to undo everything done
+ * 3. #GtkSignalListItemFactory::unbind is emitted to undo everything done
* in step 2. Usually this means disconnecting signal handlers. Once this
* signal has been called, the listitem will no longer be used in a list
* widget.
*
- * 4. GtkSignalListItemFactory::bind and GtkSignalListItemFactory::unbind
- * may be called multiple times again to bind the listitem for use with
+ * 4. #GtkSignalListItemFactory::bind and #GtkSignalListItemFactory::unbind
+ * may be emitted multiple times again to bind the listitem for use with
* new items. By reusing listitems, potentially costly setup can be
* avoided. However, it means code needs to make sure to properly clean
* up the listitem in step 3 so that no information from the previous
* use leaks into the next use.
*
- * 5. GtkSignalListItemFactory::teardown is called to allow undoing the
- * effects of GtkSignalListItemFactory::setup. After this signal was emitted
+ * 5. #GtkSignalListItemFactory::teardown is emitted to allow undoing the
+ * effects of #GtkSignalListItemFactory::setup. After this signal was emitted
* on a listitem, the listitem will be destroyed and not be used again.
*
* Note that during the signal emissions, changing properties on the
@@ -67,9 +67,9 @@
* notifications are frozen. See g_object_freeze_notify() for details.
*
* For tracking changes in other properties in the #GtkListItem, the
- * GtkListItem::notify signal is recommended. The signal can be connected
- * in the GtkSignalListItemFactory::setup signal and removed again during
- * GtkSignalListItemFactory::teardown.
+ * #GtkListItem::notify signal is recommended. The signal can be connected
+ * in the #GtkSignalListItemFactory::setup signal and removed again during
+ * #GtkSignalListItemFactory::teardown.
*/
struct _GtkSignalListItemFactory
[
Date Prev][
Date Next] [
Thread Prev][
Thread Next]
[
Thread Index]
[
Date Index]
[
Author Index]