1. Patchew
  2. EDK2
  3. [edk2] [patch 0/4] Fix coding style issue
  4. View patch

[edk2] [patch 3/4] MdeModulePkg/DxeIplPeim: Refine coding style in function comments

Dandan Bi posted 4 patches 8 years ago
[edk2] [patch 3/4] MdeModulePkg/DxeIplPeim: Refine coding style in function comments
Posted by Dandan Bi 8 years ago 
Make the comments align with the function.
And add some missing function comments.

Cc: Jian J Wang <jian.j.wang@intel.com>
Cc: Eric Dong <eric.dong@intel.com>
Contributed-under: TianoCore Contribution Agreement 1.1
Signed-off-by: Dandan Bi <dandan.bi@intel.com>
---
 MdeModulePkg/Core/DxeIplPeim/DxeIpl.h            | 14 +++++++-------
 MdeModulePkg/Core/DxeIplPeim/X64/VirtualMemory.c | 15 +++++++++++----
 2 files changed, 18 insertions(+), 11 deletions(-)

diff --git a/MdeModulePkg/Core/DxeIplPeim/DxeIpl.h b/MdeModulePkg/Core/DxeIplPeim/DxeIpl.h
index ecf1866..f3aabdb 100644
--- a/MdeModulePkg/Core/DxeIplPeim/DxeIpl.h
+++ b/MdeModulePkg/Core/DxeIplPeim/DxeIpl.h
@@ -239,28 +239,28 @@ Decompress (
   OUT       VOID                    **OutputBuffer,
   OUT       UINTN                   *OutputSize
   );
 
 /**
-   Clear legacy memory located at the first 4K-page.
+  Clear legacy memory located at the first 4K-page.
 
-   This function traverses the whole HOB list to check if memory from 0 to 4095
-   exists and has not been allocated, and then clear it if so.
+  This function traverses the whole HOB list to check if memory from 0 to 4095
+  exists and has not been allocated, and then clear it if so.
 
-   @param HoStart         The start of HobList passed to DxeCore.
+  @param HobStart         The start of HobList passed to DxeCore.
 
 **/
 VOID
 ClearFirst4KPage (
   IN  VOID *HobStart
   );
 
 /**
-   Return configure status of NULL pointer detection feature
+  Return configure status of NULL pointer detection feature.
 
-   @return TRUE   NULL pointer detection feature is enabled
-   @return FALSE  NULL pointer detection feature is disabled
+  @return TRUE   NULL pointer detection feature is enabled
+  @return FALSE  NULL pointer detection feature is disabled
 **/
 BOOLEAN
 IsNullDetectionEnabled (
   VOID
   );
diff --git a/MdeModulePkg/Core/DxeIplPeim/X64/VirtualMemory.c b/MdeModulePkg/Core/DxeIplPeim/X64/VirtualMemory.c
index a10dea2..29b6205 100644
--- a/MdeModulePkg/Core/DxeIplPeim/X64/VirtualMemory.c
+++ b/MdeModulePkg/Core/DxeIplPeim/X64/VirtualMemory.c
@@ -30,16 +30,16 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
 
 #include "DxeIpl.h"
 #include "VirtualMemory.h"
 
 /**
-   Clear legacy memory located at the first 4K-page, if available.
+  Clear legacy memory located at the first 4K-page, if available.
 
-   This function traverses the whole HOB list to check if memory from 0 to 4095
-   exists and has not been allocated, and then clear it if so.
+  This function traverses the whole HOB list to check if memory from 0 to 4095
+  exists and has not been allocated, and then clear it if so.
 
-   @param HoStart                   The start of HobList passed to DxeCore.
+  @param HobStart                  The start of HobList passed to DxeCore.
 
 **/
 VOID
 ClearFirst4KPage (
   IN  VOID *HobStart
@@ -84,10 +84,17 @@ ClearFirst4KPage (
   }
 
   return;
 }
 
