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

[bugzilla-daemon at webkit.org]

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

--- Comment #13 from Carlos Eduardo Ramalho <cadubentzen at gmail.com> ---
(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.

> (In reply to Carlos Eduardo Ramalho from comment #8)
> > Also, it can be seen that many documentation is missing from the WPE public
> > API (see wpe-0.1-undocumented.txt in the build directory).  I think adding
> > this documentation can be a follow-up patch for keeping this patch not too
> > big.
> > 
> > Or do you think I should fill up the documentation text already?
> 
> I would do it in a follow-up patch to keep this one small.

Ok. I'll do it in a follow-up for adding missing documentation and fix texts only applicable to wkgtk.

> 
> Regarding ordering, I'd keep the same order as used by WebKitGTK+.

Ok. Done.

-- 
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/20181024/b0bedf26/attachment.html>