Re: [PATCH] Staging: bcm: LeakyBucket: format kernel-docs

[Matthias Beyer]

On 29-08-2014 21:50:16, Andrew Plummer wrote:
> Remove insignificant spaces before tabs in comments.
> 
> Signed-off-by: Andrew Plummer <plummer574@xxxxxxxxx>
> ---
>  drivers/staging/bcm/LeakyBucket.c | 81 ++++++++++++++++-----------------------
>  1 file changed, 33 insertions(+), 48 deletions(-)
> 
> diff --git a/drivers/staging/bcm/LeakyBucket.c b/drivers/staging/bcm/LeakyBucket.c
> index 8c4030d..d6b55f9 100644
> --- a/drivers/staging/bcm/LeakyBucket.c
> +++ b/drivers/staging/bcm/LeakyBucket.c
> @@ -1,20 +1,16 @@
>  /**********************************************************************
> -* 			LEAKYBUCKET.C
> +*			LEAKYBUCKET.C
>  *	This file contains the routines related to Leaky Bucket Algorithm.
>  ***********************************************************************/
>  #include "headers.h"
>  
> -/*********************************************************************
> -* Function    - UpdateTokenCount()
> -*
> -* Description - This function calculates the token count for each
> -*				channel and updates the same in Adapter strucuture.
> -*
> -* Parameters  - Adapter: Pointer to the Adapter structure.
> -*
> -* Returns     - None
> -**********************************************************************/
> -
> +/**
> + * UpdateTokenCount() - Calculates the token count for each channel
> + * and updates the same in Adapter structure
> + * @Adapter:	Pointer to the Adapter structure.
> + *
> + * Return: None
> + */
>  static VOID UpdateTokenCount(register struct bcm_mini_adapter *Adapter)
>  {
>  	ULONG liCurrentTime;
> @@ -59,20 +55,16 @@ static VOID UpdateTokenCount(register struct bcm_mini_adapter *Adapter)
>  }
>  
>  
> -/*********************************************************************
> -* Function    - IsPacketAllowedForFlow()
> -*
> -* Description - This function checks whether the given packet from the
> -*				specified queue can be allowed for transmission by
> -*				checking the token count.
> -*
> -* Parameters  - Adapter	      :	Pointer to the Adpater structure.
> -* 			  - iQIndex	      :	The queue Identifier.
> -* 			  - ulPacketLength:	Number of bytes to be transmitted.
> -*
> -* Returns     - The number of bytes allowed for transmission.
> -*
> -***********************************************************************/
> +/**
> + * IsPacketAllowedForFlow() - This function checks whether the given
> + * packet from the specified queue can be allowed for transmission by
> + * checking the token count.
> + * @Adapter:		Pointer to the Adpater structure.
> + * @iQIndex:		The queue Identifier.
> + * @ulPacketLength:	Number of bytes to be transmitted.
> + *
> + * Returns: The number of bytes allowed for transmission.
> + */
>  static ULONG GetSFTokenCount(struct bcm_mini_adapter *Adapter, struct bcm_packet_info *psSF)
>  {
>  	BCM_DEBUG_PRINT(Adapter, DBG_TYPE_TX, TOKEN_COUNTS, DBG_LVL_ALL,
> @@ -256,18 +248,14 @@ static void send_control_packet(struct bcm_mini_adapter *ad,
>  	}
>  }
>  
> -/************************************************************************
> -* Function    - CheckAndSendPacketFromIndex()
> -*
> -* Description - This function dequeues the data/control packet from the
> -*				specified queue for transmission.
> -*
> -* Parameters  - Adapter : Pointer to the driver control structure.
> -* 			  - iQIndex : The queue Identifier.
> -*
> -* Returns     - None.
> -*
> -****************************************************************************/
> +/**
> + * CheckAndSendPacketFromIndex() - This function dequeues the
> + * data/control packet from the specified queue for transmission.
> + * @Adapter:	Pointer to the driver control structure.
> + * @iQIndex:	The queue Identifier.
> + *
> + * Returns: None.
> + */
>  static VOID CheckAndSendPacketFromIndex(struct bcm_mini_adapter *Adapter,
>  					struct bcm_packet_info *psSF)
>  {
> @@ -284,16 +272,13 @@ static VOID CheckAndSendPacketFromIndex(struct bcm_mini_adapter *Adapter,
>  }
>  
>  
> -/*******************************************************************
> -* Function    - transmit_packets()
> -*
> -* Description - This function transmits the packets from different
> -*				queues, if free descriptors are available on target.
> -*
> -* Parameters  - Adapter:  Pointer to the Adapter structure.
> -*
> -* Returns     - None.
> -********************************************************************/
> +/**
> + * transmit_packets() - This function transmits the packets from
> + * different queues, if free descriptors are available on target.
> + * @Adapter:	Pointer to the Adapter structure.
> + *
> + * Returns: None.
> + */
>  VOID transmit_packets(struct bcm_mini_adapter *Adapter)
>  {
>  	UINT uiPrevTotalCount = 0;
> -- 
> 1.9.1
> 
> _______________________________________________
> devel mailing list
> devel@xxxxxxxxxxxxxxxxxxxxxx
> http://driverdev.linuxdriverproject.org/mailman/listinfo/driverdev-devel

Reviewed-by: Matthias Beyer <mail@xxxxxxxxxxxxxxxx>

-- 
Mit freundlichen Grüßen,
Kind regards,
Matthias Beyer

Proudly sent with mutt.
Happily signed with gnupg.

Attachment: pgp7zd7sWxge3.pgp
Description: PGP signature