Skip to content

Commit d079d43

Browse files
committed
Add documentation
This commit adds the documentation of modules which were left while some previous commits also adds documentation for the part they moved or introduced. For example commit 4cef0af Fixes #13
1 parent 380becb commit d079d43

File tree

2 files changed

+16
-1
lines changed

2 files changed

+16
-1
lines changed

src/config.rs

+8
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,11 @@
1+
//! Configuration types for Discord bot and Rich Presence integration.
2+
//!
3+
//! This module provides configuration structures for both Discord bot functionality
4+
//! and Rich Presence integration. The configurations are split into two main components:
5+
//!
6+
//! - [`DiscordBotConfig`]: Configuration for the Discord bot (available with `bot` feature)
7+
//! - [`DiscordRichPresenceConfig`]: Configuration for Rich Presence integration (available with `rich_presence` feature)
8+
19
use crate::common::{initialize_field_with_doc, override_field_with_doc};
210
use bevy_ecs::prelude::*;
311
#[cfg(feature = "bot")]

src/events.rs

+8-1
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,10 @@
1+
//! Contains all the Bevy events that can be emitted by the Discord integration.
2+
//!
3+
//! This module is split into two main feature-gated submodules:
4+
//!
5+
//! - [`bot`] - Events related to Discord bot functionality (requires `bot` feature)
6+
//! - [`rich_presence`] - Events related to Discord Rich Presence integration (requires `rich_presence` feature)
7+
18
use crate::common::create_event_collection_and_handler;
29

310
#[cfg(feature = "bot")]
@@ -16,7 +23,7 @@ pub mod bot {
1623
///
1724
/// Provides data about the bot and the guilds it’s in.
1825
///
19-
/// Once, dispatched it automatically inserts [DiscordHttpResource](crate::http::DiscordHttpResource)
26+
/// Once, dispatched it automatically inserts [DiscordHttpResource](crate::res::DiscordHttpResource)
2027
/// to the bevy app.
2128
pub struct BReadyEvent {
2229
pub ctx: Context,

0 commit comments

Comments
 (0)