docs: add more documentation

This commit is contained in:
mokurin000
2025-08-02 02:05:05 +08:00
parent 3721b2f8fd
commit abea7fce11
2 changed files with 10 additions and 2 deletions

View File

@@ -59,9 +59,11 @@ pub struct UserMusicDetail {
/// - 5: SYNC /// - 5: SYNC
pub sync_status: i64, pub sync_status: i64,
/// DX 分数
pub deluxscore_max: i64, pub deluxscore_max: i64,
pub score_rank: i64, pub score_rank: i64,
/// 理论次数
pub ext_num1: i64, pub ext_num1: i64,
pub ext_num2: i64, pub ext_num2: i64,
} }

View File

@@ -27,6 +27,7 @@ pub enum Commands {
qrcode_content: String, qrcode_content: String,
}, },
/// Retrieve update package of SDGB
AuthLite { AuthLite {
#[arg(short, long, default_value = "1.50")] #[arg(short, long, default_value = "1.50")]
title_ver: String, title_ver: String,
@@ -34,12 +35,14 @@ pub enum Commands {
variant: AuthLiteVariant, variant: AuthLiteVariant,
}, },
// below are login-free /// Test delay to SDGB server
Ping, Ping,
/// Get basic info
Preview { Preview {
#[arg(short, long)] #[arg(short, long)]
user_id: u32, user_id: u32,
}, },
/// Get B35 + B15 play records
Rating { Rating {
#[arg(short, long)] #[arg(short, long)]
user_id: u32, user_id: u32,
@@ -51,12 +54,15 @@ pub enum Commands {
#[arg(short, long, default_value_t = RatingFormat::default())] #[arg(short, long, default_value_t = RatingFormat::default())]
format: RatingFormat, format: RatingFormat,
}, },
/// Get all play records
MusicDetail { MusicDetail {
#[arg(short, long)] #[arg(short, long)]
user_id: u32, user_id: u32,
}, },
// below requires login /// Retrieve full userdata
///
/// WARNING: This requires to login & logout your account
Userdata { Userdata {
#[arg(short, long)] #[arg(short, long)]
user_id: u32, user_id: u32,