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

[bugzilla-daemon at webkit.org]

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

--- Comment #10 from Michael Catanzaro <mcatanzaro at igalia.com> ---
(In reply to Carlos Eduardo Ramalho from comment #7) 
>  * Note that #WebKitWebView is scrollable by itself, so you don't need
>  * to embed it in a #GtkScrolledWindow.
> 
> The API documentation is supposed to be in .c and .cpp files, right? Any
> ideas on solving this problem?

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 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.

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

-- 
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/20181019/73a5dbd7/attachment.html>