176667 2017-09-10 02:15:03 -0700 REGRESSION: [GTK] Generated HTML API documentation is missing descriptions 2017-09-10 23:14:34 -0700 1 1 1 Unclassified WebKit WebKitGTK WebKit Nightly Build Unspecified Unspecified RESOLVED FIXED Gtk, Regression P2 Normal --- 1 cgarcia webkit-unassigned aperez berto bugs-noreply buildbot gustavo mcatanzaro oldest_to_newest 1347234 0 cgarcia 2017-09-10 02:15:03 -0700 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 1347235 1 320391 cgarcia 2017-09-10 02:19:02 -0700 Created attachment 320391 Patch 1347236 2 buildbot 2017-09-10 02:21:06 -0700 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 1347237 3 cgarcia 2017-09-10 02:26:54 -0700 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 1347250 4 320391 aperez 2017-09-10 06:42:27 -0700 Comment on attachment 320391 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). 1347251 5 320391 mcatanzaro 2017-09-10 08:23:20 -0700 Comment on attachment 320391 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. 1347353 6 cgarcia 2017-09-10 23:14:34 -0700 Committed r221847: <http://trac.webkit.org/changeset/221847> 320391 2017-09-10 02:19:02 -0700 2017-09-10 08:23:20 -0700 Patch wkgtk-api-docs.diff text/plain 6956 cgarcia ZGlmZiAtLWdpdCBhL1NvdXJjZS9XZWJLaXQvQ2hhbmdlTG9nIGIvU291cmNlL1dlYktpdC9DaGFu Z2VMb2cKaW5kZXggYjYyOGEyOThlZjEuLjRhYjg3MTIxYzQ1IDEwMDY0NAotLS0gYS9Tb3VyY2Uv V2ViS2l0L0NoYW5nZUxvZworKysgYi9Tb3VyY2UvV2ViS2l0L0NoYW5nZUxvZwpAQCAtMSwzICsx LDE5IEBACisyMDE3LTA5LTEwICBDYXJsb3MgR2FyY2lhIENhbXBvcyAgPGNnYXJjaWFAaWdhbGlh LmNvbT4KKworICAgICAgICBSRUdSRVNTSU9OOiBbR1RLXSBHZW5lcmF0ZWQgSFRNTCBBUEkgZG9j dW1lbnRhdGlvbiBpcyBtaXNzaW5nIGRlc2NyaXB0aW9ucworICAgICAgICBodHRwczovL2J1Z3Mu d2Via2l0Lm9yZy9zaG93X2J1Zy5jZ2k/aWQ9MTc2NjY3CisKKyAgICAgICAgUmV2aWV3ZWQgYnkg Tk9CT0RZIChPT1BTISkuCisKKyAgICAgICAgRml4IHNldmVyYWwgdHlwb3MgaW4gQVBJIGRvY3Vt ZW50YXRpb24uCisKKyAgICAgICAgKiBVSVByb2Nlc3MvQVBJL2dsaWIvV2ViS2l0U2V0dGluZ3Mu Y3BwOgorICAgICAgICAod2Via2l0X3NldHRpbmdzX2NsYXNzX2luaXQpOgorICAgICAgICAqIFVJ UHJvY2Vzcy9BUEkvZ2xpYi9XZWJLaXRXZWJWaWV3LmNwcDoKKyAgICAgICAgKHdlYmtpdF93ZWJf dmlld19jbGFzc19pbml0KToKKyAgICAgICAgKiBVSVByb2Nlc3MvQVBJL2dsaWIvV2ViS2l0V2Vi c2l0ZURhdGFNYW5hZ2VyLmNwcDoKKyAgICAgICAgKiBVSVByb2Nlc3MvQVBJL2d0ay9kb2NzL3dl YmtpdDJndGstZG9jcy5zZ21sOgorCiAyMDE3LTA5LTA0ICBDYXJsb3MgR2FyY2lhIENhbXBvcyAg PGNnYXJjaWFAaWdhbGlhLmNvbT4KIAogICAgICAgICBVbnJldmlld2VkLiBVcGRhdGUgT3B0aW9u c0dUSy5jbWFrZSBhbmQgTkVXUyBmb3IgMi4xNy45MiByZWxlYXNlLgpkaWZmIC0tZ2l0IGEvU291 cmNlL1dlYktpdC9VSVByb2Nlc3MvQVBJL2dsaWIvV2ViS2l0U2V0dGluZ3MuY3BwIGIvU291cmNl L1dlYktpdC9VSVByb2Nlc3MvQVBJL2dsaWIvV2ViS2l0U2V0dGluZ3MuY3BwCmluZGV4IGFmZWY4 OTMyYWEzLi4zYWI0NWFiZjkxYyAxMDA2NDQKLS0tIGEvU291cmNlL1dlYktpdC9VSVByb2Nlc3Mv QVBJL2dsaWIvV2ViS2l0U2V0dGluZ3MuY3BwCisrKyBiL1NvdXJjZS9XZWJLaXQvVUlQcm9jZXNz L0FQSS9nbGliL1dlYktpdFNldHRpbmdzLmNwcApAQCAtODQ5LDcgKzg0OSw3IEBAIHN0YXRpYyB2 b2lkIHdlYmtpdF9zZXR0aW5nc19jbGFzc19pbml0KFdlYktpdFNldHRpbmdzQ2xhc3MqIGtsYXNz KQogICAgICAqIERldGVybWluZXMgd2hldGhlciBvciBub3QgcHJpdmF0ZSBicm93c2luZyBpcyBl bmFibGVkLiBQcml2YXRlIGJyb3dzaW5nCiAgICAgICogd2lsbCBkaXNhYmxlIGhpc3RvcnksIGNh Y2hlIGFuZCBmb3JtIGF1dG8tZmlsbCBmb3IgYW55IHBhZ2VzIHZpc2l0ZWQuCiAgICAgICoKLSAg ICAgKiBEZXByZWNhdGVkOiAyLjE2LiBVc2UgI1dlYktpdFdlYlZpZXc6aXMtZXBoZW1lcmFsIG9y ICNXZWJLaXRXZWJDb250ZXh0OmlzLWVwaGVtZXJhbCBpbnN0ZWFkLgorICAgICAqIERlcHJlY2F0 ZWQ6IDIuMTYuIFVzZSAjV2ViS2l0V2ViVmlldzppcy1lcGhlbWVyYWwgb3IgI1dlYktpdFdlYnNp dGVEYXRhTWFuYWdlcjppcy1lcGhlbWVyYWwgaW5zdGVhZC4KICAgICAgKi8KICAgICBnX29iamVj dF9jbGFzc19pbnN0YWxsX3Byb3BlcnR5KGdPYmplY3RDbGFzcywKICAgICAgICAgICAgICAgICAg ICAgICAgICAgICAgICAgICAgIFBST1BfRU5BQkxFX1BSSVZBVEVfQlJPV1NJTkcsCmRpZmYgLS1n aXQgYS9Tb3VyY2UvV2ViS2l0L1VJUHJvY2Vzcy9BUEkvZ2xpYi9XZWJLaXRXZWJWaWV3LmNwcCBi L1NvdXJjZS9XZWJLaXQvVUlQcm9jZXNzL0FQSS9nbGliL1dlYktpdFdlYlZpZXcuY3BwCmluZGV4 IGE3NzNkM2Y1NzVmLi5jNGJkMWMyN2EzNiAxMDA2NDQKLS0tIGEvU291cmNlL1dlYktpdC9VSVBy b2Nlc3MvQVBJL2dsaWIvV2ViS2l0V2ViVmlldy5jcHAKKysrIGIvU291cmNlL1dlYktpdC9VSVBy b2Nlc3MvQVBJL2dsaWIvV2ViS2l0V2ViVmlldy5jcHAKQEAgLTE2MzMsNyArMTYzMyw3IEBAIHN0 YXRpYyB2b2lkIHdlYmtpdF93ZWJfdmlld19jbGFzc19pbml0KFdlYktpdFdlYlZpZXdDbGFzcyog d2ViVmlld0NsYXNzKQogICAgICAqIHRoZSBtZW51LgogICAgICAqIDwvcGFyYT48L2xpc3RpdGVt PgogICAgICAqIDxsaXN0aXRlbT48cGFyYT4KLSAgICAgKiBhIGdlbmVyaWMgI0dka0V2ZW50IG9m IHR5cGUgJUdES19OT1RISU5HIHdoZW4gdGhlICNHdGtXaWRnZXQ6cG9wdXAtbWVudQorICAgICAq IGEgZ2VuZXJpYyAjR2RrRXZlbnQgb2YgdHlwZSAlR0RLX05PVEhJTkcgd2hlbiB0aGUgI0d0a1dp ZGdldDo6cG9wdXAtbWVudQogICAgICAqIHNpZ25hbCB3YXMgdXNlZCB0byBzaG93IHRoZSBjb250 ZXh0IG1lbnUuCiAgICAgICogPC9wYXJhPjwvbGlzdGl0ZW0+CiAgICAgICogPC9pdGVtaXplZGxp c3Q+CkBAIC0xODYyLDcgKzE4NjIsNyBAQCBzdGF0aWMgdm9pZCB3ZWJraXRfd2ViX3ZpZXdfY2xh c3NfaW5pdChXZWJLaXRXZWJWaWV3Q2xhc3MqIHdlYlZpZXdDbGFzcykKICAgICAgKiBSZXR1cm5z OiAlVFJVRSB0byBzdG9wIG90aGVyIGhhbmRsZXJzIGZyb20gYmVpbmcgaW52b2tlZCBmb3IgdGhl IGV2ZW50LgogICAgICAqICAgJUZBTFNFIHRvIHByb3BhZ2F0ZSB0aGUgZXZlbnQgZnVydGhlci4K ICAgICAgKgotICAgICAqIFNpbmNlOiAyLjE4LgorICAgICAqIFNpbmNlOiAyLjE4CiAgICAgICov CiAgICAgc2lnbmFsc1tTSE9XX09QVElPTl9NRU5VXSA9IGdfc2lnbmFsX25ldygKICAgICAgICAg InNob3ctb3B0aW9uLW1lbnUiLApkaWZmIC0tZ2l0IGEvU291cmNlL1dlYktpdC9VSVByb2Nlc3Mv QVBJL2dsaWIvV2ViS2l0V2Vic2l0ZURhdGFNYW5hZ2VyLmNwcCBiL1NvdXJjZS9XZWJLaXQvVUlQ cm9jZXNzL0FQSS9nbGliL1dlYktpdFdlYnNpdGVEYXRhTWFuYWdlci5jcHAKaW5kZXggYzVjZGVk YjI4YTAuLjc4NWJkNzE2MjI3IDEwMDY0NAotLS0gYS9Tb3VyY2UvV2ViS2l0L1VJUHJvY2Vzcy9B UEkvZ2xpYi9XZWJLaXRXZWJzaXRlRGF0YU1hbmFnZXIuY3BwCisrKyBiL1NvdXJjZS9XZWJLaXQv VUlQcm9jZXNzL0FQSS9nbGliL1dlYktpdFdlYnNpdGVEYXRhTWFuYWdlci5jcHAKQEAgLTQzNCw3 ICs0MzQsNyBAQCBXZWJLaXRXZWJzaXRlRGF0YU1hbmFnZXIqIHdlYmtpdF93ZWJzaXRlX2RhdGFf bWFuYWdlcl9uZXdfZXBoZW1lcmFsKCkKICAqIHdlYmtpdF93ZWJzaXRlX2RhdGFfbWFuYWdlcl9p c19lcGhlbWVyYWw6CiAgKiBAbWFuYWdlcjogYSAjV2ViS2l0V2Vic2l0ZURhdGFNYW5hZ2VyCiAg KgotICogR2V0IHdoZXRoZXIgYSAjV2ViS2l0V2Vic2l0ZURhdGFNYW5hZ2VyIGlzIGVwaGVtZXJh bC4gU2VlICNXZWJLaXRXZWJzaXRlRGF0YU1hbmFnZXI6OmlzLWVwaGVtZXJsYSBmb3IgbW9yZSBk ZXRhaWxzLgorICogR2V0IHdoZXRoZXIgYSAjV2ViS2l0V2Vic2l0ZURhdGFNYW5hZ2VyIGlzIGVw aGVtZXJhbC4gU2VlICNXZWJLaXRXZWJzaXRlRGF0YU1hbmFnZXI6aXMtZXBoZW1lcmFsIGZvciBt b3JlIGRldGFpbHMuCiAgKgogICogUmV0dXJuczogJVRSVUUgaWYgQG1hbmFnZXIgaXMgZXBoZXJh bCBvciAlRkFMU0Ugb3RoZXJ3aXNlLgogICoKZGlmZiAtLWdpdCBhL1NvdXJjZS9XZWJLaXQvVUlQ cm9jZXNzL0FQSS9ndGsvZG9jcy93ZWJraXQyZ3RrLWRvY3Muc2dtbCBiL1NvdXJjZS9XZWJLaXQv VUlQcm9jZXNzL0FQSS9ndGsvZG9jcy93ZWJraXQyZ3RrLWRvY3Muc2dtbAppbmRleCA3YzFkNTQ1 MDgzYi4uMzU5NzE1Mjk1NjAgMTAwNjQ0Ci0tLSBhL1NvdXJjZS9XZWJLaXQvVUlQcm9jZXNzL0FQ SS9ndGsvZG9jcy93ZWJraXQyZ3RrLWRvY3Muc2dtbAorKysgYi9Tb3VyY2UvV2ViS2l0L1VJUHJv Y2Vzcy9BUEkvZ3RrL2RvY3Mvd2Via2l0Mmd0ay1kb2NzLnNnbWwKQEAgLTEyNSw3ICsxMjUsNyBA QAogICA8aW5kZXggaWQ9ImFwaS1pbmRleC0yLTE4IiByb2xlPSIyLjE4Ij4KICAgICA8dGl0bGU+ SW5kZXggb2YgbmV3IHN5bWJvbHMgaW4gMi4xODwvdGl0bGU+CiAgICAgPHhpOmluY2x1ZGUgaHJl Zj0ieG1sL2FwaS1pbmRleC0yLjE4LnhtbCI+PHhpOmZhbGxiYWNrIC8+PC94aTppbmNsdWRlPgot ICAgIDwvaW5kZXg+CisgIDwvaW5kZXg+CiAKICAgPHhpOmluY2x1ZGUgaHJlZj0ieG1sL2Fubm90 YXRpb24tZ2xvc3NhcnkueG1sIj48eGk6ZmFsbGJhY2sgLz48L3hpOmluY2x1ZGU+CiA8L2Jvb2s+ CmRpZmYgLS1naXQgYS9Ub29scy9DaGFuZ2VMb2cgYi9Ub29scy9DaGFuZ2VMb2cKaW5kZXggZTJi ZGRlMjJmZDIuLjE1MzE5MjI2ZGQ0IDEwMDY0NAotLS0gYS9Ub29scy9DaGFuZ2VMb2cKKysrIGIv VG9vbHMvQ2hhbmdlTG9nCkBAIC0xLDMgKzEsMjEgQEAKKzIwMTctMDktMTAgIENhcmxvcyBHYXJj aWEgQ2FtcG9zICA8Y2dhcmNpYUBpZ2FsaWEuY29tPgorCisgICAgICAgIFJFR1JFU1NJT046IFtH VEtdIEdlbmVyYXRlZCBIVE1MIEFQSSBkb2N1bWVudGF0aW9uIGlzIG1pc3NpbmcgZGVzY3JpcHRp b25zCisgICAgICAgIGh0dHBzOi8vYnVncy53ZWJraXQub3JnL3Nob3dfYnVnLmNnaT9pZD0xNzY2 NjcKKworICAgICAgICBSZXZpZXdlZCBieSBOT0JPRFkgKE9PUFMhKS4KKworICAgICAgICBUaGlz IGlzIGhhcHBlbmluZyBzaW5jZSB3ZSBtb3ZlZCB0aGUgaW1wbGVtZW50YXRpb24gZmlsZXMgdG8g Z2xpYiBkaXJzLiBUaGUgZ2VuZXJhdGUtZ3RrZG9jIHNjcmlwdCBhc3N1bWVzIHRoYXQKKyAgICAg ICAgaGVhZGVyIGFuZCBpbXBsZW1lbnRhdGlvbiBmaWxlcyBhcmUgYWx3YXlzIGluIHRoZSBzYW1l IGRpcmVjdG9yeS4gVG8gcmVkdWNlIHRoZSBpbnB1dCB3ZSBwYXNzIHRvIGd0ay1kb2Mgd2UKKyAg ICAgICAgaWdub3JlIGNwcCBmaWxlcyBmb3Igd2hpY2ggdGhlcmUgaXNuJ3QgYSBwdWJsaWMgaGVh ZGVyLiBUaGUgY29kZSB0byBkbyB0aGlzIGNoZWNrIGRvZXNuJ3QgY29uc2lkZXIgY3BwIGZpbGVz IGluCisgICAgICAgIGEgZGlmZmVyZW50IGRpcmVjdG9yeSB0aGFuIHRoZSBoZWFkZXIgZmlsZS4g SXQgYWxzbyBhc3N1bWVzIHRoYXQgaGVhZGVyIGFuZCBjcHAgZmlsZXMgaGF2ZSB0aGUgc2FtZSBm aWxlbmFtZQorICAgICAgICBleGNlcHQgZm9yIHRoZSBleHRlbnNpb24sIHdoaWNoIGlzIHRydWUg aW4gYWxsIGNhc2VzIGJ1dCBXZWJLaXRXZWJWaWV3IHRoYXQgd2UgaGF2ZSB0d28gZmlsZXMgV2Vi S2l0V2ViVmlldy5jcHAKKyAgICAgICAgYW5kIFdlYktpdFdlYlZpZXdHdGsuY3BwLgorCisgICAg ICAgICogZ3RrL2dlbmVyYXRlLWd0a2RvYzoKKyAgICAgICAgKGZpbGVzX3RvX2lnbm9yZSk6IENo ZWNrIGFsc28gY3BwIGZpbGVzIHdpdGggdGhlIEd0ayBzdWZmaXguCisgICAgICAgIChmaWxlc190 b19pZ25vcmUuYWRkX2ZpbGVfaWZfZXhpc3RzKTogQ2hlY2sgaWYgYSBmaWxlIHdpdGggdGhlIGdp dmVuIG5hbWUgZXhpc3RzIGluIGFueSBvZiB0aGUgc291cmNlIGRpcnMuCisKIDIwMTctMDgtMzEg IENhcmxvcyBHYXJjaWEgQ2FtcG9zICA8Y2dhcmNpYUBpZ2FsaWEuY29tPgogCiAgICAgICAgIFtH VEtdIEltcHJvdmUgdGhlIHdheSB1bml0IHRlc3QgYXJlIHJ1biBhbmQgdGhlIHJlc3VsdHMgcmVw b3J0ZWQKZGlmZiAtLWdpdCBhL1Rvb2xzL2d0ay9nZW5lcmF0ZS1ndGtkb2MgYi9Ub29scy9ndGsv Z2VuZXJhdGUtZ3RrZG9jCmluZGV4IDMzYjI4MjRmODA2Li5kYmUyZjlhYjE2ZiAxMDA3NTUKLS0t IGEvVG9vbHMvZ3RrL2dlbmVyYXRlLWd0a2RvYworKysgYi9Ub29scy9ndGsvZ2VuZXJhdGUtZ3Rr ZG9jCkBAIC04MCwxMiArODAsMTUgQEAgZGVmIGZpbGVzX3RvX2lnbm9yZShzb3VyY2VfZGlycywg aGVhZGVyc193aXRoX2d0a2RvYyk6CiAgICAgIiIiCiAgICAgaW1wbGVtZW50YXRpb25fZmlsZXMg PSBsaXN0KGhlYWRlcnNfd2l0aF9ndGtkb2MpCiAgICAgZm9yIGhlYWRlciBpbiBoZWFkZXJzX3dp dGhfZ3RrZG9jOgotICAgICAgICBkZWYgYWRkX2ZpbGVfaWZfZXhpc3RzKGZpbGUpOgotICAgICAg ICAgICAgaWYgb3MucGF0aC5pc2ZpbGUoZmlsZSk6Ci0gICAgICAgICAgICAgICAgaW1wbGVtZW50 YXRpb25fZmlsZXMuYXBwZW5kKG9zLnBhdGguYWJzcGF0aChmaWxlKSkKLSAgICAgICAgaGVhZGVy X25hbWVfd2l0aG91dF9leHRlbnNpb24gPSBvcy5wYXRoLnNwbGl0ZXh0KGhlYWRlcilbMF0KLSAg ICAgICAgYWRkX2ZpbGVfaWZfZXhpc3RzKGhlYWRlcl9uYW1lX3dpdGhvdXRfZXh0ZW5zaW9uICsg Ii5jcHAiKQotICAgICAgICBhZGRfZmlsZV9pZl9leGlzdHMoaGVhZGVyX25hbWVfd2l0aG91dF9l eHRlbnNpb24gKyAiLmMiKQorICAgICAgICBkZWYgYWRkX2ZpbGVfaWZfZXhpc3RzKGZpbGVuYW1l KToKKyAgICAgICAgICAgIGZvciBkaXIgaW4gc291cmNlX2RpcnM6CisgICAgICAgICAgICAgICAg ZmlsZSA9IG9zLnBhdGguam9pbihkaXIsIGZpbGVuYW1lKQorICAgICAgICAgICAgICAgIGlmIG9z LnBhdGguaXNmaWxlKGZpbGUpOgorICAgICAgICAgICAgICAgICAgICBpbXBsZW1lbnRhdGlvbl9m aWxlcy5hcHBlbmQob3MucGF0aC5hYnNwYXRoKGZpbGUpKQorICAgICAgICBoZWFkZXJfYmFzZW5h bWVfd2l0aG91dF9leHRlbnNpb24gPSBvcy5wYXRoLnNwbGl0ZXh0KG9zLnBhdGguYmFzZW5hbWUo aGVhZGVyKSlbMF0KKyAgICAgICAgYWRkX2ZpbGVfaWZfZXhpc3RzKGhlYWRlcl9iYXNlbmFtZV93 aXRob3V0X2V4dGVuc2lvbiArICIuY3BwIikKKyAgICAgICAgYWRkX2ZpbGVfaWZfZXhpc3RzKGhl YWRlcl9iYXNlbmFtZV93aXRob3V0X2V4dGVuc2lvbiArICJHdGsuY3BwIikKKyAgICAgICAgYWRk X2ZpbGVfaWZfZXhpc3RzKGhlYWRlcl9iYXNlbmFtZV93aXRob3V0X2V4dGVuc2lvbiArICIuYyIp CiAKICAgICBkZWYgZmlsZV9zaG91bGRfYmVfaWdub3JlZChmaWxlKToKICAgICAgICAgaWYgb3Mu cGF0aC5zcGxpdGV4dChmaWxlKVsxXSBub3QgaW4gWycuaCcsICcuYycsICcuY3BwJywgJy5jYydd Ogo=