Skip to main content

mount_api_docs

Function mount_api_docs 

Source
pub(crate) fn mount_api_docs(world: &mut World, ui: Entity)
Expand description

Mount the link to the API docs in the window’s top-right corner.

The link lives in the UI rather than in the page so the two corner overlays are laid out by the same code and cannot collide: the page’s own link knew nothing about the button, which is what put the two on top of each other. Mounted after mount_fullscreen, because the link is placed under the button it measures.

The click is recorded rather than served here: a panel runs while the world is borrowed and has no page to reach; the frame loop reads the request and opens it with [webbrowser], which covers every platform the example runs on.