diff --git a/doc/LIBERROR_ASSERT.cware b/doc/LIBERROR_ASSERT.3 similarity index 100% rename from doc/LIBERROR_ASSERT.cware rename to doc/LIBERROR_ASSERT.3 diff --git a/doc/LIBERROR_ASSERT.autodoc b/doc/LIBERROR_ASSERT.autodoc deleted file mode 100755 index 6e6aedf..0000000 --- a/doc/LIBERROR_ASSERT.autodoc +++ /dev/null @@ -1,78 +0,0 @@ -\section NAME -LIBEROR_ASSERT - report an error message to the stderr -\break - -\section SYNOPSIS -\bold-on -#define LIBERROR_ASSERT( -\bold-off -\italics-on -expression -\italics-off -\bold-on -, -\space -\bold-off -\italics-on -type -\italics-off -\bold-on -, -\space -\bold-off -\italics-on -message -\italocs-off -\bold-on -, -\space -\italics-on -function -\italics-off -\bold-on -); -\bold-off - -\break - -\section DESCRIPTION -The LIBERROR_ASSERT macro will raise a runtime error of the type -\space -\italics-on -type -\italics-off -\space -\break -if the expression -\space -\italics-on -expression -\italics-off -\space -evaluates to false. The error will contain a -\break -message describing what happened, as well as the function that the -\break -error occurred in. The error will be written to the stderr in the -\break -format described in -\space -\bold-on -liberror -\bold-off -(cware). - -\break - -\break - -\section SEE ALSO -\bold-on -cware -\bold-off -(cware), -\space -\bold-on -liberror -\bold-off -(cware) diff --git a/doc/LIBERROR_TEST.cware b/doc/LIBERROR_TEST.3 similarity index 100% rename from doc/LIBERROR_TEST.cware rename to doc/LIBERROR_TEST.3 diff --git a/doc/LIBERROR_TEST.autodoc b/doc/LIBERROR_TEST.autodoc deleted file mode 100755 index f56f50e..0000000 --- a/doc/LIBERROR_TEST.autodoc +++ /dev/null @@ -1,59 +0,0 @@ -\section NAME -LIBEROR_TEST - error checks for testcases -\break - -\section SYNOPSIS -\bold-on -#define LIBERROR_TEST( -\bold-off -\italics-on -expression -\italics-off -\bold-on -, -\space -\bold-off -\italics-on -message -\italocs-off -\bold-on -); -\bold-off - -\break - -\section DESCRIPTION -The LIBERROR_TEST macro is a wrapper over -\bold-on -LIBERROR_ASSERT -\bold-off -(cware). -\break -It takes in an expression to test, and the message to display on the -\break -testcase failing. It follows the same semantics as defined in -\break -\bold-on -LIBERROR_ASSERT -\bold-off -(cware). - -\break - -\break - -\section SEE ALSO -\bold-on -cware -\bold-off -(cware), -\space -\bold-on -liberror -\bold-off -(cware), -\space -\bold-on -LIBERROR_ASSERT -\bold-off -(cware) diff --git a/doc/liberror.cware b/doc/liberror.3 similarity index 100% rename from doc/liberror.cware rename to doc/liberror.3 diff --git a/doc/liberror.autodoc b/doc/liberror.autodoc deleted file mode 100755 index e6f947a..0000000 --- a/doc/liberror.autodoc +++ /dev/null @@ -1,71 +0,0 @@ -\section NAME -liberror - error reporting library -\break - -\section DESCRIPTION -liberror is the resident library under C-Ware for reporting error -\break -messages in a structured, computer-readable format. As described in -\break -\bold-on -cware -\bold-off -(cware), liberror produces error messages in the format: -\break -\break -\bold-on -\set-indent 4 -{TYPE}\\t{FUNCTION}\\t{ERROR-MESSSAGE}\\t{FILE}\\t{LINE} -\set-indent 0 -\bold-off -\break -\break -Liberror is intended to be used to allow togglable safety mechanisms -\break -in C-Ware code, like checking for NULL pointers. By design, the various -\break -components of the library are designed to be composed together into -\break -larger error checking operations to validate entire structures, for -\break -example. Also provided is a basic API for adding additional runtime -\break -error checks such as whether or not a structure has been passed through -\break -an operation that releases it from memory. All of this can be enabled -\break -through the definition of the -\space -\bold-on -CWARE_SAFETY_CHECKS -\bold-off -\space -macro. The manuals for the -\break -operations can be found below: -\break -\break -MANUAL -\set-indent 20 -SYNOPSIS -\set-indent 0 -\break ------------------------------------------------------------------------ -\break -LIBERROR_ASSERT(cware) -\set-indent 4 -assert a condition with debugging information -\break -\set-indent 0 -LIBERROR_TEST(cware) -\set-indent 6 -wrapper over LIBERROR_ASSERT for testcases -\break -\set-indent 0 - - -\section SEE ALSO -\bold-on -cware -\bold-off -(cware)