From a430bdb13215eac169cd1c7e3e2fe88124c84b8e Mon Sep 17 00:00:00 2001
From: darylm503 <darylm503@6f19259b-4bc3-4df7-8a09-765794883524>
Date: Mon, 15 Aug 2011 19:05:36 +0000
Subject: 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
---
 StdLib/Include/sys/signal.h | 30 +++++++++++++++++++++---------
 1 file changed, 21 insertions(+), 9 deletions(-)

(limited to 'StdLib/Include/sys')

diff --git a/StdLib/Include/sys/signal.h b/StdLib/Include/sys/signal.h
index 6f21fcd0a2..e93b2aba37 100644
--- a/StdLib/Include/sys/signal.h
+++ b/StdLib/Include/sys/signal.h
@@ -1,19 +1,30 @@
-/**
-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.
+/** @file
 
-THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
-WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
+    Implementation and Platform specific portion of <signal.h>.
 
+    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 _SYS_SIGNAL_H
 #define _SYS_SIGNAL_H
 #include  <sys/EfiCdefs.h>
 #include  <machine/signal.h>
 
+/** The actual (default) signal numbers are assigned using an anonymous enum
+    so that the compiler can do the work of assigning values.  This helps
+    ensure that the developer should never have to renumber the signals or
+    figure out what number to assign to a new signal.
+
+    Properly constructed programs will NEVER depend upon signal numbers being
+    in a particular order or having a particular value.  All that is guaranteed
+    is that each signal number is distinct, positive, and non-zero.
+**/
 enum {
   __SigInt    = 1,
   __SigIll,
@@ -36,6 +47,7 @@ enum {
 /** The type of a signal handler function. **/
 typedef void __sighandler_t(int);
 
+__BEGIN_DECLS
 /** The signal function associates a "signal handler" with a signal number.
 
     For historical reasons; programs expect signal to be declared
@@ -49,8 +61,8 @@ typedef void __sighandler_t(int);
                 the specified signal sig. Otherwise, a value of SIG_ERR is
                 returned and a positive value is stored in errno.
  */
-__BEGIN_DECLS
 __sighandler_t  *signal(int sig, __sighandler_t *func);
+
 __END_DECLS
 
 #endif    /* _SYS_SIGNAL_H */
-- 
cgit v1.2.3