Lerking/gtk
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

GtkAboutDialog: Add formatting examples to the docs

Browse Source 
We were not very explicit about the expected format for links
and email addresses in the strings, so give some explicit examples.
This commit is contained in:
Matthias Clasen
2014-08-29 15:11:11 -04:00
parent 4d608ad722
commit bdf35e034a
1 changed files with 6 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
gtk/gtkaboutdialog.c
View File

@@ -68,14 +68,18 @@
* a program like its logo, name, copyright, website and license. It is
* also possible to give credits to the authors, documenters, translators
* and artists who have worked on the program. An about dialog is typically
* opened when the user selects the `About` option from
* the `Help` menu. All parts of the dialog are optional.
* opened when the user selects the `About` option from the `Help` menu.
* All parts of the dialog are optional.
*
* About dialogs often contain links and email addresses. GtkAboutDialog
* displays these as clickable links. By default, it calls gtk_show_uri()
* when a user clicks one. The behaviour can be overridden with the
* #GtkAboutDialog::activate-link signal.
*
* To specify a person with an email address, use a string like
* "Edgar Allan Poe <edgar@poe.com>". To specify a website with a title,
* use a string like "GTK+ team http://www.gtk.org".
*
* To make constructing a GtkAboutDialog as convenient as possible, you can
* use the function gtk_show_about_dialog() which constructs and shows a dialog
* and keeps it around so that it can be shown again.