Commit 24160953 authored by Oliver Galvin's avatar Oliver Galvin Committed by Guido Gunther
Browse files

docs: Consistently use full sentences in short descriptions.

parent 8d9d418d
......@@ -13,7 +13,7 @@
</refmeta>
<refnamediv>
<refname>Compiling with &package_string;</refname><refpurpose>Notes on compiling</refpurpose>
<refname>Compiling with &package_string;</refname><refpurpose>Notes on compiling.</refpurpose>
</refnamediv>
<refsect2>
......
......@@ -10,7 +10,7 @@
<bookinfo>
<title>&package_name; Reference Manual</title>
<releaseinfo>
<para>This document is the API reference for &package_name; &package_version;</para>
<para>This document is the API reference for &package_name; &package_version;.</para>
<para>
<ulink type="http" url="&package_url;">Handy</ulink> is a library to help you write apps for GTK/GNOME based mobile phones.
</para>
......
......@@ -12,7 +12,7 @@
<manvolnum>3</manvolnum>
</refmeta>
<refnamediv>
<refname>Widgets in &package_string;</refname><refpurpose>Widget overview</refpurpose>
<refname>Widgets in &package_string;</refname><refpurpose>Widget overview.</refpurpose>
</refnamediv>
<refsect2>
......
......@@ -11,7 +11,7 @@
/**
* SECTION:hdy-action-row
* @short_description: A #GtkListBox row used to present actions
* @short_description: A #GtkListBox row used to present actions.
* @Title: HdyActionRow
*
* The #HdyActionRow widget can have a title, a subtitle and an icon. The row
......
......@@ -16,7 +16,7 @@
/**
* SECTION:hdy-arrows
* @short_description: Arrows indicating a swipe direction
* @short_description: Arrows indicating a swipe direction.
* @Title: HdyArrows
*
* The #HdyArrows widget displays arrows indicating a swiping direction.
......
......@@ -13,7 +13,7 @@
/**
* SECTION:hdy-combo-row
* @short_description: A #GtkListBox row used to choose from a list of items
* @short_description: A #GtkListBox row used to choose from a list of items.
* @Title: HdyComboRow
*
* The #HdyComboRow widget allows the user to choose from a list of valid
......
......@@ -11,7 +11,7 @@
/**
* SECTION:hdy-dialer-button
* @short_description: A button on a #HdyDialer keypad
* @short_description: A button on a #HdyDialer keypad.
* @Title: HdyDialerButton
*
* The #HdyDialerButton widget is a single button on an #HdyDialer. It
......
......@@ -11,15 +11,15 @@
/**
* SECTION:hdy-dialer-cycle-button
* @short_description: A button on a #HdyDialer keypad cycling through available symbols
* @short_description: A button on a #HdyDialer keypad cycling through available symbols.
* @Title: HdyDialerCycleButton
*
* The #HdyDialerCycleButton widget is a single button on a #HdyDialer
* The #HdyDialerCycleButton widget is a single button on an #HdyDialer
* representing symbols such as digits, letters, #, +
* or ☃. When the button is pressed multiple times in a row, the
* symbols are cycled through. That is a call to #get_curent_symbol
* returns another symbol each time the button is pressed. If no
* further button presses are received cycling mode ends after a
* further button presses are received, cycling mode ends after a
* timeout. This is configurable via the
* #HdyDialerCycleButton:cycle-timeout property.
*
......
......@@ -14,7 +14,7 @@
/**
* SECTION:hdy-dialer
* @short_description: A keypad for dialing numbers
* @short_description: A keypad for dialing numbers.
* @Title: HdyDialer
*
* The #HdyDialer widget is a keypad for entering numbers such as phone numbers
......
......@@ -11,35 +11,35 @@
/**
* SECTION:hdy-dialog
* @short_description: An adaptive dialog
* @short_description: An adaptive dialog.
* @title: HdyDialog
* @See_also: #HdyHeaderBar
*
* A #GtkDialog that adapts to smaller displays
*
*
* A #GtkDialog that adapts to smaller displays.
*
* Small is defined as:
* |[<!-- language="C" -->
* is_small = (( width <= 400 && height <= 800) ||
* (maximized && width <= 800 && height <= 400));
* ]|
*
* In the smaller view a HdyDialog matches it's size to that of it's
*
* In the smaller view a HdyDialog matches its size to that of its
* parent and for ["Presentation Dialogs"](https://developer.gnome.org/hig/stable/dialogs.html)
* uses a back button rather than close button to dismiss.
*
*
* It's recommended that dialog contents are wrapped in a #GtkScrolledWindow
* to ensure they don't overflow the screen
*
* #HdyDialog works best when #GtkDialog:use-header-bar is %TRUE (which is
* the case when using hdy_dialog_new())
*
* to ensure they don't overflow the screen.
*
* #HdyDialog works best when #GtkDialog:use-header-bar is %TRUE (which is
* the case when using hdy_dialog_new()).
*
* Design Information: [GitLab Issue](https://source.puri.sm/Librem5/libhandy/issues/52)
*
*
* Ideally when using #HdyDialog you shouldn't need to know you are using
* it rather than #GtkDialog however there are some notable differences:
* #GtkWindow:modal is %TRUE by default as is #GtkWindow:destroy-with-parent as
* the behaviour demonstrated by #HdyDialog would be a bad user experience
* when not modal
* when not modal.
*
* If you want to replace the titlebar by your own, we recommend using
* #HdyHeaderBar as it will retain the abiity to present a back button when the
......
......@@ -12,10 +12,10 @@
/**
* SECTION:hdy-expander-row
* @short_description: A #GtkListBox row used to reveal widgets
* @short_description: A #GtkListBox row used to reveal widgets.
* @Title: HdyExpanderRow
*
* The #HdyExpanderRow allows the user to reveal of hide widgets below it. It
* The #HdyExpanderRow allows the user to reveal or hide widgets below it. It
* also allows the user to enable the expansion of the row, allowing to disable
* all that the row contains.
*
......
......@@ -9,7 +9,7 @@
/**
* SECTION:hdy-fold
* @short_description: Element folding states
* @short_description: Element folding states.
* @title: HdyFold
*/
......
......@@ -32,7 +32,7 @@
/**
* SECTION:hdy-header-bar
* @Short_description: A box with a centered child
* @short_description: A box with a centered child.
* @Title: HdyHeaderBar
* @See_also: #GtkHeaderBar, #HdyTitleBar, #HdyViewSwitcher, #HdyDialog
*
......
......@@ -11,7 +11,7 @@
/**
* SECTION:hdy-list-box
* @short_description: Helper functions for #GtkListBox
* @short_description: Helper functions for #GtkListBox.
* @Title: GtkListBox helpers
*
* Since: 0.0.6
......
......@@ -12,7 +12,7 @@ static gint hdy_initialized = FALSE;
/**
* SECTION:hdy-main
* @Short_description: Library initialization
* @short_description: Library initialization.
* @Title: hdy-main
*
* Before using the Handy libarary you should initialize it. This makes
......
......@@ -14,7 +14,7 @@
/**
* SECTION:hdy-preferences-group
* @short_description: A group gathering preferences rows
* @short_description: A group gathering preferences rows.
* @Title: HdyPreferencesGroup
*
* A #HdyPreferencesGroup represents a group or tightly related preferences,
......
......@@ -11,7 +11,7 @@
/**
* SECTION:hdy-preferences-row
* @short_description: A #GtkListBox row used to present preferences
* @short_description: A #GtkListBox row used to present preferences.
* @Title: HdyPreferencesRow
*
* The #HdyPreferencesRow widget has a title that #HdyPreferencesWindow will use
......
......@@ -48,7 +48,7 @@
/**
* SECTION:hdy-search-bar
* @Short_description: A toolbar to integrate a search entry with
* @short_description: A toolbar to integrate a search entry with.
* @Title: HdySearchBar
*
* #HdySearchBar is a container made to have a search entry (possibly
......
......@@ -24,12 +24,12 @@
/**
* SECTION:hdy-squeezer
* @Short_description: A best fit container
* @short_description: A best fit container.
* @Title: HdySqueezer
*
* The HdySqueezer widget is a container which only shows the first of its
* children that fits in the available size. It is convenient to offer different
* widgets to represent the same data with different levels of details, making
* widgets to represent the same data with different levels of detail, making
* the widget seem to squeeze itself to fit in the available space.
*
* Transitions between children can be animated as fades. This can be controlled
......
......@@ -10,10 +10,10 @@
/**
* SECTION:hdy-string-utf8
* @short_description: #GString utf-8 helpers
* @short_description: #GString utf-8 helpers.
* @title: HdyStringUtf8
*
* Helpers to ease utf-8 handling based on #GString
* Helpers to ease utf-8 handling based on #GString.
*/
/**
......@@ -21,7 +21,7 @@
* @string: a #GString
* @len: the new size of the string
*
* Cut of the end of the string @string so that @len utf8 characters remain
* Cut of the end of the string @string so that @len utf8 characters remain.
*
* Returns: (transfer none): @string
*/
......
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment