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

some extra 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: 1228
SVN UUID:     67feda4a-a26e-11df-9d6e-31afc202ad0c
parent 718e8586
......@@ -3,7 +3,7 @@
*
* ----------------------------------------------------------------------------
*
* $Id: README,v 1.9 2002-12-20 18:04:13 forbrig Exp $
* $Id: README,v 1.10 2002-12-20 18:22:17 forbrig Exp $
*
* Copyright (c) 2002 by Thomas Forbriger (IMG Frankfurt)
*
......@@ -53,7 +53,7 @@ namespace aff {
\since December 2002
\date December 2002
\version V1.0
$Id: README,v 1.9 2002-12-20 18:04:13 forbrig Exp $
$Id: README,v 1.10 2002-12-20 18:22:17 forbrig Exp $
Contents of this page:
- \ref sec_main_aims
......@@ -108,9 +108,9 @@ $Id: README,v 1.9 2002-12-20 18:04:13 forbrig Exp $
-# aff::SimpleRigidArray is a linear array with size fixed at compile-time.
There are several inline functions defined for operations with
this array class.
-# aff::Exception is the exception base class used in the library.
-# aff::Exception is the exception base class used in the library .
-# aff::AllocException is the exception that indicated a failed memory
allocation.
allocation(see also "\ref group_error").
It additionally offers the following type definitions:
......@@ -141,7 +141,7 @@ $Id: README,v 1.9 2002-12-20 18:04:13 forbrig Exp $
slices from aff::Array objects.
-# aff::dump and its associates, presented in aff/dump.h. They are used to
dump shape or contents of containers and are thus useful when
debugging your code.
debugging your code. See also "\ref group_helpers".
In the \ref sec_design_binary "binary version" some of the modules
......
......@@ -3,7 +3,7 @@
*
* ----------------------------------------------------------------------------
*
* $Id: README.changelog,v 1.16 2002-12-20 18:04:13 forbrig Exp $
* $Id: README.changelog,v 1.17 2002-12-20 18:22:17 forbrig Exp $
*
* Copyright (c) 2002 by Thomas Forbriger (IMG Frankfurt)
*
......@@ -20,7 +20,7 @@
/*! \page page_changelog ChangeLog (AFF)
$Id: README.changelog,v 1.16 2002-12-20 18:04:13 forbrig Exp $
$Id: README.changelog,v 1.17 2002-12-20 18:22:17 forbrig Exp $
\sa \ref page_project_status
......@@ -78,7 +78,7 @@
/*! \page page_project_status Project status (AFF)
$Id: README.changelog,v 1.16 2002-12-20 18:04:13 forbrig Exp $
$Id: README.changelog,v 1.17 2002-12-20 18:22:17 forbrig Exp $
\sa \ref page_changelog
......@@ -95,23 +95,23 @@
</TD>
</TR>
<TR><TD>libaff/array.h</TD>
<TD>8/12/02</TD><TD> </TD><TD>19/12/2002</TD><TD> </TD>
<TD>8/12/02</TD><TD>20/12/02</TD><TD>19/12/02</TD><TD> </TD>
</TR>
<TR><TD>libaff/array_dec.h</TD>
<TD>19/12/2002</TD><TD> </TD><TD>19/12/2002</TD>
<TD> </TD>
</TR>
<TR><TD>libaff/array_def.h</TD>
<TD>19/12/2002</TD><TD> </TD><TD>19/12/2002</TD><TD> </TD>
<TD>19/12/2002</TD><TD>20/12/2002</TD><TD>19/12/2002</TD><TD> </TD>
</TR>
<TR><TD>libaff/binarray.h</TD>
<TD>8/12/02</TD><TD> </TD><TD> </TD><TD> </TD>
<TD>8/12/02</TD><TD>20/12/2002</TD><TD> </TD><TD> </TD>
</TR>
<TR><TD>libaff/dump.cc</TD>
<TD>18/12/2002</TD><TD> </TD><TD>18/12/2002</TD><TD> </TD>
<TD>18/12/2002</TD><TD>20/12/2002</TD><TD>18/12/2002</TD><TD> </TD>
</TR>
<TR><TD>libaff/dump.h</TD>
<TD>19/12/2002</TD><TD> </TD><TD> </TD><TD> </TD>
<TD>19/12/2002</TD><TD>20/12/2002</TD><TD> </TD><TD> </TD>
</TR>
<TR><TD>libaff/iterator.h</TD>
<TD>20/12/2002</TD><TD> </TD><TD> </TD><TD> </TD>
......@@ -132,10 +132,10 @@
<TD>has no code</TD><TD>20/12/02</TD><TD>has no code</TD><TD> </TD>
</TR>
<TR><TD>libaff/lib/error.cc</TD>
<TD>16/12/02</TD><TD> </TD><TD>18/12/02</TD><TD> </TD>
<TD>16/12/02</TD><TD>20/12/2002</TD><TD>18/12/02</TD><TD> </TD>
</TR>
<TR><TD>libaff/lib/error.h</TD>
<TD>16/12/02</TD><TD> </TD><TD>18/12/02</TD><TD> </TD>
<TD>16/12/02</TD><TD>20/12/2002</TD><TD>18/12/02</TD><TD> </TD>
</TR>
<TR><TD>libaff/lib/range.h</TD>
<TD>13/12/02</TD><TD> </TD><TD> </TD><TD> </TD>
......
......@@ -3,17 +3,18 @@
*
* ----------------------------------------------------------------------------
*
* $Id: array.h,v 1.2 2002-12-08 22:33:53 forbrig Exp $
* $Id: array.h,v 1.3 2002-12-20 18:22:17 forbrig Exp $
* \author Thomas Forbriger
* \since 08/12/2002
*
* full template array class headers (prototypes)
*
* Include this file to have access to the basic modules in libaff.a.
*
* \sa aff
* \sa aff::Array
*
* \todo
* document when and how to use this header
* \sa \ref page_using
* \sa \ref sec_main_modules
*
* Copyright (c) 2002 by Thomas Forbriger (IMG Frankfurt)
*
......@@ -24,18 +25,21 @@
*/
// include guard
#ifndef FF_ARRAY_H_VERSION
#ifndef AFF_ARRAY_H_VERSION
#define FF_ARRAY_H_VERSION \
"FF_ARRAY_H V1.0 "
#define FF_ARRAY_H_CVSID \
"$Id: array.h,v 1.2 2002-12-08 22:33:53 forbrig Exp $"
#define AFF_ARRAY_H_VERSION \
"AFF_ARRAY_H V1.0"
#define AFF_ARRAY_H_CVSID \
"$Id: array.h,v 1.3 2002-12-20 18:22:17 forbrig Exp $"
//! May be used to define inlining levels (not used)
/*! \def AFF_INLINE
*
* May be used to define inlining levels (not used)
*/
#define AFF_INLINE inline
#include<aff/array_dec.h>
#endif // FF_ARRAY_H_VERSION (includeguard)
#endif // AFF_ARRAY_H_VERSION (includeguard)
/* ----- END OF array.h ----- */
......@@ -3,7 +3,7 @@
*
* ----------------------------------------------------------------------------
*
* $Id: array_def.h,v 1.10 2002-12-20 12:21:04 forbrig Exp $
* $Id: array_def.h,v 1.11 2002-12-20 18:22:17 forbrig Exp $
* \author Thomas Forbriger
* \since 08/12/2002
*
......@@ -12,10 +12,8 @@
* \note
* This header containes definitions of functions of class aff::Array. They
* will be contained in a binary library. You must not include this header
* yourself. It is included via array.h if you use the full template evrsion
* yourself. It is included via array.h if you use the full template version
* of the library.
*
* \todo rework the whole aff::Array definitions
*
* Copyright (c) 2002 by Thomas Forbriger (IMG Frankfurt)
*
......@@ -47,7 +45,7 @@
#define AFF_ARRAY_DEF_H_VERSION \
"AFF_ARRAY_DEF_H V1.3"
#define AFF_ARRAY_DEF_H_CVSID \
"$Id: array_def.h,v 1.10 2002-12-20 12:21:04 forbrig Exp $"
"$Id: array_def.h,v 1.11 2002-12-20 18:22:17 forbrig Exp $"
#include<aff/lib/error.h>
#include<aff/lib/stridedstepper.h>
......
/*! \file binarray.h
* \brief just arrays class definitions (for binary libraray contents) (prototypes)
* \brief just arrays class definitions (for binary libraray contents)
*
* ----------------------------------------------------------------------------
*
* $Id: binarray.h,v 1.3 2002-12-20 18:04:13 forbrig Exp $
* $Id: binarray.h,v 1.4 2002-12-20 18:22:17 forbrig Exp $
* \author Thomas Forbriger
* \since 08/12/2002
*
* just arrays class definitions (for binary libraray contents) (prototypes)
* just arrays class definitions (for binary libraray contents)
*
* This file loads explicitely instantiated template code (compiled into
* libaff.a) that is presented in namespace aff::prebuilt.
*
* \sa \ref sec_design_binary
* \sa aff::Array
*
* \todo
* Explain the usage of this file.
*
* Copyright (c) 2002 by Thomas Forbriger (IMG Frankfurt)
*
......@@ -27,9 +27,9 @@
#ifndef AFF_BINARRAY_H_VERSION
#define AFF_BINARRAY_H_VERSION \
"AFF_BINARRAY_H V1.0 "
"AFF_BINARRAY_H V1.0"
#define AFF_BINARRAY_H_CVSID \
"$Id: binarray.h,v 1.3 2002-12-20 18:04:13 forbrig Exp $"
"$Id: binarray.h,v 1.4 2002-12-20 18:22:17 forbrig Exp $"
#ifndef AFF_COMPILING_LIBRARY
#define AFF_NO_DEFINITIONS
......
......@@ -3,12 +3,13 @@
*
* ----------------------------------------------------------------------------
*
* $Id: dump.cc,v 1.6 2002-12-19 18:30:02 forbrig Exp $
* $Id: dump.cc,v 1.7 2002-12-20 18:22:17 forbrig Exp $
* \author Thomas Forbriger
* \date 12/12/2002
*
* debug helpers (implementation)
*
* \sa group_helpers
*
* Copyright (c) 2002 by Thomas Forbriger (IMG Frankfurt)
*
* REVISIONS and CHANGES
......@@ -21,7 +22,7 @@
#define AFF_DUMP_CC_VERSION \
"AFF_DUMP_CC V1.1"
#define AFF_DUMP_CC_CVSID \
"$Id: dump.cc,v 1.6 2002-12-19 18:30:02 forbrig Exp $"
"$Id: dump.cc,v 1.7 2002-12-20 18:22:17 forbrig Exp $"
#include <aff/dump.h>
......
......@@ -3,13 +3,15 @@
*
* ----------------------------------------------------------------------------
*
* $Id: dump.h,v 1.10 2002-12-19 18:30:02 forbrig Exp $
* $Id: dump.h,v 1.11 2002-12-20 18:22:17 forbrig Exp $
* \author Thomas Forbriger
* \date 12/12/2002
*
* debug helpers (prototypes)
*
* This file just collects other header files.
* This file just collects other header files. It provides dump and associates
* presented in namespace aff.
* \sa group_helpers
*
* Copyright (c) 2002 by Thomas Forbriger (IMG Frankfurt)
*
......@@ -35,7 +37,7 @@
#define AFF_DUMP_H_VERSION \
"AFF_DUMP_H V1.3"
#define TF_DUMP_H_CVSID \
"$Id: dump.h,v 1.10 2002-12-19 18:30:02 forbrig Exp $"
"$Id: dump.h,v 1.11 2002-12-20 18:22:17 forbrig Exp $"
/*! \defgroup group_helpers Debug functions
*/
......
......@@ -3,7 +3,7 @@
*
* ----------------------------------------------------------------------------
*
* $Id: dump_macros.h,v 1.1 2002-12-19 18:30:06 forbrig Exp $
* $Id: dump_macros.h,v 1.2 2002-12-20 18:22:19 forbrig Exp $
* \author Thomas Forbriger
* \date 19/12/2002
*
......@@ -11,6 +11,10 @@
*
* This file provides some preprocessor macros that are usefull, when
* debugging programs.
* \sa DUMP
* \sa CODE
* \sa LOCATION
* \sa group_helpers
*
* Copyright (c) 2002 by Thomas Forbriger (IMG Frankfurt)
*
......@@ -26,7 +30,7 @@
#define AFF_DUMP_MACROS_H_VERSION \
"AFF_DUMP_MACROS_H V1.0"
#define AFF_DUMP_MACROS_H_CVSID \
"$Id: dump_macros.h,v 1.1 2002-12-19 18:30:06 forbrig Exp $"
"$Id: dump_macros.h,v 1.2 2002-12-20 18:22:19 forbrig Exp $"
#include<iostream>
......
......@@ -3,11 +3,12 @@
*
* ----------------------------------------------------------------------------
*
* $Id: error.cc,v 1.2 2002-12-16 20:41:53 forbrig Exp $
* $Id: error.cc,v 1.3 2002-12-20 18:22:19 forbrig Exp $
* \author Thomas Forbriger
* \date 27/11/2002
*
* exceptions and error handling macros (implementation)
* \sa \ref group_error
*
* Copyright (c) 2002 by Thomas Forbriger (IMG Frankfurt)
*
......@@ -21,7 +22,7 @@
#define AFF_ERROR_CC_VERSION \
"AFF_ERROR_CC V1.1"
#define AFF_ERROR_CC_CVSID \
"$Id: error.cc,v 1.2 2002-12-16 20:41:53 forbrig Exp $"
"$Id: error.cc,v 1.3 2002-12-20 18:22:19 forbrig Exp $"
#include <iostream>
#include <aff/lib/error.h>
......
......@@ -3,13 +3,14 @@
*
* ----------------------------------------------------------------------------
*
* $Id: error.h,v 1.5 2002-12-16 21:03:27 uid1201 Exp $
* $Id: error.h,v 1.6 2002-12-20 18:22:19 forbrig Exp $
* \author Thomas Forbriger
* \date 27/11/2002
*
* exceptions and error handling macros (prototypes)
*
* \sa aff::Exception
* \sa \ref group_error
*
* \note
* This file is automatically included through array.h or binarray.h
......@@ -30,7 +31,7 @@
#define AFF_ERROR_H_VERSION \
"AFF_ERROR_H V1.1"
#define AFF_ERROR_H_CVSID \
"$Id: error.h,v 1.5 2002-12-16 21:03:27 uid1201 Exp $"
"$Id: error.h,v 1.6 2002-12-20 18:22:19 forbrig Exp $"
#include<aff/lib/types.h>
......
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