Code Scrub for MdePkg.

[mirror_edk2.git] / MdePkg / Library / BaseLib / X64 / CpuBreakpoint.c

diff --git a/MdePkg/Library/BaseLib/X64/CpuBreakpoint.c b/MdePkg/Library/BaseLib/X64/CpuBreakpoint.c
index 01939e91280260280e79b92342c30aeed65c8d60..049e34eaaec3e69e5511092b83671d2c1c42a8e3 100644 (file)
--- a/MdePkg/Library/BaseLib/X64/CpuBreakpoint.c
+++ b/MdePkg/Library/BaseLib/X64/CpuBreakpoint.c
@@ -13,13 +13,20 @@
 **/\r
 \r
 \r
-//\r
-// Microsoft Visual Studio 7.1 Function Prototypes for I/O Intrinsics\r
-//\r
+/**\r
+  Microsoft Visual Studio 7.1 Function Prototypes for I/O Intrinsics.\r
+**/\r
 void __debugbreak ();\r
 \r
 #pragma intrinsic(__debugbreak)\r
 \r
+/**\r
+  Generates a breakpoint on the CPU.\r
+\r
+  Generates a breakpoint on the CPU. The breakpoint must be implemented such\r
+  that code can resume normal execution after the breakpoint.\r
+\r
+**/\r
 VOID\r
 EFIAPI\r
 CpuBreakpoint (\r