From 12ccc68c9917459e8962e2d302deefe3e815eafa Mon Sep 17 00:00:00 2001 From: Matthias Clasen Date: Fri, 19 Feb 2021 23:30:50 -0500 Subject: [PATCH] separator: Convert docs Change link syntax and add an example image. --- gtk/gtkseparator.c | 19 +++++++++++-------- 1 file changed, 11 insertions(+), 8 deletions(-) diff --git a/gtk/gtkseparator.c b/gtk/gtkseparator.c index fe9ac58437..180103adba 100644 --- a/gtk/gtkseparator.c +++ b/gtk/gtkseparator.c @@ -37,19 +37,22 @@ * @Short_description: A separator widget * @Title: GtkSeparator * - * GtkSeparator is a horizontal or vertical separator widget, depending on the - * value of the #GtkOrientable:orientation property, used to group the widgets - * within a window. It displays a line with a shadow to make it appear sunken - * into the interface. + * `GtkSeparator` is a horizontal or vertical separator widget. + * + * ![An example GtkSeparator](separators.png) + * + * A `GtkSeparator` can be used to group the widgets within a window. + * It displays a line with a shadow to make it appear sunken into the + * interface. * * # CSS nodes * - * GtkSeparator has a single CSS node with name separator. The node + * `GtkSeparator` has a single CSS node with name separator. The node * gets one of the .horizontal or .vertical style classes. * * # Accessibility * - * GtkSeparator uses the #GTK_ACCESSIBLE_ROLE_SEPARATOR role. + * `GtkSeparator` uses the #GTK_ACCESSIBLE_ROLE_SEPARATOR role. */ typedef struct _GtkSeparatorClass GtkSeparatorClass; @@ -160,9 +163,9 @@ gtk_separator_class_init (GtkSeparatorClass *class) * gtk_separator_new: * @orientation: the separator’s orientation. * - * Creates a new #GtkSeparator with the given orientation. + * Creates a new `GtkSeparator` with the given orientation. * - * Returns: a new #GtkSeparator. + * Returns: a new `GtkSeparator`. */ GtkWidget * gtk_separator_new (GtkOrientation orientation)