[gtk+/gtk-3-22] scrolledwindow: Fix func summary being cut off in bindings using doxygen



commit 7960e94112570e83c5bd11a4bb8450ccfc461e40
Author: Daniel Boles <dboles src gnome org>
Date:   Sat Dec 31 13:27:15 2016 +0000

    scrolledwindow: Fix func summary being cut off in bindings using doxygen
    
    ...which treats the first '.' in doc comments as the end of the summary.
    So, e.g., in gtkmm, get_kinetic_scrolling() is currently summarised as
    "Changes the behaviour of @scrolled_window wrt." Not very informative!
    
    No need for a period there & anyway, the phrase "wrt to" is superfluous,
    and we have space to actually say "with regard to", so just do that now.

 gtk/gtkscrolledwindow.c |    2 +-
 1 files changed, 1 insertions(+), 1 deletions(-)
---
diff --git a/gtk/gtkscrolledwindow.c b/gtk/gtkscrolledwindow.c
index 58c7ef2..9718556 100644
--- a/gtk/gtkscrolledwindow.c
+++ b/gtk/gtkscrolledwindow.c
@@ -2722,7 +2722,7 @@ gtk_scrolled_window_get_kinetic_scrolling (GtkScrolledWindow *scrolled_window)
  * @scrolled_window: a #GtkScrolledWindow
  * @capture_button_press: %TRUE to capture button presses
  *
- * Changes the behaviour of @scrolled_window wrt. to the initial
+ * Changes the behaviour of @scrolled_window with regard to the initial
  * event that possibly starts kinetic scrolling. When @capture_button_press
  * is set to %TRUE, the event is captured by the scrolled window, and
  * then later replayed if it is meant to go to the child widget.


[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]