[gtk+] docs: don't use ulink. use markdown instead

From: William Jon McCann <mccann src gnome org>
To: commits-list gnome org
Cc:
Subject: [gtk+] docs: don't use ulink. use markdown instead
Date: Wed, 5 Feb 2014 00:11:05 +0000 (UTC)
commit 5dd751f0064fb124a839d7dd26fd15c305350d80
Author: William Jon McCann <william jon mccann gmail com>
Date:   Tue Feb 4 18:53:51 2014 -0500

    docs: don't use ulink. use markdown instead

 gtk/gtkclipboard.c        |    7 ++++---
 gtk/gtkcssprovider.c      |   13 ++++++-------
 gtk/gtkcsssection.h       |    9 ++++-----
 gtk/gtkcssstyleproperty.c |   18 +++++++++---------
 gtk/gtkcssvalue.c         |    5 ++---
 gtk/gtkdialog.c           |    7 ++++---
 gtk/gtkicontheme.c        |    7 +++----
 gtk/gtkmessagedialog.h    |    2 +-
 gtk/gtkpapersize.c        |    4 ++--
 gtk/gtkplug.c             |    4 ++--
 gtk/gtksettings.c         |    8 ++++----
 gtk/gtksocket.c           |    6 +++---
 gtk/gtkstatusicon.c       |    4 ++--
 gtk/gtkstylecontext.c     |    2 +-
 gtk/gtkwidget.c           |    2 +-
 gtk/gtkwindow.c           |   26 ++++++++++++--------------
 16 files changed, 60 insertions(+), 64 deletions(-)
