Bug 125302 - [GTK] Fix gtk-doc warnings when generating DOM bindings API docs
Summary: [GTK] Fix gtk-doc warnings when generating DOM bindings API docs
Status: RESOLVED FIXED
Alias: None
Product: WebKit
Classification: Unclassified
Component: Bindings (show other bugs)
Version: 528+ (Nightly build)
Hardware: Unspecified Unspecified
: P2 Normal
Assignee: Nobody
URL:
Keywords: Gtk
Depends on:
Blocks:
 
Reported: 2013-12-05 05:21 PST by Carlos Garcia Campos
Modified: 2013-12-05 06:30 PST (History)
2 users (show)

See Also:

Attachments
Patch (1.59 KB, patch)
2013-12-05 05:23 PST, Carlos Garcia Campos 		no flags Details | Formatted Diff | Diff
Updated patch (1.54 KB, patch)
2013-12-05 05:31 PST, Carlos Garcia Campos 		pnormand: review+
Details | Formatted Diff | Diff
Show Obsolete (1) View All Add an attachment (proposed patch, testcase, etc.)

Note You need to log in before you can comment on or make changes to this bug.
Description Carlos Garcia Campos 2013-12-05 05:21:09 PST 
The following API are missing documentation:
	WEBKIT_API
	WEBKIT_DEPRECATED
	WEBKIT_DEPRECATED_FOR

Those are macros that shouldn't be documented, but they should be added to the -sections.txt as private API file to avoid the gtk-doc warnings.
Comment 1 Carlos Garcia Campos 2013-12-05 05:23:17 PST 
Created attachment 218506 [details]
Patch
Comment 2 Philippe Normand 2013-12-05 05:27:22 PST 
Comment on attachment 218506 [details]
Patch

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

> Tools/gtk/generate-webkitdom-doc-files:193
> +        sys.stdout.write('<FILE>webkitdeomdefines</FILE>\n<TITLE>WebKitDOMDefines</TITLE>\n')

deom ? :)
Comment 3 Carlos Garcia Campos 2013-12-05 05:29:46 PST 
(In reply to comment #2)
> (From update of attachment 218506 [details])
> View in context: https://bugs.webkit.org/attachment.cgi?id=218506&action=review
> 
> > Tools/gtk/generate-webkitdom-doc-files:193
> > +        sys.stdout.write('<FILE>webkitdeomdefines</FILE>\n<TITLE>WebKitDOMDefines</TITLE>\n')
> 
> deom ? :)

Oops, it doesn't really matter actually, but good catch, will update the patch :-)
Comment 4 Carlos Garcia Campos 2013-12-05 05:31:58 PST 
Created attachment 218507 [details]
Updated patch

Fixed typo
Comment 5 Carlos Garcia Campos 2013-12-05 06:30:05 PST 
Committed r160173: <http://trac.webkit.org/changeset/160173>