Update or add comments to files and functions for use by Doxygen.

git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@12139 6f19259b-4bc3-4df7-8a09-765794883524

1 files changed, 23 insertions, 29 deletions

diff --git a/StdLib/Include/signal.h b/StdLib/Include/signal.h
index 6c1ff1b4e4..26f8d6b798 100644
--- a/StdLib/Include/signal.h
+++ b/StdLib/Include/signal.h
@@ -1,28 +1,25 @@
 /** @file

-  The header <signal.h> declares a type and two functions and defines several

+  This file declares a type and two functions and defines several

   macros, for handling various signals (conditions that may be reported during

   program execution).

 

-  The UEFI implementation of <signal.h> maps signals onto the UEFI

-  event mechanism.

+    For historical reasons; programs expect signal to be declared

+    in <sys/signal.h>.  The signal function is documented in <sys/signal.h>.

 

-  An implementation need not generate any of these signals, except as a result

-  of explicit calls to the raise function. Additional signals and pointers to

-  undeclarable functions, with macro definitions beginning, respectively, with

-  the letters SIG and an uppercase letter or with SIG_ and an uppercase letter

-  may also be specified by the implementation. The complete set of signals,

-  their semantics, and their default handling is implementation-defined; all

-  signal numbers shall be positive.

+    The signal function is declared in the C Standard as:<BR>

+    void (*signal(int sig, void (*func)(int)))(int);

 

-Copyright (c) 2010 - 2011, Intel Corporation. All rights reserved.<BR>

-This program and the accompanying materials are licensed and made available under

-the terms and conditions of the BSD License that accompanies this distribution.

-The full text of the license may be found at

-http://opensource.org/licenses/bsd-license.php.

+    The EDK II implementation of the library or base firmware does not generate

+    any of these signals, except as a result of explicit calls to the raise function.

 

-THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,

-WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.

+    Copyright (c) 2010 - 2011, Intel Corporation. All rights reserved.<BR>

+    This program and the accompanying materials are licensed and made available under

+    the terms and conditions of the BSD License that accompanies this distribution.

+    The full text of the license may be found at

+    http://opensource.org/licenses/bsd-license.

 

+    THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,

+    WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.

 **/

 #ifndef _SIGNAL_H

 #define _SIGNAL_H

@@ -36,7 +33,8 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
     This, possibly machine specific, type is defined in <machine/signal.h>.

 */

 

-/** The following three macros expand to constant expressions with distinct

+/** @{

+    The following three macros expand to constant expressions with distinct

     values that have type compatible with the second argument to, and the

     return value of, the signal function, and whose values compare unequal to

     the address of any declarable function.

@@ -44,11 +42,13 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
 #define SIG_IGN   ((__sighandler_t *) 0)

 #define SIG_DFL   ((__sighandler_t *) 1)

 #define SIG_ERR   ((__sighandler_t *) 3)

+/*@}*/

 

-/** The following members expand to positive integer constant expressions with

+/** @{

+    The following macros expand to positive integer constant expressions with

     type int and distinct values that are the signal numbers, each

     corresponding to the specified condition.

-    Many existing programs expect these to be macros.

+    The C95 specification requires these to be macros.

 **/

 #define SIGINT     __SigInt     ///< receipt of an interactive attention signal

 #define SIGILL     __SigIll     ///< detection of an invalid function image, such as an invalid instruction

@@ -66,24 +66,18 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
 #define SIGPIPE    __SigPipe    ///< Added for Posix timer functions

 #define SIGQUIT    __SigQuit    ///< Added for Posix timer functions

 #define SIG_LAST   __Sig_Last   ///< One more than the largest signal number

+/*@}*/

 

 __BEGIN_DECLS

 

-/*  For historical reasons; programs expect signal to be declared

-    in <sys/signal.h>.  The function is documented in <sys/signal.h>.

-

-    The function is declared in the C Standard as:<BR>

-      void (*signal(int sig, void (*func)(int)))(int);

-*/

-

 /** Send a signal.

 

     The raise function carries out the actions described for signal,

     in <sys/signal.h>, for the signal sig. If a signal handler is called, the

-    raise function shall not return until after the signal handler does.

+    raise function does not return until after the signal handler does.

 

     @return   The raise function returns zero if successful,

-              nonzero if unsuccessful.

+              or nonzero if unsuccessful.

 **/

 int raise(int sig);