doc: module level doc

prpr/src/bin.rs

@@ -1,3 +1,15 @@
+//! Binary serialization and deserialization for prpr data structures.
+//! Currently:
+//!   - [crate::core::Chart]
+//!   - [crate::core::ChartSettings]
+//!   - [crate::core::JudgeLine]
+//!   - [crate::core::Note]
+//!   - [crate::core::Object]
+//!   - [crate::core::CtrlObject]
+//!   - [crate::core::Anim]
+//!   - [crate::core::Keyframe]
+//!   - [macroquad::prelude::Color]
+
 use crate::{
     core::{
         Anim, AnimVector, BezierTween, BpmList, Chart, ChartExtra, ChartSettings, ClampedTween, CtrlObject, JudgeLine, JudgeLineCache, JudgeLineKind,

prpr/src/config.rs

@@ -1,3 +1,6 @@
+//! Configuration module of the playing environment.\
+//! e.g. player name, volume, speed, autoplay, etc.
+
 use bitflags::bitflags;
 use once_cell::sync::Lazy;
 use serde::{Deserialize, Serialize};

prpr/src/core.rs

@@ -1,3 +1,15 @@
+//! Core module for prpr, submodules:
+//!   - [crate::core::anim]
+//!   - [crate::core::chart]
+//!   - [crate::core::effect]
+//!   - [crate::core::line]
+//!   - [crate::core::note]
+//!   - [crate::core::object]
+//!   - [crate::core::render]
+//!   - [crate::core::resource]
+//!   - [crate::core::smooth]
+//!   - [crate::core::tween]
+
 pub use macroquad::color::Color;
 
 pub const NOTE_WIDTH_RATIO_BASE: f32 = 0.13175016;

prpr/src/core/object.rs

@@ -2,6 +2,7 @@ use super::{AnimFloat, AnimVector, Color, Matrix, Resource, Vector};
 use macroquad::prelude::*;
 use nalgebra::Rotation2;
 
+/// Describes the animation of an in-game object's local coordinate system in the parent coordinate system
 #[derive(Default)]
 pub struct Object {
     pub alpha: AnimFloat,
@@ -72,6 +73,7 @@ impl Object {
     }
 }
 
+/// Describes the animation of an in-game object in its local coordinate system
 #[derive(Default, Clone)]
 pub struct CtrlObject {
     pub alpha: AnimFloat,

prpr/src/core/render.rs

@@ -4,6 +4,7 @@ use macroquad::{
 };
 use miniquad::{gl::GLuint, RenderPass, Texture, TextureFormat};
 
+// TODO: doc
 pub struct MSRenderTarget {
     dim: (u32, u32),
     fbo: GLuint,

prpr/src/dir.rs

@@ -1,3 +1,5 @@
+//! Directory helper
+
 use anyhow::{bail, Result};
 use std::{
     fs::{File, ReadDir},

prpr/src/ext.rs

@@ -1,3 +1,5 @@
+//! Miscellaneous utilities.
+
 use crate::{
     config::Config,
     core::{Matrix, Point, Vector},

prpr/src/fs.rs

@@ -1,3 +1,5 @@
+//! File system abstraction
+
 use crate::{ext::spawn_task, info::ChartInfo};
 use anyhow::{anyhow, bail, Context, Result};
 use async_trait::async_trait;

prpr/src/info.rs

@@ -1,3 +1,5 @@
+//! Chart metadata
+
 use chrono::{DateTime, Utc};
 use serde::{Deserialize, Serialize};
 

prpr/src/judge.rs

@@ -1,3 +1,5 @@
+//! Judgement system
+
 use crate::{
     config::Config,
     core::{BadNote, Chart, NoteKind, Point, Resource, Vector, NOTE_WIDTH_RATIO_BASE},

prpr/src/l10n.rs

@@ -1,3 +1,5 @@
+//! Localization utilities.
+
 pub use fluent::{fluent_args, FluentBundle, FluentResource};
 pub use once_cell::sync::Lazy;
 pub use unic_langid::{langid, LanguageIdentifier};

prpr/src/log.rs

@@ -1,3 +1,5 @@
+//! Logging utilities.
+
 use colored::Colorize;
 use miniquad::{debug, error, info, trace, warn};
 use tracing::{field::Visit, Level, Subscriber};

prpr/src/parse.rs

@@ -1,3 +1,5 @@
+//! Chart parsers
+
 mod extra;
 pub use extra::parse_extra;
 

prpr/src/particle.rs

@@ -1,13 +1,13 @@
-// This is from https://raw.githubusercontent.com/not-fl3/macroquad/master/particles/src/lib.rs
-// We can't use macroquad-particles directly, since it implicitly depends on quad-snd (which is
-// obviously a mistake) and that conflicts with kira.
-
-// Edits:
-// 1. nanoserde related parts are removed for simplicity's sake.
-// 2. apply_viewport
-// 3. clippy
-// 4. time can be customized by input argument
-// 5. Remove EmittersCache
+//! This is from https://raw.githubusercontent.com/not-fl3/macroquad/master/particles/src/lib.rs
+//! We can't use macroquad-particles directly, since it implicitly depends on quad-snd (which is
+//! obviously a mistake) and that conflicts with kira.
+
+//! Edits:
+//! 1. nanoserde related parts are removed for simplicity's sake.
+//! 2. apply_viewport
+//! 3. clippy
+//! 4. time can be customized by input argument
+//! 5. Remove EmittersCache
 
 use macroquad::prelude::*;
 use macroquad::window::miniquad::*;

prpr/src/scene.rs

@@ -1,3 +1,5 @@
+//! Scene management module.
+
 crate::tl_file!("scene" ttl);
 
 mod ending;

prpr/src/task.rs

@@ -1,3 +1,5 @@
+//! Time consuming task management.
+
 use std::{
     future::Future,
     sync::{Arc, Mutex, MutexGuard},

prpr/src/time.rs

@@ -1,3 +1,5 @@
+//! Time manager for music time and real time synchronization.
+
 use crate::config::Config;
 
 pub struct TimeManager {

prpr/src/ui.rs

@@ -1,3 +1,5 @@
+//! UI utilities.
+
 mod billboard;
 pub use billboard::{BillBoard, Message, MessageHandle, MessageKind};