chore: API doc

src/cache.rs

@@ -1,3 +1,5 @@
+//! This module contains an implementation for [tiled::ResourceCache]
+
 use bevy::prelude::*;
 use std::sync::{Arc, RwLock};
 use tiled::{DefaultResourceCache, ResourceCache};

src/map/asset.rs

@@ -1,4 +1,4 @@
-//! This module contains all [Asset]s definition.
+//! This module contains all map [Asset]s definition.
 
 use std::io::ErrorKind;
 #[cfg(feature = "user_properties")]

src/map/components.rs

@@ -1,10 +1,10 @@
-//! This module contains all [Component]s definition.
+//! This module contains all map [Component]s definition.
 
 use crate::prelude::*;
 use bevy::{prelude::*, utils::HashMap};
 use tiled::TileId;
 
-/// [Component] holding Tiled related settings.
+/// [Component] holding Tiled map related settings.
 ///
 /// Controls various settings related to the way we handle the Tiled map.
 /// Must be added to the [Entity] holding the map.

src/map/mod.rs

@@ -1,3 +1,5 @@
+//! This module handles all the logic related to loading and spawning Tiled maps
+
 pub mod asset;
 pub mod components;
 pub mod events;

src/reader.rs

@@ -1,3 +1,5 @@
+//! This module contains an implementation for [tiled::ResourceReader]
+
 use bevy::asset::LoadContext;
 use std::{
     io::{Cursor, Error as IoError, ErrorKind, Read},

src/world/asset.rs

@@ -1,3 +1,5 @@
+//! This module contains all world [Asset]s definition.
+
 use bevy::{
     asset::{io::Reader, AssetLoader, AssetPath, LoadContext},
     prelude::*,
@@ -11,10 +13,11 @@ use crate::{cache::TiledResourceCache, reader::BytesResourceReader, TiledMap};
 /// `Asset` holding Tiled world informations.
 #[derive(TypePath, Asset)]
 pub struct TiledWorld {
+    /// The raw Tiled world data
     pub world: tiled::World,
-
+    /// The [Rect] boundary of our worlds ie. the sum of all the maps boundary it contains
     pub world_rect: Rect,
-
+    /// List of all the maps contained in this world and their associated [Rect] boundary
     pub maps: Vec<(Rect, Handle<TiledMap>)>,
 }
 

src/world/components.rs

@@ -1,18 +1,35 @@
+//! This module contains all map [Component]s definition.
+
 use bevy::{prelude::*, utils::HashMap};
 
+/// [Component] holding Tiled world related settings.
+///
+/// Controls various settings related to the way we handle the Tiled world.
+/// Must be added to the [Entity] holding the world.
 #[derive(Component, Default)]
 pub struct TiledWorldSettings {
+    /// World chunking configuration
+    ///
+    /// If this value is None, we won't perform chunking: all maps from this world will just be loaded
+    /// If this value is set, defines the area (in pixel) around each [Camera] where we should spawn a
+    /// map if it overlaps with its associated [Rect].
     pub chunking: Option<(u32, u32)>,
 }
 
 /// Marker [Component] for a Tiled world.
 #[derive(Component)]
 pub struct TiledWorldMarker;
 
+/// Marker [Component] to trigger a world respawn.
+///
+/// Must be added to the [Entity] holding the map.
 #[derive(Component)]
 pub struct RespawnTiledWorld;
 
+/// [Component] storing informations about which maps are actually spawned
 #[derive(Component, Default)]
 pub struct TiledWorldStorage {
+    /// Map using the map index from [super::asset::TiledWorld] maps list as key.
+    /// It contains the map entity.
     pub spawned_maps: HashMap<usize, Entity>,
 }

src/world/events.rs

@@ -1,14 +1,21 @@
+//! Events related to Tiled world loading
+//!
+//! These events will be fired after the whole map has loaded.
+
 use crate::prelude::*;
 use bevy::prelude::*;
 
-/// Event sent when a Tiled world has finished loading
+/// Event sent when a Tiled world has finished loading.
 #[derive(Event, Clone, Debug)]
 pub struct TiledWorldCreated {
+    /// Spawned world [Entity].
     pub world: Entity,
+    /// [AssetId] of the corresponding [super::asset::TiledWorld] asset.
     pub world_asset_id: AssetId<TiledWorld>,
 }
 
 impl<'a> TiledWorldCreated {
+    /// Retrieve the [TiledWorld] associated to this [TiledWorldCreated] event.
     pub fn get_world(&self, world_asset: &'a Res<Assets<TiledWorld>>) -> Option<&'a TiledWorld> {
         world_asset.get(self.world_asset_id)
     }

src/world/mod.rs

@@ -1,3 +1,5 @@
+//! This module handles all the logic related to loading and spawning Tiled worlds.
+
 pub mod asset;
 pub mod components;
 pub mod events;