From 409a9c895d82895dacd8e679f72121146ef6766a Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Wojciech=20Mu=C5=82a?= <wojciech.mula@nextsilicon.com>
Date: Thu, 11 Jul 2024 10:29:36 +0200
Subject: [PATCH] epaint: add some missing inline docs

---
 crates/epaint/src/mesh.rs | 8 ++++++++
 1 file changed, 8 insertions(+)

diff --git a/crates/epaint/src/mesh.rs b/crates/epaint/src/mesh.rs
index 9dd919274e6..2e626df6b79 100644
--- a/crates/epaint/src/mesh.rs
+++ b/crates/epaint/src/mesh.rs
@@ -76,6 +76,7 @@ impl Mesh {
         self.vertices = Default::default();
     }
 
+    /// Returns the amount of memory used by the vertices and indices.
     pub fn bytes_used(&self) -> usize {
         std::mem::size_of::<Self>()
             + self.vertices.len() * std::mem::size_of::<Vertex>()
@@ -107,6 +108,8 @@ impl Mesh {
     }
 
     /// Append all the indices and vertices of `other` to `self`.
+    ///
+    /// Panics when `other` mesh has a different texture.
     pub fn append(&mut self, other: Self) {
         crate::profile_function!();
         debug_assert!(other.is_valid());
@@ -120,6 +123,8 @@ impl Mesh {
 
     /// Append all the indices and vertices of `other` to `self` without
     /// taking ownership.
+    ///
+    /// Panics when `other` mesh has a different texture.
     pub fn append_ref(&mut self, other: &Self) {
         debug_assert!(other.is_valid());
 
@@ -138,6 +143,9 @@ impl Mesh {
         self.vertices.extend(other.vertices.iter());
     }
 
+    /// Add a colored vertex.
+    ///
+    /// Panics when the mesh has assigned a texture.
     #[inline(always)]
     pub fn colored_vertex(&mut self, pos: Pos2, color: Color32) {
         debug_assert!(self.texture_id == TextureId::default());