diff --git a/bin/src/commands/build.rs b/bin/src/commands/build.rs index 93a56770..f7f78d6a 100644 --- a/bin/src/commands/build.rs +++ b/bin/src/commands/build.rs @@ -9,10 +9,9 @@ use crate::{ use super::global_modules; #[derive(clap::Parser)] -#[command( - long_about = "Build your project in release mode for testing, without signing for full release." -)] /// Build the project for final testing +/// +/// Build your project in release mode for testing, without signing for full release. pub struct Command { #[clap(flatten)] build: Args, diff --git a/bin/src/commands/dev.rs b/bin/src/commands/dev.rs index 9546dc99..ec778367 100644 --- a/bin/src/commands/dev.rs +++ b/bin/src/commands/dev.rs @@ -11,17 +11,11 @@ use crate::{ use super::JustArgs; -// #[must_use] -// pub fn cli() -> Command { -// add_just(add_args( -// Command::new("dev") -// .about("Build the project for development") -// .long_about("Build your project for local development and testing. It is built without binarization of .p3d and .rtm files."), -// )) -// } - #[derive(clap::Parser)] /// Build the project for development +/// +/// Build your project for local development and testing. +/// It is built without binarization of .p3d and .rtm files. pub struct Command { #[clap(flatten)] dev: Args, diff --git a/bin/src/commands/launch/mod.rs b/bin/src/commands/launch/mod.rs index f5c1f431..daac09e4 100644 --- a/bin/src/commands/launch/mod.rs +++ b/bin/src/commands/launch/mod.rs @@ -25,6 +25,9 @@ use crate::{ #[derive(clap::Parser)] /// Test your project +/// +/// Builds your project in dev mode and launches Arma 3 with +/// file patching enabled, loading your mod and any workshop mods. pub struct Command { #[clap(flatten)] launch: Args, diff --git a/bin/src/commands/release.rs b/bin/src/commands/release.rs index 178ed8ce..73529b57 100644 --- a/bin/src/commands/release.rs +++ b/bin/src/commands/release.rs @@ -3,8 +3,9 @@ use crate::{context::Context, error::Error, modules::Sign, report::Report}; use super::build; #[derive(clap::Parser)] -#[command(long_about = "Build your project for full release, with signing and archiving.")] /// Build the project for release +/// +/// Build your project for full release, with signing and archiving. pub struct Command { #[clap(flatten)] build: build::Args, diff --git a/bin/src/commands/script.rs b/bin/src/commands/script.rs index 116e2e30..9e677f55 100644 --- a/bin/src/commands/script.rs +++ b/bin/src/commands/script.rs @@ -3,6 +3,9 @@ use crate::{context::Context, error::Error, modules::Hooks, report::Report}; #[derive(clap::Parser)] #[command(arg_required_else_help = true)] /// Run a Rhai script on the project +/// +/// Run a Rhai script on the project, this is useful for automating tasks +/// in a platform agnostic way, or requiring external dependencies. pub struct Command { #[clap(name = "name")] name: String, diff --git a/bin/src/commands/value.rs b/bin/src/commands/value.rs index 42e28e4f..e70ff2a4 100644 --- a/bin/src/commands/value.rs +++ b/bin/src/commands/value.rs @@ -5,6 +5,8 @@ use crate::{context::Context, error::Error, report::Report}; #[derive(clap::Parser)] #[command(arg_required_else_help = true)] /// Print a value from the project +/// +/// Print a value from the project, use `list` to see all available values pub struct Command { #[clap(name = "name")] name: String, diff --git a/bin/src/utils/verify.rs b/bin/src/utils/verify.rs index 2bf576b9..8e244b98 100644 --- a/bin/src/utils/verify.rs +++ b/bin/src/utils/verify.rs @@ -10,6 +10,8 @@ use crate::{ #[derive(clap::Parser)] #[command(arg_required_else_help = true)] /// Verify a signed PBO +/// +/// Checks a .bisign file against a public key and PBO pub struct Command { /// PBO to verify pbo: String,