doxygenify cutil/efio.cpp

This commit is contained in:
Jim O'Regan 2015-07-20 12:29:50 +01:00
parent f18387fd3a
commit 15ad6bdf5a

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 "efio.h" #include "efio.h"
#include "danerror.h" #include "danerror.h"
#include <stdio.h> #include <stdio.h>
@ -25,29 +25,22 @@
#define MAXERRORMESSAGE 256 #define MAXERRORMESSAGE 256
/**---------------------------------------------------------------------------- /*----------------------------------------------------------------------------
Public Code Public Code
----------------------------------------------------------------------------**/ ----------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/ /**
FILE *Efopen(const char *Name, const char *Mode) { * This routine attempts to open the specified file in the
/* * specified mode. If the file can be opened, a pointer to
** Parameters: * the open file is returned. If the file cannot be opened,
** Name name of file to be opened * an error is trapped.
** Mode mode to be used to open file * @param Name name of file to be opened
** Globals: * @param Mode mode to be used to open file
** None * @return Pointer to open file.
** Operation: * @note Globals: None
** This routine attempts to open the specified file in the * @note Exceptions: #FOPENERROR unable to open specified file
** specified mode. If the file can be opened, a pointer to * @note History: 5/21/89, DSJ, Created.
** the open file is returned. If the file cannot be opened,
** an error is trapped.
** Return:
** Pointer to open file.
** Exceptions:
** FOPENERROR unable to open specified file
** History:
** 5/21/89, DSJ, Created.
*/ */
FILE *Efopen(const char *Name, const char *Mode) {
FILE *File; FILE *File;
char ErrorMessage[MAXERRORMESSAGE]; char ErrorMessage[MAXERRORMESSAGE];