Add documentation to all public types

Fixes #11
This commit is contained in:
grovesNL 2022-10-18 13:17:35 -02:30 committed by Josh Groves
parent 7e2983374e
commit 296c99f059
4 changed files with 19 additions and 1 deletions

View file

@ -3,6 +3,7 @@ use std::{
fmt::{self, Display, Formatter},
};
/// An error that occurred while preparing text for rendering.
#[derive(Clone, Copy, Debug, Eq, PartialEq)]
pub enum PrepareError {
AtlasFull,
@ -16,6 +17,7 @@ impl Display for PrepareError {
impl Error for PrepareError {}
/// An error that occurred while rendering text.
#[derive(Clone, Copy, Debug, Eq, PartialEq)]
pub enum RenderError {
RemovedFromAtlas,