Bug 69325 – [WebKit2][gtk] Generate gtk-doc for WebKit2-GTK.

• Component: WebKit2
• Status: RESOLVED FIXED

[Nayan Kumar K]

Generate documentation using gtk-doc for WebKit2-GTK+ API's.

[Nayan Kumar K]

Created attachment 109588 [details]
gtkdoc generation for WebKit2-GTK+ APIs

[WebKit Review Bot]

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

Failed to run "['Tools/Scripts/check-webkit-style', '--diff-files', u'ChangeLog', u'Source/WebKit2/ChangeLog', u..." exit_code: 1

ChangeLog:1:  ChangeLog entry has no bug number  [changelog/bugnumber] [5]
Total errors found: 1 in 12 files


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

[Nayan Kumar K]

Created attachment 109590 [details]
gtkdoc generation for WebKit2-GTK+ APIs

[Carlos Garcia Campos]

Comment on attachment 109590 [details]
gtkdoc generation for WebKit2-GTK+ APIs

View in context: https://bugs.webkit.org/attachment.cgi?id=109590&action=review

Patch looks good to me in general, but I would split it into two different patches. First a patch to fix current documentation bugs and then another patch to generate docs.

> Source/WebKit2/UIProcess/API/gtk/docs/webkit2gtk-sections.txt:14
> +WebKitWebViewBaseClass

The class structure is not exactly private, move it to the Standard subsection.

> Source/WebKit2/UIProcess/API/gtk/docs/webkit2gtk-sections.txt:31
> +WebKitWebContextClass

Ditto.

> Source/WebKit2/UIProcess/API/gtk/docs/webkit2gtk-sections.txt:57
> +WebKitWebViewClass

Ditto.

> Source/WebKit2/UIProcess/API/gtk/docs/webkit2gtk-sections.txt:73
> +WebKitWebLoaderClientClass

Ditto.

[Nayan Kumar K]

Created attachment 109602 [details]
gtkdoc generation for WebKit2-GTK+ APIs

[Gustavo Noronha (kov)]

Comment on attachment 109602 [details]
gtkdoc generation for WebKit2-GTK+ APIs

LGTM!

[Martin Robinson]

What's the procedure for generating the documentation now?

[Nayan Kumar K]

(In reply to comment #7)
> What's the procedure for generating the documentation now?

1. Build webkit-gtk by passing '-enable-gtk-doc' argument to build-webkit script,

Tools/Scripts/build-webkit --gtk --enable-webkit2 --enable-gtk-doc

2. Navigate to WebKitBuild/Release/Source/WebKit2/UIProcess/API/gtk/docs/ folder and then make,

cd WebKitBuild/Release/Source/WebKit2/UIProcess/API/gtk/docs/ && make

This procedure is same as webkit1 documentation generation. I will try to document this procedure in webkit-gtk wiki.

[Martin Robinson]

(In reply to comment #8)

> This procedure is same as webkit1 documentation generation. I will try to document this procedure in webkit-gtk wiki.

It would be really nice if there was a cheap (gtkdoc can be slow, I hear) way of showing gtkdoc warnings for every build or even just every build using build-webkit.

[Nayan Kumar K]

> It would be really nice if there was a cheap (gtkdoc can be slow, I hear) way of showing gtkdoc warnings for every build or even just every build using build-webkit.

Sure. I will try to implement it as separate patch. https://bugs.webkit.org/show_bug.cgi?id=69350 raised to address the same.

[WebKit Review Bot]

Comment on attachment 109602 [details]
gtkdoc generation for WebKit2-GTK+ APIs

Clearing flags on attachment: 109602

Committed r96611: <http://trac.webkit.org/changeset/96611>

[WebKit Review Bot]

All reviewed patches have been landed.  Closing bug.