Bug 184771 – [GTK] Local cross references are broken in API documentation

• Status: RESOLVED
• Resolution: FIXED
• Component: WebKitGTK

[Carlos Garcia Campos]

The problem is that gtkdoc-fixxref expects the links to be in the form html/modulename (like the installed ones), but we generate the documentation as modulename/html. So, links to WebKitDOM or JSC are generated as ../html/Foo. The rebase command considers html to be the module name in this case, creating broken links in all the cases.

[Carlos Garcia Campos]

Created attachment 338315 [details]
Patch

[EWS Watchlist]

Attachment 338315 [details] did not pass style-queue:


ERROR: Tools/gtk/gtkdoc.py:377:  [GTKDoc._run_gtkdoc_fixxref] Instance of 'GTKDoc' has no 'virtual_root' member  [pylint/E1101] [5]
ERROR: Tools/gtk/gtkdoc.py:377:  [GTKDoc._run_gtkdoc_fixxref] Instance of 'GTKDoc' has no 'prefix' member  [pylint/E1101] [5]
Total errors found: 2 in 5 files


If any of these errors are false positives, please file a bug against check-webkit-style.

[Michael Catanzaro]

Comment on attachment 338315 [details]
Patch

If you have spare cycles, I would investigate whether we can dump our custom gtkdoc scripts in favor of https://git.gnome.org/browse/gtk-doc/tree/cmake

[Carlos Garcia Campos]

(In reply to Michael Catanzaro from comment #3)
> Comment on attachment 338315 [details]
> Patch
> 
> If you have spare cycles, I would investigate whether we can dump our custom
> gtkdoc scripts in favor of https://git.gnome.org/browse/gtk-doc/tree/cmake

I already did that for poppler when we switched to CMake and we ended up using the WebKit scripts there too :-)

[Carlos Garcia Campos]

Committed r230837: <https://trac.webkit.org/changeset/230837>