Annotate event parameter names (#234)

Author: warfollowsme

auction/src/lib.rs

@@ -44,7 +44,7 @@ decl_event!(
 		<T as Trait>::Balance,
 		<T as Trait>::AuctionId,
 	{
-		/// A bid is placed (auction_id, bidder, bidding_amount)
+		/// A bid is placed. [auction_id, bidder, bidding_amount]
 		Bid(AuctionId, AccountId, Balance),
 	}
 );

currencies/src/lib.rs

@@ -92,13 +92,13 @@ decl_event!(
 		Balance = BalanceOf<T>,
 		CurrencyId = CurrencyIdOf<T>
 	{
-		/// Currency transfer success (currency_id, from, to, amount)
+		/// Currency transfer success. [currency_id, from, to, amount]
 		Transferred(CurrencyId, AccountId, AccountId, Balance),
-		/// Update balance success (currency_id, who, amount)
+		/// Update balance success. [currency_id, who, amount]
 		BalanceUpdated(CurrencyId, AccountId, Amount),
-		/// Deposit success (currency_id, who, amount)
+		/// Deposit success. [currency_id, who, amount]
 		Deposited(CurrencyId, AccountId, Balance),
-		/// Withdraw success (currency_id, who, amount)
+		/// Withdraw success. [currency_id, who, amount]
 		Withdrawn(CurrencyId, AccountId, Balance),
 	}
 );

gradually-update/src/lib.rs

@@ -68,11 +68,11 @@ decl_event!(
 	pub enum Event<T> where
 	<T as frame_system::Trait>::BlockNumber,
 	{
-		/// Gradually update added (key, per_block, target_value)
+		/// Gradually update added. [key, per_block, target_value]
 		GraduallyUpdateAdded(StorageKey, StorageValue, StorageValue),
-		/// Gradually update cancelled (key)
+		/// Gradually update cancelled. [key]
 		GraduallyUpdateCancelled(StorageKey),
-		/// Gradually update applied (block_number, key, target_value)
+		/// Gradually update applied. [block_number, key, target_value]
 		Updated(BlockNumber, StorageKey, StorageValue),
 	}
 );

oracle/src/lib.rs

@@ -188,7 +188,7 @@ decl_event!(
 		<T as Trait>::OracleKey,
 		<T as Trait>::OracleValue,
 	{
-		/// New feed data is submitted (sender, values)
+		/// New feed data is submitted. [sender, values]
 		NewFeedData(AccountId, Vec<(OracleKey, OracleValue)>),
 	}
 );

schedule-update/src/lib.rs

@@ -34,13 +34,13 @@ decl_event!(
 	pub enum Event<T> where
 		<T as frame_system::Trait>::BlockNumber,
 	{
-		/// Add schedule dispatch success (BlockNumber, DispatchId)
+		/// Add schedule dispatch success. [block_number, dispatch_id]
 		ScheduleDispatch(BlockNumber, DispatchId),
-		/// Cancel delayed dispatch success (DispatchId)
+		/// Cancel delayed dispatch success. [dispatch_id]
 		CancelDelayedDispatch(DispatchId),
-		/// Schedule dispatch success (BlockNumber, DispatchId)
+		/// Schedule dispatch success. [block_number, dispatch_id]
 		ScheduleDispatchSuccess(BlockNumber, DispatchId),
-		/// Schedule dispatch failed (DispatchId, DispatchError)
+		/// Schedule dispatch failed. [dispatch_id, dispatch_error]
 		ScheduleDispatchFail(DispatchId, DispatchError),
 	}
 );

tokens/src/lib.rs

@@ -176,7 +176,7 @@ decl_event!(
 		<T as Trait>::CurrencyId,
 		<T as Trait>::Balance
 	{
-		/// Token transfer success (currency_id, from, to, amount)
+		/// Token transfer success. [currency_id, from, to, amount]
 		Transferred(CurrencyId, AccountId, AccountId, Balance),
 	}
 );

vesting/src/lib.rs

@@ -138,11 +138,11 @@ decl_event!(
 		Balance = BalanceOf<T>,
 		VestingSchedule = VestingScheduleOf<T>
 	{
-		/// Added new vesting schedule (from, to, vesting_schedule)
+		/// Added new vesting schedule. [from, to, vesting_schedule]
 		VestingScheduleAdded(AccountId, AccountId, VestingSchedule),
-		/// Claimed vesting (who, locked_amount)
+		/// Claimed vesting. [who, locked_amount]
 		Claimed(AccountId, Balance),
-		/// Updated vesting schedules (who)
+		/// Updated vesting schedules. [who]
 		VestingSchedulesUpdated(AccountId),
 	}
 );