From 5cecf3f82ca3656af94889cd53e351d5b93eb837 Mon Sep 17 00:00:00 2001 From: Jack OntheGoMac Date: Thu, 23 Dec 2021 13:04:55 -0800 Subject: [PATCH] fix doc warnings --- imgui/src/draw_list.rs | 2 +- imgui/src/lib.rs | 4 ++++ imgui/src/widget/menu.rs | 2 ++ 3 files changed, 7 insertions(+), 1 deletion(-) diff --git a/imgui/src/draw_list.rs b/imgui/src/draw_list.rs index 8c7193d..4da1248 100644 --- a/imgui/src/draw_list.rs +++ b/imgui/src/draw_list.rs @@ -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(&'ui self, points: Vec

, c: C) -> Polyline<'ui> where diff --git a/imgui/src/lib.rs b/imgui/src/lib.rs index 08576fc..9487238 100644 --- a/imgui/src/lib.rs +++ b/imgui/src/lib.rs @@ -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, diff --git a/imgui/src/widget/menu.rs b/imgui/src/widget/menu.rs index e20cfab..61c70ff 100644 --- a/imgui/src/widget/menu.rs +++ b/imgui/src/widget/menu.rs @@ -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>(&self, label: L) -> MenuItem<'_, L> { MenuItem {