Skip to content

Commit

Permalink
chore: fix doc generation and prevent running documentation code snip…
Browse files Browse the repository at this point in the history
…pets
  • Loading branch information
adrien-bon committed Sep 8, 2024
1 parent 5673d9a commit c1c3d7c
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 4 deletions.
4 changes: 2 additions & 2 deletions src/lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@
//!
//! Then add the plugin to your app:
//!
//! ```rust
//! ```no_run
//! use bevy::prelude::*;
//! use bevy_ecs_tiled::prelude::*;
//! use bevy_ecs_tilemap::prelude::*;
Expand All @@ -54,7 +54,7 @@
//! }
//! ```
//!
//! See documentation for [TiledMapBundle] and the [examples](https://github.com/adrien-bon/bevy_ecs_tiled/examples/README.md) for more advanced use cases.
//! See documentation for [components::TiledMapBundle] and the [examples](https://github.com/adrien-bon/bevy_ecs_tiled/examples/README.md) for more advanced use cases.
//!
pub mod components;
Expand Down
4 changes: 2 additions & 2 deletions src/properties/events.rs
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ use tiled::{ObjectData, TileData};
#[cfg(feature = "physics")]
use crate::prelude::*;

/// This event is sent when an object registered with [register_tiled_object] is spawned.
/// This event is sent when an object registered with [crate::properties::app::TiledApp::register_tiled_object] is spawned.
/// It should be handled using an observer. See [associated example](https://github.com/adrien-bon/bevy_ecs_tiled/blob/main/examples/user_properties.rs#L99)
#[derive(Event, Clone, Debug)]
pub struct TiledObjectCreated {
Expand All @@ -21,7 +21,7 @@ pub struct TiledObjectCreated {
pub physics_backend: PhysicsBackend,
}

/// This event is sent when a tile registered with [register_tiled_custom_tile] is spawned.
/// This event is sent when a tile registered with [crate::properties::app::TiledApp::register_tiled_custom_tile] is spawned.
/// It should be handled using an observer. See [associated example](https://github.com/adrien-bon/bevy_ecs_tiled/blob/main/examples/user_properties.rs#L79)
#[derive(Event, Clone, Debug)]
pub struct TiledCustomTileCreated {
Expand Down

0 comments on commit c1c3d7c

Please sign in to comment.