---
diff --git a/gtk/gtkclipboard.c b/gtk/gtkclipboard.c
index 3bc6679..b3b5958 100644
--- a/gtk/gtkclipboard.c
+++ b/gtk/gtkclipboard.c
@@ -329,9 +329,10 @@ clipboard_display_closed (GdkDisplay   *display,
  * user sees as the clipboard.
  *
  * (Passing #GDK_NONE is the same as using `gdk_atom_intern
- * ("CLIPBOARD", FALSE)`. See <ulink
- * url="http://www.freedesktop.org/Standards/clipboards-spec";>
- * http://www.freedesktop.org/Standards/clipboards-spec</ulink>
+ * ("CLIPBOARD", FALSE)`.
+ *
+ * See the
+ * [FreeDesktop Clipboard Specification](http://www.freedesktop.org/Standards/clipboards-spec)
  * for a detailed discussion of the "CLIPBOARD" vs. "PRIMARY"
  * selections under the X window system. On Win32 the
  * #GDK_SELECTION_PRIMARY clipboard is essentially ignored.)
diff --git a/gtk/gtkcssprovider.c b/gtk/gtkcssprovider.c
index a030d1a..1d1805c 100644
--- a/gtk/gtkcssprovider.c
+++ b/gtk/gtkcssprovider.c
@@ -52,7 +52,7 @@
  * @See_also: #GtkStyleContext, #GtkStyleProvider
  *
  * GtkCssProvider is an object implementing the #GtkStyleProvider interface.
- * It is able to parse <ulink url="http://www.w3.org/TR/CSS2";>CSS</ulink>-like
+ * It is able to parse [CSS-like](http://www.w3.org/TR/CSS2)
  * input in order to style widgets.
  *
  * ## Default files
@@ -479,8 +479,8 @@
  * ## Text shadow
  *
  * A shadow list can be applied to text or symbolic icons, using the CSS3
- * text-shadow syntax, as defined in
- * <ulink url="http://www.w3.org/TR/css3-text/#text-shadow";>the CSS3 specification</ulink>.
+ * text-shadow syntax, as defined in the
+ * [CSS3 Specification](http://www.w3.org/TR/css3-text/#text-shadow).
  *
  * A text shadow is specified using the syntax
  * <literallayout>text-shadow: @horizontal_offset @vertical_offset [ @blur_radius ] @color</literallayout>
@@ -500,8 +500,8 @@
  * ## Box shadow
  *
  * Themes can apply shadows on framed elements using the CSS3 box-shadow syntax,
- * as defined in 
- * <ulink url="http://www.w3.org/TR/css3-background/#the-box-shadow";>the CSS3 specification</ulink>.
+ * as defined in the
+ * [CSS3 Specification](http://www.w3.org/TR/css3-background/#the-box-shadow).
  *
  * A box shadow is specified using the syntax
  * <literallayout>box-shadow: [ @inset ] @horizontal_offset @vertical_offset [ @blur_radius ] [ @spread ] 
@color</literallayout>
@@ -522,8 +522,7 @@
  *
  * Images and gradients can also be used in slices for the purpose of creating
  * scalable borders.
- * For more information, see the CSS3 documentation for the border-image property,
- * which can be found <ulink url="http://www.w3.org/TR/css3-background/#border-images";>here</ulink>.
+ * For more information, see the [CSS3 documentation for the border-image 
property](http://www.w3.org/TR/css3-background/#border-images).
  *
  * ![](slices.png)
  *
diff --git a/gtk/gtkcsssection.h b/gtk/gtkcsssection.h
index b26c587..7966982 100644
--- a/gtk/gtkcsssection.h
+++ b/gtk/gtkcsssection.h
@@ -40,13 +40,12 @@ G_BEGIN_DECLS
  * @GTK_CSS_SECTION_DECLARATION: The section defines the declaration of
  *   a CSS variable.
  * @GTK_CSS_SECTION_VALUE: The section defines the value of a CSS declaration.
- * @GTK_CSS_SECTION_KEYFRAMES: The section defines keyframes. See <ulink
- *   url="http://dev.w3.org/csswg/css3-animations/#keyframes";>CSS
- *   animations</ulink> for details. Since 3.6
+ * @GTK_CSS_SECTION_KEYFRAMES: The section defines keyframes. See [CSS
+ *   Animations](http://dev.w3.org/csswg/css3-animations/#keyframes) for details. Since 3.6
  *
  * The different types of sections indicate parts of a CSS document as
- * parsed by GTK's CSS parser. They are oriented towards the CSS grammar
- * <ulink url="http://www.w3.org/TR/CSS21/grammar.html";>CSS grammer</ulink>,
+ * parsed by GTK's CSS parser. They are oriented towards the
+ * [CSS Grammar](http://www.w3.org/TR/CSS21/grammar.html),
  * but may contain extensions.
  *
  * More types might be added in the future as the parser incorporates
diff --git a/gtk/gtkcssstyleproperty.c b/gtk/gtkcssstyleproperty.c
index 0b74915..33d6bda 100644
--- a/gtk/gtkcssstyleproperty.c
+++ b/gtk/gtkcssstyleproperty.c
@@ -387,9 +387,9 @@ _gtk_css_style_property_lookup_by_id (guint id)
  * _gtk_css_style_property_is_inherit:
  * @property: the property
  *
- * Queries if the given @property is inherited. See
- * <ulink url="http://www.w3.org/TR/css3-cascade/#inheritance>
- * the CSS documentation</ulink> for an explanation of this concept.
+ * Queries if the given @property is inherited. See the
+ * [CSS Documentation](http://www.w3.org/TR/css3-cascade/#inheritance)
+ * for an explanation of this concept.
  *
  * Returns: %TRUE if the property is inherited by default.
  **/
@@ -405,9 +405,9 @@ _gtk_css_style_property_is_inherit (GtkCssStyleProperty *property)
  * _gtk_css_style_property_is_animated:
  * @property: the property
  *
- * Queries if the given @property can be is animated. See
- * <ulink url="http://www.w3.org/TR/css3-transitions/#animatable-css>
- * the CSS documentation</ulink> for animatable properties.
+ * Queries if the given @property can be is animated. See the
+ * [CSS Documentation](http://www.w3.org/TR/css3-transitions/#animatable-css)
+ * for animatable properties.
  *
  * Returns: %TRUE if the property can be animated.
  **/
@@ -476,9 +476,9 @@ _gtk_css_style_property_get_id (GtkCssStyleProperty *property)
  * _gtk_css_style_property_get_initial_value:
  * @property: the property
  *
- * Queries the initial value of the given @property. See
- * <ulink url="http://www.w3.org/TR/css3-cascade/#intial>
- * the CSS documentation</ulink> for an explanation of this concept.
+ * Queries the initial value of the given @property. See the
+ * [CSS Documentation](http://www.w3.org/TR/css3-cascade/#intial)
+ * for an explanation of this concept.
  *
  * Returns: a reference to the initial value. The value will never change.
  **/
diff --git a/gtk/gtkcssvalue.c b/gtk/gtkcssvalue.c
index 8ee780d..fb9dfe3 100644
--- a/gtk/gtkcssvalue.c
+++ b/gtk/gtkcssvalue.c
@@ -78,9 +78,8 @@ _gtk_css_value_unref (GtkCssValue *value)
  *
  * Converts the specified @value into the computed value for the CSS
  * property given by @property_id using the information in @context.
- * This step is explained in detail in
- * <ulink url="http://www.w3.org/TR/css3-cascade/#computed>
- * the CSS documentation</ulink>.
+ * This step is explained in detail in the
+ * [CSS Documentation](http://www.w3.org/TR/css3-cascade/#computed).
  *
  * Returns: the computed value
  **/
diff --git a/gtk/gtkdialog.c b/gtk/gtkdialog.c
index 722206a..49590e2 100644
--- a/gtk/gtkdialog.c
+++ b/gtk/gtkdialog.c
@@ -1457,15 +1457,16 @@ gtk_dialog_set_alternative_button_order_valist (GtkDialog *dialog,
  * the dialog buttons are reordered according to the order of the
  * response ids passed to this function.
  *
- * By default, GTK+ dialogs use the button order advocated by the Gnome
- * <ulink url="http://library.gnome.org/devel/hig-book/stable/";>Human
- * Interface Guidelines</ulink> with the affirmative button at the far
+ * By default, GTK+ dialogs use the button order advocated by the
+ * [GNOME Human Interface Guidelines](http://library.gnome.org/devel/hig-book/stable/)
+ * with the affirmative button at the far
  * right, and the cancel button left of it. But the builtin GTK+ dialogs
  * and #GtkMessageDialog<!-- -->s do provide an alternative button order,
  * which is more suitable on some platforms, e.g. Windows.
  *
  * Use this function after adding all the buttons to your dialog, as the
  * following example shows:
+ *
  * |[<!-- language="C" -->
  * cancel_button = gtk_dialog_add_button (GTK_DIALOG (dialog),
  *                                        _("_Cancel"),
diff --git a/gtk/gtkicontheme.c b/gtk/gtkicontheme.c
index 0b7f078..fe3088c 100644
--- a/gtk/gtkicontheme.c
+++ b/gtk/gtkicontheme.c
@@ -70,9 +70,8 @@
  * providing a filename is to allow different icons to be used
  * depending on what “icon theme” is selected
  * by the user. The operation of icon themes on Linux and Unix
- * follows the <ulink
- * url="http://www.freedesktop.org/Standards/icon-theme-spec";>Icon
- * Theme Specification</ulink>. There is a default icon theme,
+ * follows the [Icon Theme Specification](http://www.freedesktop.org/Standards/icon-theme-spec)
+ * There is a default icon theme,
  * named `hicolor` where applications should install
  * their icons, but more additional application themes can be
  * installed as operating system vendors and users choose.
@@ -4321,7 +4320,7 @@ _gtk_icon_info_load_symbolic_internal (GtkIconInfo  *icon_info,
  * and use the 'fg', 'success', 'warning' and 'error' CSS styles in the
  * SVG file itself.
  *
- * See the <ulink url="http://www.freedesktop.org/wiki/SymbolicIcons";>Symbolic Icons spec</ulink>
+ * See the [Symbolic Icons Specification](http://www.freedesktop.org/wiki/SymbolicIcons)
  * for more information about symbolic icons.
  *
  * Return value: (transfer full): a #GdkPixbuf representing the loaded icon
diff --git a/gtk/gtkmessagedialog.h b/gtk/gtkmessagedialog.h
index b78ce6f..973e39c 100644
--- a/gtk/gtkmessagedialog.h
+++ b/gtk/gtkmessagedialog.h
@@ -80,7 +80,7 @@ struct _GtkMessageDialogClass
  * <note>
  *  Please note that %GTK_BUTTONS_OK, %GTK_BUTTONS_YES_NO
  *  and %GTK_BUTTONS_OK_CANCEL are discouraged by the
- *  <ulink url="http://library.gnome.org/devel/hig-book/stable/";>GNOME HIG</ulink>.
+ *  [GNOME Human Interface Guidelines](http://library.gnome.org/devel/hig-book/stable/).
  * </note>
  */
 typedef enum
diff --git a/gtk/gtkpapersize.c b/gtk/gtkpapersize.c
index cece2be..d0e8bfb 100644
--- a/gtk/gtkpapersize.c
+++ b/gtk/gtkpapersize.c
@@ -45,7 +45,7 @@
  * @See_also:#GtkPageSetup
  *
  * GtkPaperSize handles paper sizes. It uses the standard called
- * <ulink url="http://www.pwg.org/standards.html";>"PWG 5101.1-2002 PWG: Standard for Media Standardized 
Names"</ulink>
+ * [PWG 5101.1-2002 PWG: Standard for Media Standardized Names](http://www.pwg.org/standards.html)
  * to name the paper sizes (and to get the data for the page sizes).
  * In addition to standard paper sizes, GtkPaperSize allows to
  * construct custom paper sizes with arbitrary dimensions.
@@ -209,7 +209,7 @@ gtk_paper_size_new_from_info (const PaperInfo *info)
  * @name: (allow-none): a paper size name, or %NULL
  *
  * Creates a new #GtkPaperSize object by parsing a
- * <ulink url="ftp://ftp.pwg.org/pub/pwg/candidates/cs-pwgmsn10-20020226-5101.1.pdf";>PWG 5101.1-2002</ulink>
+ * [PWG 5101.1-2002](ftp://ftp.pwg.org/pub/pwg/candidates/cs-pwgmsn10-20020226-5101.1.pdf)
  * paper name.
  *
  * If @name is %NULL, the default paper size is returned,
diff --git a/gtk/gtkplug.c b/gtk/gtkplug.c
index 6c88172..f855fb4 100644
--- a/gtk/gtkplug.c
+++ b/gtk/gtkplug.c
@@ -55,8 +55,8 @@
  * application's window.
  *
  * The communication between a #GtkSocket and a #GtkPlug follows the
- * <ulink url="http://www.freedesktop.org/Standards/xembed-spec";>XEmbed</ulink>
- * protocol. This protocol has also been implemented in other toolkits,
+ * [XEmbed Protocol](http://www.freedesktop.org/Standards/xembed-spec).
+ * This protocol has also been implemented in other toolkits,
  * e.g. Qt, allowing the same level of
  * integration when embedding a Qt widget
  * in GTK+ or vice versa.
diff --git a/gtk/gtksettings.c b/gtk/gtksettings.c
index 88f2907..d04a10a 100644
--- a/gtk/gtksettings.c
+++ b/gtk/gtksettings.c
@@ -67,7 +67,7 @@
  * applications.
  *
  * On the X window system, this sharing is realized by an
- * <ulink url="http://www.freedesktop.org/wiki/Specifications/xsettings-spec";>XSettings</ulink>
+ * [XSettings](http://www.freedesktop.org/wiki/Specifications/xsettings-spec)
  * manager that is usually part of the desktop environment, along with
  * utilities that let the user change these settings. In the absence of
  * an Xsettings manager, GTK+ reads default values for settings from
@@ -1108,7 +1108,7 @@ gtk_settings_class_init (GtkSettingsClass *class)
    *
    * The XDG sound theme to use for event sounds.
    *
-   * See the <ulink url="http://www.freedesktop.org/wiki/Specifications/sound-theme-spec";>Sound Theme 
spec</ulink>
+   * See the [Sound Theme Specifications](http://www.freedesktop.org/wiki/Specifications/sound-theme-spec)
    * for more information on event sounds and sound themes.
    *
    * GTK+ itself does not support event sounds, you have to use a loadable
@@ -1130,7 +1130,7 @@ gtk_settings_class_init (GtkSettingsClass *class)
    *
    * Whether to play event sounds as feedback to user input.
    *
-   * See the <ulink url="http://www.freedesktop.org/wiki/Specifications/sound-theme-spec";>Sound Theme 
spec</ulink>
+   * See the [Sound Theme Specifications](http://www.freedesktop.org/wiki/Specifications/sound-theme-spec)
    * for more information on event sounds and sound themes.
    *
    * GTK+ itself does not support event sounds, you have to use a loadable
@@ -1153,7 +1153,7 @@ gtk_settings_class_init (GtkSettingsClass *class)
    *
    * Whether to play any event sounds at all.
    *
-   * See the <ulink url="http://www.freedesktop.org/wiki/Specifications/sound-theme-spec";>Sound Theme 
spec</ulink>
+   * See the [Sound Theme Specifications](http://www.freedesktop.org/wiki/Specifications/sound-theme-spec)
    * for more information on event sounds and sound themes.
    *
    * GTK+ itself does not support event sounds, you have to use a loadable
diff --git a/gtk/gtksocket.c b/gtk/gtksocket.c
index 7dbb52c..a8293e4 100644
--- a/gtk/gtksocket.c
+++ b/gtk/gtksocket.c
@@ -55,7 +55,7 @@
  * @Short_description: Container for widgets from other processes
  * @Title: GtkSocket
  * @include: gtk/gtkx.h
- * @See_also: #GtkPlug, <ulink url="http://www.freedesktop.org/Standards/xembed-spec";>XEmbed</ulink>
+ * @See_also: #GtkPlug, [XEmbed Protocol](http://www.freedesktop.org/Standards/xembed-spec)
  *
  * Together with #GtkPlug, #GtkSocket provides the ability to embed
  * widgets from one process into another process in a fashion that
@@ -100,8 +100,8 @@
  * happening, you can connect to the #GtkSocket::plug-removed signal.
  *
  * The communication between a #GtkSocket and a #GtkPlug follows the
- * <ulink url="http://www.freedesktop.org/Standards/xembed-spec";>XEmbed</ulink>
- * protocol. This protocol has also been implemented in other toolkits,
+ * [XEmbed Protocol](http://www.freedesktop.org/Standards/xembed-spec).
+ * This protocol has also been implemented in other toolkits,
  * e.g. Qt, allowing the same level of
  * integration when embedding a Qt widget
  * in GTK or vice versa.
diff --git a/gtk/gtkstatusicon.c b/gtk/gtkstatusicon.c
index aa72340..b006e7e 100644
--- a/gtk/gtkstatusicon.c
+++ b/gtk/gtkstatusicon.c
@@ -73,8 +73,8 @@
  * visible (e.g. when the user doesn't have a notification area on his panel).
  * This can be checked with gtk_status_icon_is_embedded().
  *
- * On X11, the implementation follows the freedesktop.org "System Tray"
- * <ulink url="http://www.freedesktop.org/wiki/Specifications/systemtray-spec";>specification</ulink>.
+ * On X11, the implementation follows the
+ * [FreeDesktop System Tray Specification](http://www.freedesktop.org/wiki/Specifications/systemtray-spec).
  * Implementations of the "tray" side of this specification can
  * be found e.g. in the GNOME 2 and KDE panel applications.
  *
diff --git a/gtk/gtkstylecontext.c b/gtk/gtkstylecontext.c
index 11498a5..11cd25d 100644
--- a/gtk/gtkstylecontext.c
+++ b/gtk/gtkstylecontext.c
@@ -1597,7 +1597,7 @@ gtk_style_context_get_path (GtkStyleContext *context)
  *
  * Sets the parent style context for @context. The parent style
  * context is used to implement
- * <ulink url="http://www.w3.org/TR/css3-cascade/#inheritance";>inheritance</ulink>
+ * [inheritance](http://www.w3.org/TR/css3-cascade/#inheritance)
  * of properties.
  *
  * If you are using a #GtkStyleContext returned from
diff --git a/gtk/gtkwidget.c b/gtk/gtkwidget.c
index e792fde..6718eae 100644
--- a/gtk/gtkwidget.c
+++ b/gtk/gtkwidget.c
@@ -12730,7 +12730,7 @@ _gtk_widget_peek_accessible (GtkWidget *widget)
  * class for which such an implementation is defined.
  *
  * The documentation of the
- * <ulink url="http://developer.gnome.org/atk/stable/";>ATK</ulink>
+ * [ATK](http://developer.gnome.org/atk/stable/)
  * library contains more information about accessible objects and their uses.
  *
  * Returns: (transfer none): the #AtkObject associated with @widget
diff --git a/gtk/gtkwindow.c b/gtk/gtkwindow.c
index e21ba39..cf65f34 100644
--- a/gtk/gtkwindow.c
+++ b/gtk/gtkwindow.c
@@ -4953,10 +4953,8 @@ gtk_window_get_size (GtkWindow *window,
  * gdk_screen_height () - window_height)` (note that this
  * example does not take multi-head scenarios into account).
  *
- * The Extended Window Manager Hints specification at <ulink
- * url="http://www.freedesktop.org/Standards/wm-spec";>
- * http://www.freedesktop.org/Standards/wm-spec</ulink> has a
- * nice table of gravities in the "implementation notes" section.
+ * The [Extended Window Manager Hints Specification](http://www.freedesktop.org/Standards/wm-spec)
+ * has a nice table of gravities in the "implementation notes" section.
  *
  * The gtk_window_get_position() documentation may also be relevant.
  */
@@ -10320,11 +10318,11 @@ gtk_window_unfullscreen (GtkWindow *window)
  * You can track the above state via the "window-state-event" signal
  * on #GtkWidget.
  *
- * Note that, according to the <ulink 
- * url="http://www.freedesktop.org/Standards/wm-spec";>Extended Window 
- * Manager Hints</ulink> specification, the above state is mainly meant 
- * for user preferences and should not be used by applications e.g. for 
- * drawing attention to their dialogs.
+ * Note that, according to the
+ * [Extended Window Manager Hints Specification](http://www.freedesktop.org/Standards/wm-spec),
+ * the above state is mainly meant for user preferences and should not
+ * be used by applications e.g. for drawing attention to their
+ * dialogs.
  *
  * Since: 2.4
  **/
@@ -10371,11 +10369,11 @@ gtk_window_set_keep_above (GtkWindow *window,
  * You can track the below state via the "window-state-event" signal
  * on #GtkWidget.
  *
- * Note that, according to the <ulink 
- * url="http://www.freedesktop.org/Standards/wm-spec";>Extended Window 
- * Manager Hints</ulink> specification, the above state is mainly meant 
- * for user preferences and should not be used by applications e.g. for 
- * drawing attention to their dialogs.
+ * Note that, according to the
+ * [Extended Window Manager Hints Specification](http://www.freedesktop.org/Standards/wm-spec),
+ * the above state is mainly meant for user preferences and should not
+ * be used by applications e.g. for drawing attention to their
+ * dialogs.
  *
  * Since: 2.4
  **/
[Date Prev][Date Next] [Thread Prev][Thread Next] [Thread Index] [Date Index] [Author Index]