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

pass definitions to doxygen

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: 1119
SVN UUID:     67feda4a-a26e-11df-9d6e-31afc202ad0c
parent 91e07f8f
......@@ -3,7 +3,7 @@
*
* ----------------------------------------------------------------------------
*
* $Id: commandline.cc,v 1.3 2002-11-19 22:09:36 forbrig Exp $
* $Id: commandline.cc,v 1.4 2002-11-28 14:04:43 forbrig Exp $
*
* Copyright (c) 2002 by Thomas Forbriger (IMGF Frankfurt)
*
......@@ -17,9 +17,9 @@
* ============================================================================
*/
//! $Id: commandline.cc,v 1.3 2002-11-19 22:09:36 forbrig Exp $
//! $Id: commandline.cc,v 1.4 2002-11-28 14:04:43 forbrig Exp $
#define TF_COMMANDLINE_CC_ \
$Id: commandline.cc,v 1.3 2002-11-19 22:09:36 forbrig Exp $
$Id: commandline.cc,v 1.4 2002-11-28 14:04:43 forbrig Exp $
#include <iostream>
#include <getopt.h>
......@@ -28,6 +28,7 @@
namespace tfxx {
namespace cmdline {
//! create and parse
Commandline::Commandline(int& iargc,
char** argv,
Declare* declarations):
......
......@@ -3,7 +3,7 @@
*
* ----------------------------------------------------------------------------
*
* $Id: fortranio.cc,v 1.5 2002-11-20 14:57:49 forbrig Exp $
* $Id: fortranio.cc,v 1.6 2002-11-28 14:04:43 forbrig Exp $
* \author Thomas Forbriger
* \date 13/01/2002
*
......@@ -27,7 +27,7 @@
#define TF_FORTRANIO_CC_VERSION \
"TF_FORTRANIO_CC V1.0 "
#define TF_FORTRANIO_CC_CVSID \
"$Id: fortranio.cc,v 1.5 2002-11-20 14:57:49 forbrig Exp $"
"$Id: fortranio.cc,v 1.6 2002-11-28 14:04:43 forbrig Exp $"
#include <tfxx/fortranio.h>
#include <tfxx/misc.h>
......@@ -70,7 +70,7 @@ namespace {
/*----------------------------------------------------------------------*/
// return next character from buffer
//! return next character from buffer
void FortranBinInput::read_block_size()
{
tfxx::ioswap::IOUnion<int> buf;
......@@ -94,7 +94,7 @@ namespace {
/*----------------------------------------------------------------------*/
// return next character from buffer
//! return next character from buffer
char FortranBinInput::extract_next_char()
{
char result;
......@@ -107,7 +107,7 @@ namespace {
/*----------------------------------------------------------------------*/
// extract a set of characters
//! extract a set of characters
void FortranBinInput::extract_chars(char* buf, const int& n)
{
for (int i=0; ((i<n) && more()); i++)
......@@ -119,7 +119,7 @@ namespace {
// FortranBinOutput
// ================
// finally write the data (flush buffer)
//! finally write the data (flush buffer)
void FortranBinOutput::end_block()
{
std::string buffer=Mbuffer.str();
......@@ -133,13 +133,13 @@ namespace {
/*----------------------------------------------------------------------*/
// put a set of characters to the buffer
//! put a set of characters to the buffer
void FortranBinOutput::put_chars(const char* buf, const int& n)
{ Mbuffer.write(buf, n); }
/*----------------------------------------------------------------------*/
// put one character to the buffer
//! put one character to the buffer
void FortranBinOutput::put_char(const char& c)
{ Mbuffer.write(&c, 1); }
......
......@@ -3,7 +3,7 @@
*
* ----------------------------------------------------------------------------
*
* $Id: ioswap.cc,v 1.6 2002-11-19 22:09:37 forbrig Exp $
* $Id: ioswap.cc,v 1.7 2002-11-28 14:04:43 forbrig Exp $
* \author Thomas Forbriger
* \date 18/11/2002
*
......@@ -20,7 +20,7 @@
#define TF_IOSWAP_CC_VERSION \
"TF_IOSWAP_CC V1.0 "
#define TF_IOSWAP_CC_CVSID \
"$Id: ioswap.cc,v 1.6 2002-11-19 22:09:37 forbrig Exp $"
"$Id: ioswap.cc,v 1.7 2002-11-28 14:04:43 forbrig Exp $"
#include <tfxx/misc.h>
#include <iostream>
......@@ -33,7 +33,7 @@ namespace tfxx {
namespace ioswap {
// we have to instantiate the static members here
//! we have to instantiate the static members here
const int IOTsize<int>::Msize;
const int IOTsize<long int>::Msize;
const int IOTsize<long long int>::Msize;
......@@ -66,6 +66,7 @@ const int IOTsize<double>::Msize;
assert(sizeof(T) == IOTsize<T>::Msize); \
}
//! check assumption made in library code
void check_assumed_size(const bool& verbose)
{
if (verbose) cout << "checking byte size:" << endl;
......@@ -79,7 +80,7 @@ void check_assumed_size(const bool& verbose)
#undef CHECK_MACRO
//----------------------------------------------------------------------
// function to create the magic number
//! function to create the magic number
int magic(const char* const cmagic)
{
union {
......@@ -100,7 +101,7 @@ int magic(const char* const cmagic)
} // magic()
/*----------------------------------------------------------------------*/
// check for my CPU model
//! check for my CPU model
Ecpu_type cpu()
{
Ecpu_type result=cpu_unknown;
......@@ -130,6 +131,7 @@ Ecpu_type cpu()
/*----------------------------------------------------------------------*/
//! check magic number in file
Emagic_type file_magic_test(std::istream& is, const char* const cmagic,
const bool& fortranmode=false)
{
......@@ -152,6 +154,7 @@ Emagic_type file_magic_test(std::istream& is, const char* const cmagic,
/*----------------------------------------------------------------------*/
//! write magic number to file
void file_magic_write(std::ostream& os, const char* const cmagic,
const bool& fortranmode=false)
{
......
Markdown is supported
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