+/**
+  Return configure status of NULL pointer detection feature.
+
+  @return TRUE   NULL pointer detection feature is enabled
+  @return FALSE  NULL pointer detection feature is disabled
+
+**/
 BOOLEAN
 IsNullDetectionEnabled (
   VOID
   )
 {
-- 
1.9.5.msysgit.1

_______________________________________________
edk2-devel mailing list
edk2-devel@lists.01.org
https://lists.01.org/mailman/listinfo/edk2-devel
Re: [edk2] [patch 3/4] MdeModulePkg/DxeIplPeim: Refine coding style in function comments
Posted by Wang, Jian J 8 years ago 

Reviewed-by: Jian J Wang <jian.j.wang@intel.com>




> -----Original Message-----
> From: Bi, Dandan
> Sent: Friday, October 20, 2017 9:00 AM
> To: edk2-devel@lists.01.org
> Cc: Wang, Jian J <jian.j.wang@intel.com>; Dong, Eric <eric.dong@intel.com>
> Subject: [patch 3/4] MdeModulePkg/DxeIplPeim: Refine coding style in function
> comments
> 
> Make the comments align with the function.
> And add some missing function comments.
> 
> Cc: Jian J Wang <jian.j.wang@intel.com>
> Cc: Eric Dong <eric.dong@intel.com>
> Contributed-under: TianoCore Contribution Agreement 1.1
> Signed-off-by: Dandan Bi <dandan.bi@intel.com>
> ---
>  MdeModulePkg/Core/DxeIplPeim/DxeIpl.h            | 14 +++++++-------
>  MdeModulePkg/Core/DxeIplPeim/X64/VirtualMemory.c | 15 +++++++++++----
>  2 files changed, 18 insertions(+), 11 deletions(-)
> 
> diff --git a/MdeModulePkg/Core/DxeIplPeim/DxeIpl.h
> b/MdeModulePkg/Core/DxeIplPeim/DxeIpl.h
> index ecf1866..f3aabdb 100644
> --- a/MdeModulePkg/Core/DxeIplPeim/DxeIpl.h
> +++ b/MdeModulePkg/Core/DxeIplPeim/DxeIpl.h
> @@ -239,28 +239,28 @@ Decompress (
>    OUT       VOID                    **OutputBuffer,
>    OUT       UINTN                   *OutputSize
>    );
> 
>  /**
> -   Clear legacy memory located at the first 4K-page.
> +  Clear legacy memory located at the first 4K-page.
> 
> -   This function traverses the whole HOB list to check if memory from 0 to 4095
> -   exists and has not been allocated, and then clear it if so.
> +  This function traverses the whole HOB list to check if memory from 0 to 4095
> +  exists and has not been allocated, and then clear it if so.
> 
> -   @param HoStart         The start of HobList passed to DxeCore.
> +  @param HobStart         The start of HobList passed to DxeCore.
> 
>  **/
>  VOID
>  ClearFirst4KPage (
>    IN  VOID *HobStart
>    );
> 
>  /**
> -   Return configure status of NULL pointer detection feature
> +  Return configure status of NULL pointer detection feature.
> 
> -   @return TRUE   NULL pointer detection feature is enabled
> -   @return FALSE  NULL pointer detection feature is disabled
> +  @return TRUE   NULL pointer detection feature is enabled
> +  @return FALSE  NULL pointer detection feature is disabled
>  **/
>  BOOLEAN
>  IsNullDetectionEnabled (
>    VOID
>    );
> diff --git a/MdeModulePkg/Core/DxeIplPeim/X64/VirtualMemory.c
> b/MdeModulePkg/Core/DxeIplPeim/X64/VirtualMemory.c
> index a10dea2..29b6205 100644
> --- a/MdeModulePkg/Core/DxeIplPeim/X64/VirtualMemory.c
> +++ b/MdeModulePkg/Core/DxeIplPeim/X64/VirtualMemory.c
> @@ -30,16 +30,16 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY
> KIND, EITHER EXPRESS OR IMPLIED.
> 
>  #include "DxeIpl.h"
>  #include "VirtualMemory.h"
> 
>  /**
> -   Clear legacy memory located at the first 4K-page, if available.
> +  Clear legacy memory located at the first 4K-page, if available.
> 
> -   This function traverses the whole HOB list to check if memory from 0 to 4095
> -   exists and has not been allocated, and then clear it if so.
> +  This function traverses the whole HOB list to check if memory from 0 to 4095
> +  exists and has not been allocated, and then clear it if so.
> 
> -   @param HoStart                   The start of HobList passed to DxeCore.
> +  @param HobStart                  The start of HobList passed to DxeCore.
> 
>  **/
>  VOID
>  ClearFirst4KPage (
>    IN  VOID *HobStart
> @@ -84,10 +84,17 @@ ClearFirst4KPage (
>    }
> 
>    return;
>  }
> 
> +/**
> +  Return configure status of NULL pointer detection feature.
> +
> +  @return TRUE   NULL pointer detection feature is enabled
> +  @return FALSE  NULL pointer detection feature is disabled
> +
> +**/
>  BOOLEAN
>  IsNullDetectionEnabled (
>    VOID
>    )
>  {
> --
> 1.9.5.msysgit.1

_______________________________________________
edk2-devel mailing list
edk2-devel@lists.01.org
https://lists.01.org/mailman/listinfo/edk2-devel

Patchew 2.1-devel-8c64711

© 2016 - 2025 Red Hat, Inc.