[Webkit-unassigned] [Bug 176667] New: REGRESSION: [GTK] Generated HTML API documentation is missing descriptions

bugzilla-daemon at webkit.org bugzilla-daemon at webkit.org
Sun Sep 10 02:15:03 PDT 2017


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

            Bug ID: 176667
           Summary: REGRESSION: [GTK] Generated HTML API documentation is
                    missing descriptions
           Product: WebKit
           Version: WebKit Nightly Build
          Hardware: Unspecified
                OS: Unspecified
            Status: NEW
          Keywords: Gtk, Regression
          Severity: Normal
          Priority: P2
         Component: WebKit Gtk
          Assignee: webkit-unassigned at lists.webkit.org
          Reporter: cgarcia at igalia.com
                CC: bugs-noreply at webkitgtk.org

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

-- 
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/20170910/7428b51f/attachment.html>


More information about the webkit-unassigned mailing list