[gtk/gtk-3-24: 1/2] window: Fix docstring formatting on 'set-focus' signal



commit d536fa5aa43009879a455a9f2a64ba73735c6d23
Author: Collin May <collin collinswebsite com>
Date:   Sat Apr 11 22:49:51 2020 -0700

    window: Fix docstring formatting on 'set-focus' signal
    
    This comment was added in 93bcca7f023d2767f589e0641fc1923ce880c3d5 but missed a
    colon so it never actually generated documentation and the nullable annotation
    never made it into GObject-introspection language bindings.
    
    This crude regex does not catch any other instances of this mistake. The @
    symbol is used to disambiguate signal doc comments from property doc comments,
    since property docs usually don't have parameters.
    
    $ pcre2grep -rM '\\* [A-Z][A-Za-z]*:([a-z\-]*):\n +\* @' gtk/

 gtk/gtkwindow.c | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
---
diff --git a/gtk/gtkwindow.c b/gtk/gtkwindow.c
index c8fb47668c..d9c456e304 100644
--- a/gtk/gtkwindow.c
+++ b/gtk/gtkwindow.c
@@ -1134,7 +1134,7 @@ gtk_window_class_init (GtkWindowClass *klass)
                                                              20, GTK_PARAM_READWRITE));
 
   /**
-   * GtkWindow:set-focus:
+   * GtkWindow::set-focus:
    * @window: the window which received the signal
    * @widget: (nullable): the newly focused widget (or %NULL for no focus)
    *


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