From 9e9ef0929c07d20d2681dac6ecced58335bf1895 Mon Sep 17 00:00:00 2001
From: pv42 <pv42@gmail.com>
Date: Tue, 6 Aug 2024 18:33:57 +0200
Subject: [PATCH] Feat: add cli argument documentation
---
mavlink-bindgen/src/cli.rs | 5 +++++
1 file changed, 5 insertions(+)
diff --git a/mavlink-bindgen/src/cli.rs b/mavlink-bindgen/src/cli.rs
index 30fee8a..5ff37b2 100644
--- a/mavlink-bindgen/src/cli.rs
+++ b/mavlink-bindgen/src/cli.rs
@@ -4,11 +4,16 @@ use clap::Parser;
use mavlink_bindgen::{emit_cargo_build_messages, format_generated_code, generate, BindGenError};
#[derive(Parser)]
+/// Generate Rust bindings from MAVLink message dialect XML files.
struct Cli {
+ /// Path to the directory containing the MAVLink dialect definitions.
definitions_dir: PathBuf,
+ /// Path to the directory where the code is generated into, must already exist.
destination_dir: PathBuf,
+ /// format code generated code
#[arg(long)]
format_generated_code: bool,
+ /// prints cargo build messages indicating when the code has to be rebuild
#[arg(long)]
emit_cargo_build_messages: bool,
}
--
GitLab