Commit a2917a59 authored by thomas.forbriger's avatar thomas.forbriger Committed by thomas.forbriger
Browse files

fixed documentation

This is a legacy commit from before 2015-03-01.
It may be incomplete as well as inconsistent.
See COPYING.legacy and README.history for details.


SVN Path:     http://gpitrsvn.gpi.uni-karlsruhe.de/repos/TFSoftware/trunk
SVN Revision: 1086
SVN UUID:     67feda4a-a26e-11df-9d6e-31afc202ad0c
parent a52f949e
......@@ -3,7 +3,7 @@
*
* ----------------------------------------------------------------------------
*
* $Id: misc.h,v 1.8 2002-11-20 14:57:50 forbrig Exp $
* $Id: misc.h,v 1.9 2002-11-22 16:14:31 forbrig Exp $
* \author Thomas Forbriger
* \date 18/11/2002
*
......@@ -24,7 +24,7 @@
#define TF_MISC_H_VERSION \
"TF_MISC_H V1.0 "
#define TF_MISC_H_CVSID \
"$Id: misc.h,v 1.8 2002-11-20 14:57:50 forbrig Exp $"
"$Id: misc.h,v 1.9 2002-11-22 16:14:31 forbrig Exp $"
// we include fstream, because all function are closely related to file I/O
// and file_magic definitely requires fstream
......@@ -69,7 +69,7 @@ namespace ioswap {
//
// we start with a set of useful types
/*! A struct to define the expected type size.
/*! \brief A struct to define the expected type size.
*
* Specializations of this class define type sizes for various types.
* The default template struct is empty to ensure useability of
......@@ -236,10 +236,11 @@ int magic(const char* const cmagic);
*/
Ecpu_type cpu();
/*! \fn Emagic_type file_magic_test(std::ifstream& is, const char* const cmagic, const bool& fortranmode=false)
/*! \fn Emagic_type file_magic_test(std::istream& is, const char* const cmagic, const bool& fortranmode=false)
* \brief Check for magic number in file.
*
* \ingroup group_ioswap
*
* \param is input stream to read from
* \param cmagic 4-byte character sequence representing magic number (most
* restrictive: pass a const pointer to a const char)
......@@ -257,9 +258,11 @@ Ecpu_type cpu();
Emagic_type file_magic_test(std::istream& is, const char* const cmagic,
const bool& fortranmode=false);
/*! \fn void file_magic_write(std::ofstream& os, const char* const cmagic, const bool& fortranmode=false)
/*! \fn void file_magic_write(std::ostream& os, const char* const cmagic, const bool& fortranmode=false)
* \brief Write magic number to file.
*
* \ingroup group_ioswap
*
* \param os output stream to write to
* \param cmagic 4-byte character sequence representing magic number (most
* restrictive: pass a const pointer to a const char)
......
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment