Bug 176667 – REGRESSION: [GTK] Generated HTML API documentation is missing descriptions

• Component: WebKitGTK
• Status: RESOLVED FIXED

[Carlos Garcia Campos]

This is happening since we moved the implementation files to glib dirs. The generate-gtkdoc script assumes that header and implementation files are always in the same directory. To reduce the input we pass to gtk-doc we ignore cpp files for which there isn't a public header. The code to do this check doesn't consider cpp files in a different directory than the header file. It also assumes that header and cpp files have the same filename except for the extension, which is true in all cases but WebKitWebView that we have two files WebKitWebView.cpp and WebKitWebViewGtk.cpp.
You can see that we have been generating api docs without descriptions for some time:

https://webkitgtk.org/reference/webkit2gtk/2.17.91/WebKitWebView.html#webkit-web-view-new

[Carlos Garcia Campos]

Created attachment 320391 [details]
Patch

[Build Bot]

Thanks for the patch. If this patch contains new public API please make sure it follows the guidelines for new WebKit2 GTK+ API. See http://trac.webkit.org/wiki/WebKitGTK/AddingNewWebKit2API

[Carlos Garcia Campos]

I've re-generated the docs for 2.17.92 after applying this patch:

https://webkitgtk.org/reference/webkit2gtk/2.17.92/WebKitWebView.html#webkit-web-view-new

[Adrian Perez]

Comment on attachment 320391 [details]
Patch

Informal r+

Once we figure out how are we going to generate documentation for WPE, we
may need to do something similar adding the files with “WPE.cpp” suffix
(but we are not at that point just yet).

[Michael Catanzaro]

Comment on attachment 320391 [details]
Patch

Well this is Tools/gtk/generate/gtkdoc, so we don't need to consider WPE here. We'll indeed have to add WPE support soon, and move the script to Tools/Scripts.

[Carlos Garcia Campos]

Committed r221847: <http://trac.webkit.org/changeset/221847>