[Webkit-unassigned] [Bug 81701] [QT][WK2] webview API doc

[bugzilla-daemon at webkit.org]

https://bugs.webkit.org/show_bug.cgi?id=81701





--- Comment #14 from Simon Hausmann <hausmann at webkit.org>  2012-08-30 04:09:49 PST ---
(From update of attachment 134815)
View in context: https://bugs.webkit.org/attachment.cgi?id=134815&action=review

>> Source/WebKit2/UIProcess/API/qt/qquickwebview.cpp:1293
>> +\qmlproperty url WebView::icon
> 
> Some more info about the sizes, animated icons etc?

I think I'll add more here in a second round of review with the doc folks.

>> Source/WebKit2/UIProcess/API/qt/qquickwebview.cpp:1295
>> +The location of the currently displaying HTML page icon. This
> 
> This is commonly known as favicons.

Good idea. Fixed.

>> Source/WebKit2/UIProcess/API/qt/qquickwebview.cpp:1334
>> +\sa WebView::onLoadProgressChanged
> 
> So if it is fully loaded it will be 100? I think this should be clarified

>From what I can tell from the *Loader sources, the signal will be emitted with 100% right before the emission of loadingChanged (in our API). I'm inclined to say that's intuitive behaviour and an implementation detail we may not have to document.

>> Source/WebKit2/UIProcess/API/qt/qquickwebview.cpp:1617
>> +string are located relative to the \a baseUrl.
> 
> I think an example of the base url would make sense

Good idea, added.

>> Source/WebKit2/UIProcess/API/qt/qquickwebview.cpp:1669
>> +\o \c{errorString}: description of load error.
> 
> I think there were a bug adding yet another state here. LoadStoppedStatus or so

Not yet :)

>> Source/WebKit2/UIProcess/API/qt/qquickwebview.cpp:1694
>> +*/
> 
> What about redirections?

I'm leaving out the docs for this and other signals that are just notifications. We usually only document the property as it's implicit that every property has a onPropertyNameChanged signal that is emitted whenever the property changes.

>> Source/WebKit2/UIProcess/API/qt/qquickwebview.cpp:1710
>> +that are not canceled with \c{preventDefault()}.)  The \a{hoveredUrl}
> 
> cancelled ?

Fixed, we indeed use the UK English.

-- 
Configure bugmail: https://bugs.webkit.org/userprefs.cgi?tab=email
------- You are receiving this mail because: -------
You are the assignee for the bug.