From 8622e998f2701e7f4ca8d2f71c85150f436a9945 Mon Sep 17 00:00:00 2001
From: Héctor Ramón Jiménez <hector0193@gmail.com>
Date: Thu, 11 May 2023 15:25:58 +0200
Subject: Write missing documentation in `iced_graphics`

---
 graphics/src/damage.rs | 5 +++++
 1 file changed, 5 insertions(+)

(limited to 'graphics/src/damage.rs')

diff --git a/graphics/src/damage.rs b/graphics/src/damage.rs
index 5aab06b1..c6b0f759 100644
--- a/graphics/src/damage.rs
+++ b/graphics/src/damage.rs
@@ -1,8 +1,10 @@
+//! Track and compute the damage of graphical primitives.
 use crate::core::{Rectangle, Size};
 use crate::Primitive;
 
 use std::sync::Arc;
 
+/// Computes the damage regions between the two given primitives.
 pub fn regions(a: &Primitive, b: &Primitive) -> Vec<Rectangle> {
     match (a, b) {
         (
@@ -73,6 +75,7 @@ pub fn regions(a: &Primitive, b: &Primitive) -> Vec<Rectangle> {
     }
 }
 
+/// Computes the damage regions between the two given lists of primitives.
 pub fn list(previous: &[Primitive], current: &[Primitive]) -> Vec<Rectangle> {
     let damage = previous
         .iter()
@@ -95,6 +98,8 @@ pub fn list(previous: &[Primitive], current: &[Primitive]) -> Vec<Rectangle> {
     }
 }
 
+/// Groups the given damage regions that are close together inside the given
+/// bounds.
 pub fn group(
     mut damage: Vec<Rectangle>,
     scale_factor: f32,
-- 
cgit