]> Untitled Git - bdk/commitdiff
doc(example_cli): add missing cli docs
authorvmammal <valuedmammal@protonmail.com>
Wed, 17 Jan 2024 18:58:40 +0000 (13:58 -0500)
committervmammal <valuedmammal@protonmail.com>
Mon, 22 Jan 2024 16:31:36 +0000 (11:31 -0500)
example-crates/example_cli/src/lib.rs

index 39b4f312e91028e83ca2e887a032af9895068305..b1781f5bef7543f8ded41eb17ed5a1ccbf0985f3 100644 (file)
@@ -73,7 +73,9 @@ pub enum Commands<CS: clap::Subcommand, S: clap::Args> {
     },
     /// Send coins to an address.
     Send {
+        /// Amount to send in satoshis
         value: u64,
+        /// Destination address
         address: Address<address::NetworkUnchecked>,
         #[clap(short, default_value = "bnb")]
         coin_select: CoinSelectionAlgo,
@@ -144,14 +146,17 @@ pub enum AddressCmd {
     New,
     /// List all addresses
     List {
+        /// List change addresses
         #[clap(long)]
         change: bool,
     },
+    /// Get last revealed address index for each keychain.
     Index,
 }
 
 #[derive(Subcommand, Debug, Clone)]
 pub enum TxOutCmd {
+    /// List transaction outputs.
     List {
         /// Return only spent outputs.
         #[clap(short, long)]