Skip to content

libservo: Expand documentation for WebView methods. - #45467

Merged
mukilan merged 1 commit into
servo:mainfrom
mukilan:push-yytyzrktrkmu
Jun 8, 2026
Merged

libservo: Expand documentation for WebView methods.#45467
mukilan merged 1 commit into
servo:mainfrom
mukilan:push-yytyzrktrkmu

Conversation

@mukilan

@mukilan mukilan commented Jun 8, 2026

Copy link
Copy Markdown
Member

Also add documentation for few more types in webview_delegate.rs.

Testing: Not needed as there are no code changes.

@mukilan
mukilan requested a review from mrobinson June 8, 2026 07:05
@servo-highfive servo-highfive added the S-awaiting-review There is new code that needs to be reviewed. label Jun 8, 2026
@mukilan mukilan changed the title libservo: Expand documention of WebView methods. libservo: Expand documentation for WebView methods. Jun 8, 2026
@servo-highfive servo-highfive removed the S-awaiting-review There is new code that needs to be reviewed. label Jun 8, 2026
Comment thread components/servo/webview.rs Outdated
/// given `message`, and the embedder will be notified via
/// [`WebViewDelegate::notify_crashed`].
///
/// TODO: Describe the use case for this API?

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@mrobinson I couldn't figure out the use case for this API as this is not used in servoshell. Is it used for testing?

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think this is unused actually. Let's skip documentation now and then please open a PR to remove it and the EmbedderToConstellationMessage::SendError variant as well.

@mrobinson mrobinson left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice!

Comment thread components/constellation/embedder.rs Outdated
Panic(WebViewId, String, Option<String>),
/// A webview potentially gained focus for keyboard events.
/// If the boolean value is false, the webiew could not be focused.
/// If the boolean value is false, the webview could not be focused.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
/// If the boolean value is false, the webview could not be focused.
/// If the boolean value is false, the `WebView` could not be focused.

@mukilan mukilan Jun 8, 2026

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There were other instances in this enum's documentation where webview was used. I've changed those as well in fc1d832.

Comment thread components/servo/webview.rs Outdated
Comment thread components/servo/webview.rs Outdated
Comment thread components/servo/webview.rs Outdated
Comment thread components/servo/webview.rs Outdated
/// given `message`, and the embedder will be notified via
/// [`WebViewDelegate::notify_crashed`].
///
/// TODO: Describe the use case for this API?

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think this is unused actually. Let's skip documentation now and then please open a PR to remove it and the EmbedderToConstellationMessage::SendError variant as well.

Also add documention for few more types in `webview_delegate.rs`.

Signed-off-by: Mukilan Thiyagarajan <mukilan@igalia.com>
@mukilan
mukilan force-pushed the push-yytyzrktrkmu branch from 2b3e9e2 to fc1d832 Compare June 8, 2026 10:51
@servo-highfive servo-highfive added the S-awaiting-review There is new code that needs to be reviewed. label Jun 8, 2026
@mukilan
mukilan enabled auto-merge June 8, 2026 10:56
@mukilan
mukilan added this pull request to the merge queue Jun 8, 2026
@servo-highfive servo-highfive added the S-awaiting-merge The PR is in the process of compiling and running tests on the automated CI. label Jun 8, 2026
Merged via the queue into servo:main with commit 3cdae07 Jun 8, 2026
33 checks passed
@mukilan
mukilan deleted the push-yytyzrktrkmu branch June 8, 2026 12:16
@servo-highfive servo-highfive removed the S-awaiting-merge The PR is in the process of compiling and running tests on the automated CI. label Jun 8, 2026
niyabits pushed a commit to niyabits/servo that referenced this pull request Jun 11, 2026
Also add documentation for few more types in `webview_delegate.rs`.

Testing: Not needed as there are no code changes.

Signed-off-by: Mukilan Thiyagarajan <mukilan@igalia.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

S-awaiting-review There is new code that needs to be reviewed.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants