Update function comments for AsmPrepareThunk16, AsmThunk16, AsmPrepareAndThunk16...

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

diff --git a/MdePkg/Library/BaseLib/DivS64x64Remainder.c b/MdePkg/Library/BaseLib/DivS64x64Remainder.c
index aa28fc8ccbfa83cdefd31458f85417dab6946ce5..3a1c96617a49991fbde814ebfb66cb8e32ba604a 100644 (file)
--- a/MdePkg/Library/BaseLib/DivS64x64Remainder.c
+++ b/MdePkg/Library/BaseLib/DivS64x64Remainder.c
@@ -1,7 +1,7 @@
 /** @file\r
   Math worker functions.\r
 \r
-  Copyright (c) 2006, Intel Corporation<BR>\r
+  Copyright (c) 2006 - 2008, Intel Corporation<BR>\r
   All rights reserved. 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
@@ -12,6 +12,9 @@
 \r
 **/\r
 \r
+\r
+\r
+\r
 #include "BaseLibInternals.h"\r
 \r
 /**\r
@@ -23,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
@@ -38,7 +45,7 @@ EFIAPI
 DivS64x64Remainder (\r
   IN      INT64                     Dividend,\r
   IN      INT64                     Divisor,\r
-  OUT     INT64                     *Remainder\r
+  OUT     INT64                     *Remainder  OPTIONAL\r
   )\r
 {\r
   ASSERT (Divisor != 0);\r