diff options
author | Matthias Clasen <mclasen@redhat.com> | 2011-01-04 11:36:42 -0500 |
---|---|---|
committer | Matthias Clasen <mclasen@redhat.com> | 2011-01-04 11:36:42 -0500 |
commit | 336d355c2aa8d8a90e07d3a89c7ddfd9878d0dc0 (patch) | |
tree | ab0e25b503e5725eaa660aa577f9fd0e45aab42a /gtk/gtkcalendar.c | |
parent | bf2a6114abb7262ff31f116dbb0c1a60567c52dc (diff) | |
download | gtk+-336d355c2aa8d8a90e07d3a89c7ddfd9878d0dc0.tar.gz |
Some documentation additions
Proposed by Bruno Piguet.
https://bugzilla.gnome.org/show_bug.cgi?id=559503
Diffstat (limited to 'gtk/gtkcalendar.c')
-rw-r--r-- | gtk/gtkcalendar.c | 18 |
1 files changed, 11 insertions, 7 deletions
diff --git a/gtk/gtkcalendar.c b/gtk/gtkcalendar.c index e42f3307d5..bd65a1bb0f 100644 --- a/gtk/gtkcalendar.c +++ b/gtk/gtkcalendar.c @@ -34,22 +34,26 @@ * @Short_description: Displays a calendar and allows the user to select a date * @Title: GtkCalendar * - * #GtkCalendar is a widget that displays a calendar, one month at a time. It - * can be created with gtk_calendar_new(). + * #GtkCalendar is a widget that displays a Gregorian calendar, one month + * at a time. It can be created with gtk_calendar_new(). * * The month and year currently displayed can be altered with - * gtk_calendar_select_month(). The exact day can be selected from the displayed - * month using gtk_calendar_select_day(). + * gtk_calendar_select_month(). The exact day can be selected from the + * displayed month using gtk_calendar_select_day(). * - * To place a visual marker on a particular day, use gtk_calendar_mark_day() and - * to remove the marker, gtk_calendar_unmark_day(). Alternative, all marks can - * be cleared with gtk_calendar_clear_marks(). + * To place a visual marker on a particular day, use gtk_calendar_mark_day() + * and to remove the marker, gtk_calendar_unmark_day(). Alternative, all + * marks can be cleared with gtk_calendar_clear_marks(). * * The way in which the calendar itself is displayed can be altered using * gtk_calendar_set_display_options(). * * The selected date can be retrieved from a #GtkCalendar using * gtk_calendar_get_date(). + * + * Users should be aware that, although the Gregorian calendar is the legal + * calendar in most countries, it was adopted progressively between 1582 and + * 1929. Display before these dates is likely to be historically incorrect. */ #include "config.h" |