Bug 783445 - Incomplete documentation of gtk_widget_insert_after/before()
Incomplete documentation of gtk_widget_insert_after/before()
Status: RESOLVED FIXED
Product: gtk+
Classification: Platform
Component: Documentation
3.91.x
Other All
: Normal minor
: ---
Assigned To: gtk-bugs
gtk-bugs
:
Depends on:
Blocks:
  Show dependency tree
 
Reported: 2017-06-05 16:58 UTC by Kjell Ahlstedt
Modified: 2017-06-06 13:00 UTC (History)
2 users (show)

See Also:
GNOME target: ---
GNOME version: ---


Attachments
widget: Fix gtk_widget_insert_after/before() docs (2.64 KB, patch)
2017-06-05 17:05 UTC, Kjell Ahlstedt
committed Details | Diff | Review

Description Kjell Ahlstedt 2017-06-05 16:58:24 UTC
The documentation of gtk_widget_insert_after() and gtk_widget_insert_before()
does not start with /** and the function name. Therefore the documentation is
not extracted by gtk-doc, and it's not automatically included in the
documentation of the C++ binding, gtkmm. Is this deliberate?

Some parameter names differ between documentation and code.


A non-related documentation question:
gtk_widget_set_focus_child() is declared in gtkwidget.h.
gtk_widget_get_focus_child() is declared in gtkwidgetprivate.h.
None of these functions is documented in gtkwidget.c. Are both functions in fact
private? Or is gtk_widget_set_focus_child() meant to be used by language
bindings and applications?
Comment 1 Kjell Ahlstedt 2017-06-05 17:05:15 UTC
Created attachment 353208 [details] [review]
widget: Fix gtk_widget_insert_after/before() docs
Comment 2 Timm Bäder 2017-06-05 18:29:46 UTC
(In reply to Kjell Ahlstedt from comment #0)
> Is this deliberate?

Nope.

> A non-related documentation question:
> gtk_widget_set_focus_child() is declared in gtkwidget.h.
> gtk_widget_get_focus_child() is declared in gtkwidgetprivate.h.
> None of these functions is documented in gtkwidget.c. Are both functions in
> fact
> private? Or is gtk_widget_set_focus_child() meant to be used by language
> bindings and applications?

The transition of the focus handling to GtkWidget is not entirely done; i.e. GtkContainer had the adjustment handling and focus chains, but GtkWidget does not have that yet, even though it can have a focus child now. Nobody has come up with a solution for those problems yet though. The gtk_container_ variants should be virtually unused inside gtk+. So, it's not exactly on purpose, but it's on purpose unfinished.
Comment 3 Timm Bäder 2017-06-05 18:30:01 UTC
Review of attachment 353208 [details] [review]:

LGTM

Note You need to log in before you can comment on or make changes to this bug.