doc: [macro-q12] missing natspec (#36)

* doc: missing natspec

* chore: typo

Author: liu-zhipeng

contracts/destination/xreceivers/AuthForwarderXReceiver.sol

@@ -144,6 +144,7 @@ abstract contract AuthForwarderXReceiver is IXReceiver, Ownable2Step {
    * @param _amount - The amount of funds received in this transfer
    * @param _asset - The asset of the funds received in this transfer
    * @param _callData - The data to be prepared and forwarded
+   * @return the success status of the forwardFunctionCall
    */
   function xReceive(
     bytes32 _transferId,
@@ -199,6 +200,7 @@ abstract contract AuthForwarderXReceiver is IXReceiver, Ownable2Step {
    * @param _data - The data to be prepared
    * @param _amount - The amount of funds received in this transfer
    * @param _asset - The asset of the funds received in this transfer
+   * @return The result of the forward Function call
    */
   function prepareAndForward(
     bytes32 _transferId,
@@ -229,6 +231,7 @@ abstract contract AuthForwarderXReceiver is IXReceiver, Ownable2Step {
    * @param _data - The data to be prepared
    * @param _amount - The amount of funds received in this transfer
    * @param _asset - The asset of the funds received in this transfer
+   * @return encoded data
    */
   function _prepare(
     bytes32 _transferId,
@@ -249,6 +252,7 @@ abstract contract AuthForwarderXReceiver is IXReceiver, Ownable2Step {
    * @param _transferId - The transfer ID of the transfer that triggered this call
    * @param _amount - The amount of funds received in this transfer
    * @param _asset - The asset of the funds received in this transfer
+   * @return the result of the call
    */
   function _forwardFunctionCall(
     bytes memory _preparedData,

contracts/destination/xreceivers/ForwarderXReceiver.sol

@@ -58,6 +58,7 @@ abstract contract ForwarderXReceiver is IXReceiver {
    * @param _amount - The amount of funds received in this transfer.
    * @param _asset - The asset of the funds received in this transfer.
    * @param _callData - The data to be prepared and forwarded. Fallback address needs to be encoded in the data to be used in case the forward fails.
+   * @return the success status of the forwardFunctionCall
    */
   function xReceive(
     bytes32 _transferId,
@@ -113,6 +114,7 @@ abstract contract ForwarderXReceiver is IXReceiver {
    * @param _data - The data to be prepared
    * @param _amount - The amount of funds received in this transfer
    * @param _asset - The asset of the funds received in this transfer
+   * @return The result of the forward Function call
    */
   function prepareAndForward(
     bytes32 _transferId,
@@ -143,6 +145,7 @@ abstract contract ForwarderXReceiver is IXReceiver {
    * @param _data - The data to be prepared
    * @param _amount - The amount of funds received in this transfer
    * @param _asset - The asset of the funds received in this transfer
+   * @return encoded data
    */
   function _prepare(
     bytes32 _transferId,
@@ -163,6 +166,7 @@ abstract contract ForwarderXReceiver is IXReceiver {
    * @param _transferId - The transfer ID of the transfer that triggered this call
    * @param _amount - The amount of funds received in this transfer
    * @param _asset - The asset of the funds received in this transfer
+   * @return the result of the call
    */
   function _forwardFunctionCall(
     bytes memory _preparedData,

contracts/destination/xreceivers/Swap/SwapForwarderXReceiver.sol

@@ -24,6 +24,7 @@ abstract contract SwapForwarderXReceiver is ForwarderXReceiver, SwapAdapter {
    * @param _data The data to be swapped.
    * @param _amount The amount to be swapped.
    * @param _asset The incoming asset to be swapped.
+   * @return prepared data
    */
   function _prepare(
     bytes32 _transferId,

contracts/shared/Swap/OneInch/OneInchUniswapV3.sol

@@ -42,6 +42,7 @@ contract OneInchUniswapV3 is ISwapper {
    * @param _fromAsset Address of the token to swap from.
    * @param _toAsset Address of the token to swap to.
    * @param _swapData Data to pass to the 1inch aggregator router.
+   * @return amountOut Amount of the token received
    */
   function swap(
     uint256 _amountIn,
@@ -81,6 +82,7 @@ contract OneInchUniswapV3 is ISwapper {
    * @param _amountIn Amount of tokens to swap.
    * @param _toAsset Address of the token to swap to.
    * @param _swapData Data to pass to the 1inch aggregator router.
+   * @return amountOut Amount of the token received
    */
   function swapETH(
     uint256 _amountIn,

contracts/shared/Swap/SwapAdapter.sol

@@ -76,6 +76,7 @@ contract SwapAdapter is Ownable2Step {
    * @param _toAsset Address of the token to swap to.
    * @param _swapData Data to pass to the swapper. This data is encoded for a particular swap router, usually given
    * by an API. The swapper will decode the data and re-encode it with the new amountIn.
+   * @return amountOut Amount that is expected to get received in the swap
    */
   function exactSwap(
     address _swapper,
@@ -108,6 +109,7 @@ contract SwapAdapter is Ownable2Step {
    * easy swaps on the source side where the amount does not need to be changed.
    * @param _swapper Address of the swapper to use.
    * @param swapData Data to pass to the swapper. This data is encoded for a particular swap router.
+   * @return amountOut Amount that is expected to get received in the swap
    */
   function directSwapperCall(address _swapper, bytes calldata swapData) external payable returns (uint256 amountOut) {
     require(allowedSwappers[_swapper], "!allowedSwapper");

contracts/shared/Swap/Uniswap/UniV2Swapper.sol

@@ -26,6 +26,7 @@ contract UniV2Swapper is ISwapper {
    * @param _fromAsset Address of the token to swap from.
    * @param _toAsset Address of the token to swap to.
    * @param _swapData Data to pass to the UniV2 router.
+   * @return amountOut Amount of the token received
    */
   function swap(
     uint256 _amountIn,
@@ -73,6 +74,7 @@ contract UniV2Swapper is ISwapper {
    * @param _amountIn Amount of tokens to swap.
    * @param _toAsset Address of the token to swap to.
    * @param _swapData Data to pass to the UniV2 router.
+   * @return amountOut Amount of the token received
    */
   function swapETH(
     uint256 _amountIn,

contracts/shared/Swap/Uniswap/UniV3Swapper.sol

@@ -30,6 +30,7 @@ contract UniV3Swapper is ISwapper {
    * @param _fromAsset Address of the token to swap from.
    * @param _toAsset Address of the token to swap to.
    * @param _swapData Data to pass to the UniV3 router.
+   * @return amountOut Amount of the token received
    */
   function swap(
     uint256 _amountIn,
@@ -82,6 +83,7 @@ contract UniV3Swapper is ISwapper {
    * @param _amountIn Amount of tokens to swap.
    * @param _toAsset Address of the token to swap to.
    * @param _swapData Data to pass to the UniV3 router.
+   * @return amountOut Amount of the token received
    */
   function swapETH(
     uint256 _amountIn,

contracts/shared/Swap/interfaces/ISwapper.sol

@@ -3,13 +3,22 @@
 pragma solidity ^0.8.17;
 
 interface ISwapper {
+  /// @notice Swaps `amountIn` of _tokenIn for as much as possible of _tokenOut
+  /// @param _amountIn The amount of the token to swap
+  /// @param _tokenIn The address of the token0
+  /// @param _tokenOut The amount of the token1
+  /// @return amountOut The amount of the received token
   function swap(
     uint256 _amountIn,
     address _tokenIn,
     address _tokenOut,
     bytes calldata _swapData
   ) external returns (uint256 amountOut);
 
+  /// @notice Swaps `amountIn` of ETH for as much as possible of _tokenOut
+  /// @param _amountIn The amount of the token to swap
+  /// @param _tokenOut The amount of the token1
+  /// @return amountOut The amount of the received token
   function swapETH(
     uint256 _amountIn,
     address _tokenOut,