Permalink
Browse files

Fix API documentation comments.

  • Loading branch information...
1 parent 5562417 commit 5d02ea1f7c31db24fdc0418f0c094dfde6d33e4b @jtappin jtappin committed Mar 20, 2013
@@ -266,6 +266,7 @@ function hl_gtk_assistant_get_current_page(asstnt, pageno) result(page)
! Return the current page of an assistant.
!
! ASSTNT: c_ptr: required: The assistant to query
+ ! PAGENO: int: optional: The page number of the current page.
!
! The returns the widget of the current page. To get the page
! number only just use gtk_assistant_get_current_page,
@@ -317,6 +318,12 @@ end subroutine hl_gtk_assistant_set_page_complete
subroutine hl_gtk_assistant_destroy(widget, data) bind(c)
type(c_ptr), value :: widget, data
+ ! Default callback for the destroy signal, also for cancel and close.
+ !
+ ! WIDGET: c_ptr: required: The widget to destroy
+ ! DATA: c_ptr: required: Data passed to the callback, not used.
+ !-
+
call gtk_widget_destroy(widget)
end subroutine hl_gtk_assistant_destroy
end module gtk_hl_assistant
@@ -26,11 +26,11 @@
! --------------------------------------------------------
! gtk-hl-assistant.f90
-! Generated: Mon Jan 7 19:58:39 2013 GMT
+! Generated: Wed Mar 20 16:45:10 2013 GMT
! Please do not edit this file directly,
! Edit gtk-hl-assistant-tmpl.f90, and use ./mk_gtk_hl.pl to regenerate.
! Generated for GTK+ version: 2.24.0.
-! Generated for GLIB version: 2.32.0.
+! Generated for GLIB version: 2.34.0.
! --------------------------------------------------------
@@ -265,6 +265,7 @@ function hl_gtk_assistant_get_current_page(asstnt, pageno) result(page)
! Return the current page of an assistant.
!
! ASSTNT: c_ptr: required: The assistant to query
+ ! PAGENO: int: optional: The page number of the current page.
!
! The returns the widget of the current page. To get the page
! number only just use gtk_assistant_get_current_page,
@@ -316,6 +317,12 @@ end subroutine hl_gtk_assistant_set_page_complete
subroutine hl_gtk_assistant_destroy(widget, data) bind(c)
type(c_ptr), value :: widget, data
+ ! Default callback for the destroy signal, also for cancel and close.
+ !
+ ! WIDGET: c_ptr: required: The widget to destroy
+ ! DATA: c_ptr: required: Data passed to the callback, not used.
+ !-
+
call gtk_widget_destroy(widget)
end subroutine hl_gtk_assistant_destroy
end module gtk_hl_assistant
@@ -302,7 +302,7 @@ function hl_gtk_file_chooser_new(chooser_info, cdir, directory, create, &
! PARENT: c_ptr: optional: Parent window for the dialogue.
! ALL: boolean: optional: Set to TRUE to add an all-files filter pattern
! WSIZE: c_int(2): optional: Set the size for the dialog.
- ! EDIT_FILTERS: boolean: optional: Set to TRUE to proves an entry window
+ ! EDIT_FILTERS: boolean: optional: Set to TRUE to provide an entry window
! to add extra filters.
!-
@@ -26,11 +26,11 @@
! --------------------------------------------------------
! gtk-hl-chooser.f90
-! Generated: Fri Feb 1 15:23:23 2013 GMT
+! Generated: Wed Mar 20 16:45:10 2013 GMT
! Please do not edit this file directly,
! Edit gtk-hl-chooser-tmpl.f90, and use ./mk_gtk_hl.pl to regenerate.
! Generated for GTK+ version: 2.24.0.
-! Generated for GLIB version: 2.32.0.
+! Generated for GLIB version: 2.34.0.
! --------------------------------------------------------
@@ -301,7 +301,7 @@ function hl_gtk_file_chooser_new(chooser_info, cdir, directory, create, &
! PARENT: c_ptr: optional: Parent window for the dialogue.
! ALL: boolean: optional: Set to TRUE to add an all-files filter pattern
! WSIZE: c_int(2): optional: Set the size for the dialog.
- ! EDIT_FILTERS: boolean: optional: Set to TRUE to proves an entry window
+ ! EDIT_FILTERS: boolean: optional: Set to TRUE to provide an entry window
! to add extra filters.
!-
@@ -751,7 +751,7 @@ subroutine hl_gtk_scrolled_window_add(win, child, viewport)
!
! WIN: c_ptr: required: The scrolled window.
! CHILD: c_ptr: required: The widget to insert.
- ! VIEWPORT: c_int: optional: Set this to true if the child widget
+ ! VIEWPORT: boolean: optional: Set this to TRUE if the child widget
! requires a viewport between it and the scrolled window.
! Unfortunately I can't see a way to determine automatically
! whether this is needed.
@@ -26,11 +26,11 @@
! --------------------------------------------------------
! gtk-hl-container.f90
-! Generated: Fri Feb 15 18:41:03 2013 GMT
+! Generated: Wed Mar 20 16:45:10 2013 GMT
! Please do not edit this file directly,
! Edit gtk-hl-container-tmpl.f90, and use ./mk_gtk_hl.pl to regenerate.
! Generated for GTK+ version: 2.24.0.
-! Generated for GLIB version: 2.32.0.
+! Generated for GLIB version: 2.34.0.
! --------------------------------------------------------
@@ -750,7 +750,7 @@ subroutine hl_gtk_scrolled_window_add(win, child, viewport)
!
! WIN: c_ptr: required: The scrolled window.
! CHILD: c_ptr: required: The widget to insert.
- ! VIEWPORT: c_int: optional: Set this to true if the child widget
+ ! VIEWPORT: boolean: optional: Set this to TRUE if the child widget
! requires a viewport between it and the scrolled window.
! Unfortunately I can't see a way to determine automatically
! whether this is needed.
@@ -100,7 +100,10 @@ function hl_gtk_message_dialog_new(message, button_set, title, type, &
! MESSAGE: string(n): required: The message to display. Since this is
! a string array, the C_NULL_CHAR terminations are provided
! internally
- ! BUTTON_SET: integer: required: The set of buttons to display
+ ! BUTTON_SET: integer: required: The set of buttons to display, if
+ ! you need a set not in the GtkButtonsType enumerator, use
+ ! GTK_BUTTONS_NONE and then add buttons with
+ ! gtk_dialog_add_button to add buttons.
! TITLE: string: optional: Title for the window.
! TYPE: c_int: optional: Message type (a GTK_MESSAGE_ value)
! PARENT: c_ptr: optional: An optional parent for the dialogue.
@@ -214,7 +217,8 @@ function hl_gtk_message_dialog_show(message, button_set, title, type, &
! MESSAGE: string(n): required: The message to display. Since this is
! a string array, the C_NULL_CHAR terminations are provided
! internally
- ! BUTTON_SET: integer: required: The set of buttons to display
+ ! BUTTON_SET: integer: required: The set of buttons to display (see
+ ! hl_gtk_message_dialog_new for details).
! TITLE: string: optional: Title for the window.
! TYPE: c_int: optional: Message type (a GTK_MESSAGE_ value)
! PARENT: c_ptr: optional: An optional parent for the dialogue.
View
@@ -26,11 +26,11 @@
! --------------------------------------------------------
! gtk-hl-dialog.f90
-! Generated: Wed Jan 23 18:40:11 2013 GMT
+! Generated: Wed Mar 20 16:45:10 2013 GMT
! Please do not edit this file directly,
! Edit gtk-hl-dialog-tmpl.f90, and use ./mk_gtk_hl.pl to regenerate.
! Generated for GTK+ version: 2.24.0.
-! Generated for GLIB version: 2.32.0.
+! Generated for GLIB version: 2.34.0.
! --------------------------------------------------------
@@ -99,7 +99,10 @@ function hl_gtk_message_dialog_new(message, button_set, title, type, &
! MESSAGE: string(n): required: The message to display. Since this is
! a string array, the C_NULL_CHAR terminations are provided
! internally
- ! BUTTON_SET: integer: required: The set of buttons to display
+ ! BUTTON_SET: integer: required: The set of buttons to display, if
+ ! you need a set not in the GtkButtonsType enumerator, use
+ ! GTK_BUTTONS_NONE and then add buttons with
+ ! gtk_dialog_add_button to add buttons.
! TITLE: string: optional: Title for the window.
! TYPE: c_int: optional: Message type (a GTK_MESSAGE_ value)
! PARENT: c_ptr: optional: An optional parent for the dialogue.
@@ -213,7 +216,8 @@ function hl_gtk_message_dialog_show(message, button_set, title, type, &
! MESSAGE: string(n): required: The message to display. Since this is
! a string array, the C_NULL_CHAR terminations are provided
! internally
- ! BUTTON_SET: integer: required: The set of buttons to display
+ ! BUTTON_SET: integer: required: The set of buttons to display (see
+ ! hl_gtk_message_dialog_new for details).
! TITLE: string: optional: Title for the window.
! TYPE: c_int: optional: Message type (a GTK_MESSAGE_ value)
! PARENT: c_ptr: optional: An optional parent for the dialogue.
@@ -87,7 +87,7 @@ function hl_gtk_separator_new(vertical) result(spacer)
! A Version-independent separator.
!
- ! HORIZONTAL: boolean : optional : Set to TRUE to make
+ ! VERTICAL: boolean : optional : Set to TRUE to make
! a vertical separator.
!-
View
@@ -26,11 +26,11 @@
! --------------------------------------------------------
! gtk-hl-misc.f90
-! Generated: Mon Dec 31 18:00:13 2012 GMT
+! Generated: Wed Mar 20 16:45:10 2013 GMT
! Please do not edit this file directly,
! Edit gtk-hl-misc-tmpl.f90, and use ./mk_gtk_hl.pl to regenerate.
! Generated for GTK+ version: 2.24.0.
-! Generated for GLIB version: 2.32.0.
+! Generated for GLIB version: 2.34.0.
! --------------------------------------------------------
@@ -86,7 +86,7 @@ function hl_gtk_separator_new(vertical) result(spacer)
! A Version-independent separator.
!
- ! HORIZONTAL: boolean : optional : Set to TRUE to make
+ ! VERTICAL: boolean : optional : Set to TRUE to make
! a vertical separator.
!-
@@ -261,7 +261,7 @@ subroutine hl_gtk_slider_set_flt(slider, val)
!
! This is usually accessed via the generic interface
! hl_gtk_slider_set_value. Note that since GTK implements all sliders
- ! a doubles, either type of value may be used to set any slider.
+ ! as doubles, either type of value may be used to set any slider.
!-
call gtk_range_set_value(slider, val)
@@ -280,7 +280,7 @@ subroutine hl_gtk_slider_set_int(slider, val)
!
! This is usually accessed via the generic interface
! hl_gtk_slider_set_value. Note that since GTK implements all sliders
- ! a doubles, either type of value may be used to set any slider.
+ ! as doubles, either type of value may be used to set any slider.
!-
call gtk_range_set_value(slider, real(val, c_double))
@@ -26,11 +26,11 @@
! --------------------------------------------------------
! gtk-hl-spin-slider.f90
-! Generated: Mon Dec 31 18:00:13 2012 GMT
+! Generated: Wed Mar 20 16:45:10 2013 GMT
! Please do not edit this file directly,
! Edit gtk-hl-spin-slider-tmpl.f90, and use ./mk_gtk_hl.pl to regenerate.
! Generated for GTK+ version: 2.24.0.
-! Generated for GLIB version: 2.32.0.
+! Generated for GLIB version: 2.34.0.
! --------------------------------------------------------
@@ -260,7 +260,7 @@ subroutine hl_gtk_slider_set_flt(slider, val)
!
! This is usually accessed via the generic interface
! hl_gtk_slider_set_value. Note that since GTK implements all sliders
- ! a doubles, either type of value may be used to set any slider.
+ ! as doubles, either type of value may be used to set any slider.
!-
call gtk_range_set_value(slider, val)
@@ -279,7 +279,7 @@ subroutine hl_gtk_slider_set_int(slider, val)
!
! This is usually accessed via the generic interface
! hl_gtk_slider_set_value. Note that since GTK implements all sliders
- ! a doubles, either type of value may be used to set any slider.
+ ! as doubles, either type of value may be used to set any slider.
!-
call gtk_range_set_value(slider, real(val, c_double))

0 comments on commit 5d02ea1

Please sign in to comment.