[master 1/5] Add more links to gtk-doc comments

dashea installerbot-noreply at redhat.com
Wed Mar 4 15:41:16 UTC 2015


From: David Shea <dshea at redhat.com>

Expand some shortcut syntax that wasn't exactly working, and turn a
couple of function names into function links.
---
 widgets/src/BaseStandalone.c     |  6 ++++--
 widgets/src/BaseWindow.c         | 10 +++++-----
 widgets/src/DiskOverview.c       | 12 ++++++------
 widgets/src/LayoutIndicator.c    |  2 +-
 widgets/src/MountpointSelector.c | 11 ++++++-----
 widgets/src/SpokeSelector.c      | 11 ++++++-----
 6 files changed, 28 insertions(+), 24 deletions(-)

diff --git a/widgets/src/BaseStandalone.c b/widgets/src/BaseStandalone.c
index ffc5018..70813fe 100644
--- a/widgets/src/BaseStandalone.c
+++ b/widgets/src/BaseStandalone.c
@@ -84,7 +84,8 @@ static void anaconda_base_standalone_class_init(AnacondaBaseStandaloneClass *kla
      * AnacondaBaseStandalone::quit-clicked:
      * @window: the window that received the signal
      *
-     * Emitted when the quit button has been activated (pressed and released).
+     * Emitted when the #AnacondaBaseStandalone:quit-button has been activated
+     * (pressed and released).
      *
      * Since: 3.0
      */
@@ -100,7 +101,8 @@ static void anaconda_base_standalone_class_init(AnacondaBaseStandaloneClass *kla
      * AnacondaBaseStandalone::continue-clicked:
      * @window: the window that received the signal
      *
-     * Emitted when the continue button has been activated (pressed and released).
+     * Emitted when the #AnacondaBaseStandalone:continue-button has been
+     * activated (pressed and released).
      *
      * Since: 3.0
      */
diff --git a/widgets/src/BaseWindow.c b/widgets/src/BaseWindow.c
index 1074e56..4fc1cb3 100644
--- a/widgets/src/BaseWindow.c
+++ b/widgets/src/BaseWindow.c
@@ -147,7 +147,7 @@ static void anaconda_base_window_class_init(AnacondaBaseWindowClass *klass) {
     /**
      * AnacondaBaseWindow:distribution:
      *
-     * The :distribution string is displayed in the upper right corner of all
+     * The #AnacondaBaseWindow:distribution string is displayed in the upper right corner of all
      * windows throughout installation.
      *
      * Since: 1.0
@@ -610,7 +610,7 @@ static void anaconda_base_window_set_info_bar(AnacondaBaseWindow *win, GtkMessag
  *
  * Causes an info bar to be shown at the bottom of the screen with the provided
  * message.  Only one message may be shown at a time.  In order to show
- * a second message, anaconda_base_window_clear_info must first be called.
+ * a second message, anaconda_base_window_clear_info() must first be called.
  *
  * Since: 1.0
  */
@@ -625,7 +625,7 @@ void anaconda_base_window_set_error(AnacondaBaseWindow *win, const char *msg) {
  *
  * Causes an info bar to be shown at the bottom of the screen with the provided
  * message.  Only one message may be shown at a time.  In order to show
- * a second message, anaconda_base_window_clear_info must first be called.
+ * a second message, anaconda_base_window_clear_info() must first be called.
  *
  * Since: 1.0
  */
@@ -640,7 +640,7 @@ void anaconda_base_window_set_info(AnacondaBaseWindow *win, const char *msg) {
  *
  * Causes an info bar to be shown at the bottom of the screen with the provided
  * message.  Only one message may be shown at a time.  In order to show
- * a second message, anaconda_base_window_clear_info must first be called.
+ * a second message, anaconda_base_window_clear_info() must first be called.
  *
  * Since: 1.0
  */
@@ -663,7 +663,7 @@ static void anaconda_base_window_help_button_clicked(GtkButton *button,
  * @win: a #AnacondaBaseWindow
  *
  * Clear and hide any info bar being shown at the bottom of the screen.  This
- * must be called before a second call to anaconda_base_window_set_info takes
+ * must be called before a second call to anaconda_base_window_set_info() takes
  * effect.
  *
  * Since: 1.0
diff --git a/widgets/src/DiskOverview.c b/widgets/src/DiskOverview.c
index e7ff64b..b9ba6f1 100644
--- a/widgets/src/DiskOverview.c
+++ b/widgets/src/DiskOverview.c
@@ -98,7 +98,7 @@ static void anaconda_disk_overview_class_init(AnacondaDiskOverviewClass *klass)
     /**
      * AnacondaDiskOverview:kind:
      *
-     * The :kind string specifies what type of disk device this is, used to
+     * The #AnacondaDiskOverview:kind string specifies what type of disk device this is, used to
      * figure out what icon to be displayed.  This should be something like
      * "drive-harddisk", "drive-removable-media", etc.
      *
@@ -115,7 +115,7 @@ static void anaconda_disk_overview_class_init(AnacondaDiskOverviewClass *klass)
     /**
      * AnacondaDiskOverview:description:
      *
-     * The :description string is a very basic description of the device
+     * The #AnacondaDiskOverview:description string is a very basic description of the device
      * and is displayed in bold letters under the icon.
      *
      * Since: 1.0
@@ -131,7 +131,7 @@ static void anaconda_disk_overview_class_init(AnacondaDiskOverviewClass *klass)
     /**
      * AnacondaDiskOverview:capacity:
      *
-     * The :capacity string is the total size of the disk, plus units.
+     * The #AnacondaDiskOverview:capacity string is the total size of the disk, plus units.
      *
      * Since: 1.0
      */
@@ -146,7 +146,7 @@ static void anaconda_disk_overview_class_init(AnacondaDiskOverviewClass *klass)
     /**
      * AnacondaDiskOverview:free:
      *
-     * The :free string is the amount of free, unpartitioned space on the disk,
+     * The #AnacondaDiskOverview:free string is the amount of free, unpartitioned space on the disk,
      * plus units.
      *
      * Since: 1.0
@@ -162,7 +162,7 @@ static void anaconda_disk_overview_class_init(AnacondaDiskOverviewClass *klass)
     /**
      * AnacondaDiskOverview:name:
      *
-     * The :name string provides this device's node name (like 'sda').  Note
+     * The #AnacondaDiskOverview:name string provides this device's node name (like 'sda').  Note
      * that these names aren't guaranteed to be consistent across reboots but
      * their use is so ingrained that we need to continue displaying them.
      *
@@ -179,7 +179,7 @@ static void anaconda_disk_overview_class_init(AnacondaDiskOverviewClass *klass)
     /**
      * AnacondaDiskOverview:popup-info:
      *
-     * The :popup-info string is text that should appear in a tooltip when the
+     * The #AnacondaDiskOverview:popup-info string is text that should appear in a tooltip when the
      * #AnacondaDiskOverview is hovered over.  For normal disk devices, this
      * could be available space information.  For more complex devics, this
      * could be WWID, LUN, and so forth.
diff --git a/widgets/src/LayoutIndicator.c b/widgets/src/LayoutIndicator.c
index 9aac858..a42d074 100644
--- a/widgets/src/LayoutIndicator.c
+++ b/widgets/src/LayoutIndicator.c
@@ -97,7 +97,7 @@ static void anaconda_layout_indicator_class_init(AnacondaLayoutIndicatorClass *k
     /**
      * AnacondaLayoutIndicator:layout:
      *
-     * The :layout is the currently activated X layout.
+     * The #AnacondaLayoutIndicator:layout is the currently activated X layout.
      *
      * Since: 1.0
      */
diff --git a/widgets/src/MountpointSelector.c b/widgets/src/MountpointSelector.c
index d7c835f..4a9fbae 100644
--- a/widgets/src/MountpointSelector.c
+++ b/widgets/src/MountpointSelector.c
@@ -40,8 +40,9 @@
  * configuration.
  *
  * As a #AnacondaMountpointSelector is a subclass of a #GtkEventBox, any signals
- * may be caught.  However ::button-press-event is the most important one and is
- * how we determine what should be displayed on the rest of the screen.
+ * may be caught.  However #GtkWidget::button-press-event is the most important
+ * one and is how we determine what should be displayed on the rest of the
+ * screen.
  */
 
 enum {
@@ -84,7 +85,7 @@ static void anaconda_mountpoint_selector_class_init(AnacondaMountpointSelectorCl
     /**
      * AnacondaMountpointSelector:name:
      *
-     * The :name string is the secondary text displayed for this widget.  It is
+     * The #AnacondaMountpointSelector:name string is the secondary text displayed for this widget.  It is
      * commonly going to be the name of the device node containing this
      * mountpoint.
      *
@@ -101,7 +102,7 @@ static void anaconda_mountpoint_selector_class_init(AnacondaMountpointSelectorCl
     /**
      * AnacondaMountpointSelector:size:
      *
-     * The :size string is the size of the mountpoint, including whatever units
+     * The #AnacondaMountpointSelector:size string is the size of the mountpoint, including whatever units
      * it is measured in.
      *
      * Since: 1.0
@@ -117,7 +118,7 @@ static void anaconda_mountpoint_selector_class_init(AnacondaMountpointSelectorCl
     /**
      * AnacondaMountpointSelector:mountpoint:
      *
-     * The :mountpoint string is the primary text displayed for this widget.
+     * The #AnacondaMountpointSelector:mountpoint string is the primary text displayed for this widget.
      * It shows where on the filesystem this device is mounted.
      *
      * Since: 1.0
diff --git a/widgets/src/SpokeSelector.c b/widgets/src/SpokeSelector.c
index cd83efd..2e34ed6 100644
--- a/widgets/src/SpokeSelector.c
+++ b/widgets/src/SpokeSelector.c
@@ -89,7 +89,7 @@ static void anaconda_spoke_selector_class_init(AnacondaSpokeSelectorClass *klass
     /**
      * AnacondaSpokeSelector:icon:
      *
-     * The :icon string is the standard icon name for an icon to display
+     * The #AnacondaSpokeSelector:icon string is the standard icon name for an icon to display
      * beside this spoke's :title.  It is strongly suggested that one of the
      * "-symbolic" icons be used, as that is consistent with the style we
      * are going for.
@@ -107,10 +107,11 @@ static void anaconda_spoke_selector_class_init(AnacondaSpokeSelectorClass *klass
     /**
      * AnacondaSpokeSelector:status:
      *
-     * The :status string is text displayed underneath the spoke's :title and
-     * also beside the :icon.  This text very briefly describes what has been
-     * selected on the spoke associated with this selector.  For instance, it
-     * might be set up to "English" for a language-related spoke.  Special
+     * The #AnacondaSpokeSelector:status string is text displayed underneath
+     * the spoke's #AnacondaSpokeSelector:title and also beside the
+     * #AnacondaSpokeSelector:icon.  This text very briefly describes what has
+     * been selected on the spoke associated with this selector.  For instance,
+     * it might be set up to "English" for a language-related spoke.  Special
      * formatting will be applied to error status text for incomplete spokes.
      *
      * Since: 1.0


-- 
To view this commit on github, visit https://github.com/rhinstaller/anaconda/commit/e69ca8e619844fa3affed8c354d22ac7a83ee30b


More information about the anaconda-patches mailing list