Refine function comment to follow doxygen format.

[mirror_edk2.git] / MdePkg / Library / BaseLib / DivS64x64Remainder.c

diff --git a/MdePkg/Library/BaseLib/DivS64x64Remainder.c b/MdePkg/Library/BaseLib/DivS64x64Remainder.c
index d8e2a81e4c5240cb20d164d359828b439057c2ab..ef759958d91b669e924487ae24ee134697ed375d 100644 (file)
--- a/MdePkg/Library/BaseLib/DivS64x64Remainder.c
+++ b/MdePkg/Library/BaseLib/DivS64x64Remainder.c
@@ -1,8 +1,8 @@
 /** @file\r
   Math worker functions.\r
 \r
-  Copyright (c) 2006, Intel Corporation<BR>\r
-  All rights reserved. This program and the accompanying materials\r
+  Copyright (c) 2006 - 2008, Intel Corporation. All rights reserved.<BR>\r
+  This program and the accompanying materials\r
   are licensed and made available under the terms and conditions of the BSD License\r
   which accompanies this distribution.  The full text of the license may be found at\r
   http://opensource.org/licenses/bsd-license.php\r
@@ -12,10 +12,8 @@
 \r
 **/\r
 \r
-//\r
-// Include common header file for this module.\r
-//\r
-#include "CommonHeader.h"\r
+\r
+\r
 \r
 #include "BaseLibInternals.h"\r
 \r
@@ -28,6 +26,10 @@
   NULL, then the 64-bit signed remainder is returned in Remainder. This\r
   function returns the 64-bit signed quotient.\r
 \r
+  It is the caller's responsibility to not call this function with a Divisor of 0.\r
+  If Divisor is 0, then the quotient and remainder should be assumed to be \r
+  the largest negative integer.\r
+\r
   If Divisor is 0, then ASSERT().\r
 \r
   @param  Dividend  A 64-bit signed value.\r