* [PATCH] Staging: bcm: LeakyBucket: format kernel-docs
@ 2014-08-29 20:50 Andrew Plummer
2014-08-30 8:04 ` Matthias Beyer
0 siblings, 1 reply; 2+ messages in thread
From: Andrew Plummer @ 2014-08-29 20:50 UTC (permalink / raw)
To: gregkh; +Cc: devel, linux-kernel, Andrew Plummer
Remove insignificant spaces before tabs in comments.
Signed-off-by: Andrew Plummer <plummer574@gmail.com>
---
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
^ permalink raw reply related [flat|nested] 2+ messages in thread
* Re: [PATCH] Staging: bcm: LeakyBucket: format kernel-docs
2014-08-29 20:50 [PATCH] Staging: bcm: LeakyBucket: format kernel-docs Andrew Plummer
@ 2014-08-30 8:04 ` Matthias Beyer
0 siblings, 0 replies; 2+ messages in thread
From: Matthias Beyer @ 2014-08-30 8:04 UTC (permalink / raw)
To: Andrew Plummer; +Cc: gregkh, devel, linux-kernel
[-- Attachment #1: Type: text/plain, Size: 5185 bytes --]
On 29-08-2014 21:50:16, Andrew Plummer wrote:
> Remove insignificant spaces before tabs in comments.
>
> Signed-off-by: Andrew Plummer <plummer574@gmail.com>
> ---
> 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@linuxdriverproject.org
> http://driverdev.linuxdriverproject.org/mailman/listinfo/driverdev-devel
Reviewed-by: Matthias Beyer <mail@beyermatthias.de>
--
Mit freundlichen Grüßen,
Kind regards,
Matthias Beyer
Proudly sent with mutt.
Happily signed with gnupg.
[-- Attachment #2: Type: application/pgp-signature, Size: 819 bytes --]
^ permalink raw reply [flat|nested] 2+ messages in thread
end of thread, other threads:[~2014-08-30 8:11 UTC | newest]
Thread overview: 2+ messages (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
2014-08-29 20:50 [PATCH] Staging: bcm: LeakyBucket: format kernel-docs Andrew Plummer
2014-08-30 8:04 ` Matthias Beyer
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox