Merge pull request #65 from hecrj/improvement/docs

Documentation

1 files changed, 19 insertions, 0 deletions

diff --git a/native/src/renderer/windowed.rs b/native/src/renderer/windowed.rs
index 6d0419d2..813a03f2 100644
--- a/native/src/renderer/windowed.rs
+++ b/native/src/renderer/windowed.rs
@@ -2,11 +2,21 @@ use crate::MouseCursor;
 
 use raw_window_handle::HasRawWindowHandle;
 
+/// A renderer that can target windows.
 pub trait Windowed: super::Renderer + Sized {
+    /// The type of target.
     type Target: Target<Renderer = Self>;
 
+    /// Creates a new [`Windowed`] renderer.
+    ///
+    /// [`Windowed`]: trait.Windowed.html
     fn new() -> Self;
 
+    /// Performs the drawing operations described in the output on the given
+    /// target.
+    ///
+    /// The overlay can be a bunch of debug text logs. It should be rendered on
+    /// top of the GUI on most scenarios.
     fn draw<T: AsRef<str>>(
         &mut self,
         output: &Self::Output,
@@ -15,9 +25,15 @@ pub trait Windowed: super::Renderer + Sized {
     ) -> MouseCursor;
 }
 
+/// A rendering target.
 pub trait Target {
+    /// The renderer of this target.
     type Renderer;
 
+    /// Creates a new rendering [`Target`] from the given window handle, width,
+    /// height and dpi factor.
+    ///
+    /// [`Target`]: trait.Target.html
     fn new<W: HasRawWindowHandle>(
         window: &W,
         width: u16,
@@ -26,6 +42,9 @@ pub trait Target {
         renderer: &Self::Renderer,
     ) -> Self;
 
+    /// Resizes the current [`Target`].
+    ///
+    /// [`Target`]: trait.Target.html
     fn resize(
         &mut self,
         width: u16,