fix doc warnings

This commit is contained in:
Jack OntheGoMac 2021-12-23 13:04:55 -08:00
parent ce22eb3da5
commit 5cecf3f82c
3 changed files with 7 additions and 1 deletions

View File

@ -246,7 +246,7 @@ impl<'ui> DrawListMut<'ui> {
/// Returns a polygonal line. If filled is rendered as a convex
/// polygon, if not filled is drawn as a line specified by
/// [`PolyLine::thickness`] (default 1.0)
/// [`Polyline::thickness`] (default 1.0)
#[doc(alias = "AddPolyline", alias = "AddConvexPolyFilled")]
pub fn add_polyline<C, P>(&'ui self, points: Vec<P>, c: C) -> Polyline<'ui>
where

View File

@ -202,6 +202,8 @@ impl Ui {
/// This function right now simply **ends** the current frame, but does not
/// return draw data. If you want to end the frame without generated draw data,
/// and thus save some CPU time, use [`end_frame_early`].
///
/// [`end_frame_early`]: Self::end_frame_early
#[deprecated(
since = "0.9.0",
note = "use `Context::render` to render frames, or `end_frame_early` to not render at all"
@ -568,6 +570,8 @@ impl<'ui> Ui {
InputScalar::new(self, label, value)
}
/// Shows a horizontal array of scalar value input fields. See [`input_scalar`].
///
/// [`input_scalar`]: Self::input_scalar
#[doc(alias = "InputScalarN")]
pub fn input_scalar_n<'p, L, T>(
&'ui self,

View File

@ -125,6 +125,8 @@ impl Ui {
/// for simple Menu Items with no features on them.
///
/// Note: a `menu_item` is the actual button/selectable within a Menu.
///
/// [`menu_item`]: Self::menu_item
#[doc(alias = "MenuItem")]
pub fn menu_item_config<L: AsRef<str>>(&self, label: L) -> MenuItem<'_, L> {
MenuItem {