Bug 69325 - [WebKit2][gtk] Generate gtk-doc for WebKit2-GTK.
Summary: [WebKit2][gtk] Generate gtk-doc for WebKit2-GTK.
Status: RESOLVED FIXED
Alias: None
Product: WebKit
Classification: Unclassified
Component: WebKit2 (show other bugs)
Version: 528+ (Nightly build)
Hardware: Unspecified Unspecified
: P2 Normal
Assignee: Nobody
URL:
Keywords:
Depends on: 69329
Blocks:
  Show dependency treegraph
 
Reported: 2011-10-04 00:51 PDT by Nayan Kumar K
Modified: 2011-10-04 11:01 PDT (History)
4 users (show)

See Also:


Attachments
gtkdoc generation for WebKit2-GTK+ APIs (15.31 KB, patch)
2011-10-04 01:02 PDT, Nayan Kumar K
no flags Details | Formatted Diff | Diff
gtkdoc generation for WebKit2-GTK+ APIs (15.50 KB, patch)
2011-10-04 01:06 PDT, Nayan Kumar K
no flags Details | Formatted Diff | Diff
gtkdoc generation for WebKit2-GTK+ APIs (10.67 KB, patch)
2011-10-04 03:49 PDT, Nayan Kumar K
no flags Details | Formatted Diff | Diff

Note You need to log in before you can comment on or make changes to this bug.
Description Nayan Kumar K 2011-10-04 00:51:27 PDT
Generate documentation using gtk-doc for WebKit2-GTK+ API's.
Comment 1 Nayan Kumar K 2011-10-04 01:02:36 PDT
Created attachment 109588 [details]
gtkdoc generation for WebKit2-GTK+ APIs
Comment 2 WebKit Review Bot 2011-10-04 01:05:15 PDT
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.
Comment 3 Nayan Kumar K 2011-10-04 01:06:26 PDT
Created attachment 109590 [details]
gtkdoc generation for WebKit2-GTK+ APIs
Comment 4 Carlos Garcia Campos 2011-10-04 01:27:30 PDT
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.
Comment 5 Nayan Kumar K 2011-10-04 03:49:45 PDT
Created attachment 109602 [details]
gtkdoc generation for WebKit2-GTK+ APIs
Comment 6 Gustavo Noronha (kov) 2011-10-04 06:01:58 PDT
Comment on attachment 109602 [details]
gtkdoc generation for WebKit2-GTK+ APIs

LGTM!
Comment 7 Martin Robinson 2011-10-04 08:48:11 PDT
What's the procedure for generating the documentation now?
Comment 8 Nayan Kumar K 2011-10-04 09:24:38 PDT
(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.
Comment 9 Martin Robinson 2011-10-04 09:35:29 PDT
(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.
Comment 10 Nayan Kumar K 2011-10-04 10:37:05 PDT
> 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.
Comment 11 WebKit Review Bot 2011-10-04 11:01:46 PDT
Comment on attachment 109602 [details]
gtkdoc generation for WebKit2-GTK+ APIs

Clearing flags on attachment: 109602

Committed r96611: <http://trac.webkit.org/changeset/96611>
Comment 12 WebKit Review Bot 2011-10-04 11:01:51 PDT
All reviewed patches have been landed.  Closing bug.