[Webkit-unassigned] [Bug 178900] [WPE] Add gtk-doc

[bugzilla-daemon at webkit.org]

https://bugs.webkit.org/show_bug.cgi?id=178900

--- Comment #14 from Adrian Perez <aperez at igalia.com> ---
(In reply to Carlos Eduardo Ramalho from comment #13)
> (In reply to Michael Catanzaro from comment #10)
> > The path of least resistance is to just accept that the documentation will
> > refer to both WebKitGTK+ and WPE WebKit:
> > 
> > "Note that #WebKitWebView is scrollable by itself, so in WebKitGTK+ you
> > don't need to embed it in a #GtkScrolledWindow."
> > 
> > Or:
> > 
> > "The central class of the WebKit API"
> 
> (In reply to Adrian Perez from comment #11)
> > I agree with Michael, let's go ahead and keep the notion that the
> > API documentation will be the same for both ports (GTK+ and WPE).
> > It's not only the path of least resistance: it also avoids having
> > duplicate documentation strings and/or conditional documentation,
> > which is better for maintainability.
> 
> Ok. In some places there is a long explanation about GDK things and this
> text will be carried over for WPE docs as well. But I agree that the easiest
> is accepting that both docs will share these pieces and rewrite/add some
> sentences on things only applicable for one port or the other.

The GDK explanations won't apply to GTK+ 4 either once we support that.
I think we'll just have to live with the fact that the GDK bits will
appear in the documentation and word them in some way that it's clear
that these comments apply to the GTK+ port, and when using GTK+ < 4.0

¯\_(ツ)_/¯

-- 
You are receiving this mail because:
You are the assignee for the bug.
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.webkit.org/pipermail/webkit-unassigned/attachments/20181025/3d940a7b/attachment.html>