doxygenify cutil/danerror.cpp

This commit is contained in:
Jim O'Regan 2015-07-20 12:38:28 +01:00
parent 15ad6bdf5a
commit c8b5dad259

View File

@ -15,9 +15,9 @@
** See the License for the specific language governing permissions and ** See the License for the specific language governing permissions and
** limitations under the License. ** limitations under the License.
******************************************************************************/ ******************************************************************************/
/**---------------------------------------------------------------------------- /*----------------------------------------------------------------------------
Include Files and Type Defines Include Files and Type Defines
----------------------------------------------------------------------------**/ ----------------------------------------------------------------------------*/
#include "host.h" #include "host.h"
#include "danerror.h" #include "danerror.h"
#include "tprintf.h" #include "tprintf.h"
@ -28,27 +28,22 @@
#include <stdio.h> #include <stdio.h>
/*---------------------------------------------------------------------------*/ /**
void DoError(int Error, const char *Message) { * This routine prints the specified error message to stderr.
/* * It then jumps to the current error trap. If the error trap
** Parameters: * stack is empty, the calling program is terminated with a
** Error error number which is to be trapped * fatal error message.
** Message pointer to a string to be printed as an error message *
** Globals: * Globals:
** ErrorTrapStack stack of error traps * - #ErrorTrapStack stack of error traps
** CurrentTrapDepth number of traps on the stack * - #CurrentTrapDepth number of traps on the stack
** Operation: * @param Error error number which is to be trapped
** This routine prints the specified error message to stderr. * @param Message pointer to a string to be printed as an error message
** It then jumps to the current error trap. If the error trap * @return None - this routine does not return.
** stack is empty, the calling program is terminated with a * @note Exceptions: Empty error trap stack terminates the calling program.
** fatal error message. * @note History: 4/3/89, DSJ, Created.
** Return:
** None - this routine does not return.
** Exceptions:
** Empty error trap stack terminates the calling program.
** History:
** 4/3/89, DSJ, Created.
*/ */
void DoError(int Error, const char *Message) {
if (Message != NULL) { if (Message != NULL) {
tprintf("\nError: %s!\n", Message); tprintf("\nError: %s!\n", Message);
} }