public inbox for devel@edk2.groups.io
 help / color / mirror / Atom feed
From: Dandan Bi <dandan.bi@intel.com>
To: edk2-devel@lists.01.org
Cc: Jian J Wang <jian.j.wang@intel.com>, Liming Gao <liming.gao@intel.com>
Subject: [patch 1/4] IntelFrameworkModulePkg/Csm: Refine coding style in comments
Date: Fri, 20 Oct 2017 08:59:50 +0800	[thread overview]
Message-ID: <1508461193-5204-2-git-send-email-dandan.bi@intel.com> (raw)
In-Reply-To: <1508461193-5204-1-git-send-email-dandan.bi@intel.com>

Make the comments follow Edk2 coding style:
1. Make the comments starts with /** and end with **/.
2. Make the comments descrition end with '.'

Cc: Jian J Wang <jian.j.wang@intel.com>
Cc: Liming Gao <liming.gao@intel.com>
Contributed-under: TianoCore Contribution Agreement 1.1
Signed-off-by: Dandan Bi <dandan.bi@intel.com>
---
 IntelFrameworkModulePkg/Csm/BiosThunk/KeyboardDxe/BiosKeyboard.c | 8 ++++----
 IntelFrameworkModulePkg/Csm/LegacyBiosDxe/LegacyBios.c           | 8 ++++----
 IntelFrameworkModulePkg/Csm/LegacyBiosDxe/LegacyBiosInterface.h  | 8 ++++----
 3 files changed, 12 insertions(+), 12 deletions(-)

diff --git a/IntelFrameworkModulePkg/Csm/BiosThunk/KeyboardDxe/BiosKeyboard.c b/IntelFrameworkModulePkg/Csm/BiosThunk/KeyboardDxe/BiosKeyboard.c
index d2224a2..ebf03d3 100644
--- a/IntelFrameworkModulePkg/Csm/BiosThunk/KeyboardDxe/BiosKeyboard.c
+++ b/IntelFrameworkModulePkg/Csm/BiosThunk/KeyboardDxe/BiosKeyboard.c
@@ -1731,12 +1731,12 @@ CheckKeyboardConnect (
     return TRUE;
   }
 }
 
 /**
-   Disable NULL pointer detection
-*/
+  Disable NULL pointer detection.
+**/
 VOID
 DisableNullDetection (
   VOID
   )
 {
@@ -1778,12 +1778,12 @@ DisableNullDetection (
     DEBUG ((DEBUG_WARN, "!!! Page 0 is supposed to be disabled !!!\r\n"));
   }
 }
 
 /**
-   Enable NULL pointer detection
-*/
+   Enable NULL pointer detection.
+**/
 VOID
 EnableNullDetection (
   VOID
   )
 {
diff --git a/IntelFrameworkModulePkg/Csm/LegacyBiosDxe/LegacyBios.c b/IntelFrameworkModulePkg/Csm/LegacyBiosDxe/LegacyBios.c
index 3176a98..e009999 100644
--- a/IntelFrameworkModulePkg/Csm/LegacyBiosDxe/LegacyBios.c
+++ b/IntelFrameworkModulePkg/Csm/LegacyBiosDxe/LegacyBios.c
@@ -792,12 +792,12 @@ ToggleEndOfDxeStatus (
 // functions can be used to disable/enable NULL pointer detection before/after
 // accessing those memory.
 //
 
 /**
-   Enable NULL pointer detection
-*/
+   Enable NULL pointer detection.
+**/
 VOID
 EnableNullDetection (
   VOID
   )
 {
@@ -842,12 +842,12 @@ EnableNullDetection (
     ASSERT_EFI_ERROR (Status);
   }
 }
 
 /**
-   Disable NULL pointer detection
-*/
+   Disable NULL pointer detection.
+**/
 VOID
 DisableNullDetection (
   VOID
   )
 {
diff --git a/IntelFrameworkModulePkg/Csm/LegacyBiosDxe/LegacyBiosInterface.h b/IntelFrameworkModulePkg/Csm/LegacyBiosDxe/LegacyBiosInterface.h
index 20dfef3..86a3b09 100644
--- a/IntelFrameworkModulePkg/Csm/LegacyBiosDxe/LegacyBiosInterface.h
+++ b/IntelFrameworkModulePkg/Csm/LegacyBiosDxe/LegacyBiosInterface.h
@@ -1543,20 +1543,20 @@ EFI_STATUS
 LegacyBiosInstallVgaRom (
   IN  LEGACY_BIOS_INSTANCE            *Private
   );
 
 /**
-   Enable NULL pointer detection
-*/
+   Enable NULL pointer detection.
+**/
 VOID
 EnableNullDetection (
   VOID
   );
 
 /**
-   Disable NULL pointer detection
-*/
+   Disable NULL pointer detection.
+**/
 VOID
 DisableNullDetection (
   VOID
   );
 
-- 
1.9.5.msysgit.1



  reply	other threads:[~2017-10-20  0:56 UTC|newest]

Thread overview: 9+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2017-10-20  0:59 [patch 0/4] Fix coding style issue Dandan Bi
2017-10-20  0:59 ` Dandan Bi [this message]
2017-10-23  1:19   ` [patch 1/4] IntelFrameworkModulePkg/Csm: Refine coding style in comments Wang, Jian J
2017-10-20  0:59 ` [patch 2/4] IntelFrameworkModule/LegacyBios: Avoid explicit comparison for BOOLEAN Dandan Bi
2017-10-23  1:19   ` Wang, Jian J
2017-10-20  0:59 ` [patch 3/4] MdeModulePkg/DxeIplPeim: Refine coding style in function comments Dandan Bi
2017-10-23  1:20   ` Wang, Jian J
2017-10-20  0:59 ` [patch 4/4] UefiCpuPkg/MtrrLib: Make comments align with function Dandan Bi
2017-10-20  2:08   ` Ni, Ruiyu

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-list from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=1508461193-5204-2-git-send-email-dandan.bi@intel.com \
    --to=devel@edk2.groups.io \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox