Bug 123448 – [GTK] DOM bindings documentation errors

• Status: RESOLVED
• Resolution: FIXED
• Component: Bindings

[Philippe Normand]

I have a patch for those issues, excepted the gtkdoc-scan WEBKIT_DEPRECATED_FOR warnings.

[Philippe Normand]

Created attachment 215392 [details]
Patch

[Carlos Garcia Campos]

Comment on attachment 215392 [details]
Patch

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

> Source/WebCore/bindings/gobject/WebKitDOMCustom.h:467
> + * Returns: A double

why not a #gdouble?

> Source/WebCore/bindings/scripts/CodeGeneratorGObject.pm:979
> +    if (IsGDOMClassType($function->signature->type) && ($returnType ne "void")) {

can IsGDOMClassType return true for void? In that case I guess we should fix IsGDOMClassType instead.

> Source/WebCore/bindings/scripts/CodeGeneratorGObject.pm:982
> +        push(@hBody, " * Returns: A $returnType\n");

I think you should check if the type is a glib one to use # so that a link is generated. Also in case of pointers we should remove the *

[Philippe Normand]

(In reply to comment #2)
> (From update of attachment 215392 [details])
> View in context: https://bugs.webkit.org/attachment.cgi?id=215392&action=review
> 
> > Source/WebCore/bindings/gobject/WebKitDOMCustom.h:467
> > + * Returns: A double
> 
> why not a #gdouble?
> 

Because I missed it :)

> > Source/WebCore/bindings/scripts/CodeGeneratorGObject.pm:979
> > +    if (IsGDOMClassType($function->signature->type) && ($returnType ne "void")) {
> 
> can IsGDOMClassType return true for void? 

No.

> In that case I guess we should fix IsGDOMClassType instead.
> 

Thing is IsGDOMClassType doesn't check $returnType. I changed this code only to make sure we don't have a Return tag for void functions. TBH I don't really want to debug this spaghetti code much more :)

> > Source/WebCore/bindings/scripts/CodeGeneratorGObject.pm:982
> > +        push(@hBody, " * Returns: A $returnType\n");
> 
> I think you should check if the type is a glib one to use # so that a link is generated. Also in case of pointers we should remove the *

Ok I'll see if I can improve that...

[Carlos Garcia Campos]

Comment on attachment 215392 [details]
Patch

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

>>> Source/WebCore/bindings/scripts/CodeGeneratorGObject.pm:979
>>> +    if (IsGDOMClassType($function->signature->type) && ($returnType ne "void")) {
>> 
>> can IsGDOMClassType return true for void? In that case I guess we should fix IsGDOMClassType instead.
> 
> No.

There's $returnValueIsGDOMType already, maybe we can use that instead of calling IsGDOMClassType again

[Philippe Normand]

Created attachment 215396 [details]
Patch

[Carlos Garcia Campos]

Comment on attachment 215396 [details]
Patch

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

Looks great, thanks. Please add also the description for return tags having a g-i annotation too.

> Source/WebCore/bindings/scripts/CodeGeneratorGObject.pm:980
>          push(@hBody, " * Returns: (transfer none):\n");

Sorry I missed this one before, but this would be empty too, it doesn't give a warning because of the g-i annotation, but it should also have a description.

[Philippe Normand]

Committed r158200: <http://trac.webkit.org/changeset/158200>