rustdoc support for per-parameter documentation
<!-- homu-ignore:start --> *[View all comments](https://triagebot.infra.rust-lang.org/gh-comments/rust-lang/rust/issues/57525)* <!-- homu-ignore:end --> It appears to me that this pattern of documenting function parameter has become an informal standard: ```rust /// Supplies a new frame to WebRender. /// /// Non-blocking, it notifies a worker process which processes the display list. /// /// Note: Scrolling doesn't require an own Frame. /// /// Arguments: /// /// * `document_id`: Target Document ID. /// * `epoch`: The unique Frame ID, monotonically increasing. /// * `background`: The background color of this pipeline. /// * `viewport_size`: The size of the viewport for this frame. /// * `pipeline_id`: The ID of the pipeline that is supplying this display list. /// * `content_size`: The total screen space size of this display list's display items. /// * `display_list`: The root Display list used in this frame. /// * `preserve_frame_state`: If a previous frame exists which matches this pipeline /// id, this setting determines if frame state (such as scrolling /// position) should be preserved for this new display list. pub fn set_display_list( &mut self, epoch: Epoch, background: Option<ColorF>, viewport_size: LayoutSize, (pipeline_id, content_size, display_list): (PipelineId, LayoutSize, BuiltDisplayList),
Posted by kvark on Jan 11, 2019, 7:37 PM
Tags
Related issues
Raise real-world problems, find people facing the same issue, and discuss solutions.4,000 issues0 comments
support (Sysadmin)
Support connecting to remote devcontainers (devcontainer on remote host)
Option to use Waffle menu or links displayed normally
I also attempted to package ROCM on musl.
But why is there no such pushback agains linux kernel?
OpenCode Support
Upcoming changes to the tado° API
Allow Mac users to use Apple native containerization
Support for the Containerization Framework on macOS
rustdoc support for per-parameter documentation
<!-- homu-ignore:start --> *[View all comments](https://triagebot.infra.rust-lang.org/gh-comments/rust-lang/rust/issues/57525)* <!-- homu-ignore:end --> It appears to me that this pattern of documenting function parameter has become an informal standard: ```rust /// Supplies a new frame to WebRender. /// /// Non-blocking, it notifies a worker process which processes the display list. /// /// Note: Scrolling doesn't require an own Frame. /// /// Arguments: /// /// * `document_id`: Target Document ID. /// * `epoch`: The unique Frame ID, monotonically increasing. /// * `background`: The background color of this pipeline. /// * `viewport_size`: The size of the viewport for this frame. /// * `pipeline_id`: The ID of the pipeline that is supplying this display list. /// * `content_size`: The total screen space size of this display list's display items. /// * `display_list`: The root Display list used in this frame. /// * `preserve_frame_state`: If a previous frame exists which matches this pipeline /// id, this setting determines if frame state (such as scrolling /// position) should be preserved for this new display list. pub fn set_display_list( &mut self, epoch: Epoch, background: Option<ColorF>, viewport_size: LayoutSize, (pipeline_id, content_size, display_list): (PipelineId, LayoutSize, BuiltDisplayList),
Comments (0)
No comments yet. Start the discussion.