Commit 2e64d944 authored by thomas.forbriger's avatar thomas.forbriger
Browse files

libtsioxx [DOC]: group reading functions in doxygen documentation

parent 8cf2f6d0
......@@ -58,6 +58,18 @@ namespace ts {
* @{
*/
/*! \brief Functions reading a set of input files
* \defgroup group_cmdlinefiles_set read a complete set of input files
*
* This module is presented through cmdlinefiles.h
*/
/*! \brief Functions reading a single input file
* \defgroup group_cmdlinefiles_single read one single input file
*
* This module is presented through cmdlinefiles.h
*/
/*! \brief type of trace selection list.
*
* This is the rangelist class that holds a selection of traces in
......@@ -141,6 +153,8 @@ namespace ts {
/*======================================================================*/
/*! \brief read complete SFF file.
*
* \ingroup group_cmdlinefiles_single
*
* Read a complete data file with headers and samples at once.
*
......@@ -157,6 +171,8 @@ namespace ts {
/*----------------------------------------------------------------------*/
/*! \brief read complete SFF file with trace selection.
*
* \ingroup group_cmdlinefiles_single
*
* Read a complete data file with all headers and samples but only for the
* selected traces.
......@@ -176,6 +192,8 @@ namespace ts {
/*----------------------------------------------------------------------*/
/*! \brief read complete SFF file with trace selection.
*
* \ingroup group_cmdlinefiles_single
*
* Read a complete data file, but take selection from the structure of
* command line arguments.
......@@ -197,6 +215,8 @@ namespace ts {
/*----------------------------------------------------------------------*/
/*! \brief read complete list of SFF files with trace selection.
*
* \ingroup group_cmdlinefiles_set
*
* Read a complete set of files like defined in the structure of command
* line arguments.
......@@ -218,6 +238,8 @@ namespace ts {
/*----------------------------------------------------------------------*/
/*! \brief read complete SFF file (single precision version).
*
* \ingroup group_cmdlinefiles_single
*
* Read a complete data file with headers and samples at once.
*
......@@ -236,6 +258,8 @@ namespace ts {
/*! \brief read complete SFF file with trace selection (single precision
* version).
*
* \ingroup group_cmdlinefiles_single
*
* Read a complete data file with all headers and samples but only for the
* selected traces.
*
......@@ -256,6 +280,8 @@ namespace ts {
/*! \brief read complete SFF file with trace selection (single precision
* version).
*
* \ingroup group_cmdlinefiles_single
*
* Read a complete data file, but take selection from the structure of
* command line arguments.
*
......@@ -278,6 +304,8 @@ namespace ts {
/*! \brief read complete list of SFF files with trace selection (single
* precision version).
*
* \ingroup group_cmdlinefiles_set
*
* Read a complete set of files like defined in the structure of command
* line arguments.
*
......@@ -298,6 +326,8 @@ namespace ts {
/*======================================================================*/
/*! \brief read complete SFF file.
*
* \ingroup group_cmdlinefiles_single
*
* Read a complete data file with headers and samples at once.
*
......@@ -314,6 +344,8 @@ namespace ts {
/*----------------------------------------------------------------------*/
/*! \brief read complete SFF file with trace selection.
*
* \ingroup group_cmdlinefiles_single
*
* Read a complete data file with all headers and samples but only for the
* selected traces.
......@@ -333,6 +365,8 @@ namespace ts {
/*----------------------------------------------------------------------*/
/*! \brief read complete SFF file with trace selection.
*
* \ingroup group_cmdlinefiles_single
*
* Read a complete data file, but take selection from the structure of
* command line arguments.
......@@ -354,6 +388,8 @@ namespace ts {
/*----------------------------------------------------------------------*/
/*! \brief read complete list of SFF files with trace selection.
*
* \ingroup group_cmdlinefiles_set
*
* Read a complete set of files like defined in the structure of command
* line arguments.
......@@ -375,6 +411,8 @@ namespace ts {
/*----------------------------------------------------------------------*/
/*! \brief read complete SFF file (single precision version).
*
* \ingroup group_cmdlinefiles_single
*
* Read a complete data file with headers and samples at once.
*
......@@ -393,6 +431,8 @@ namespace ts {
/*! \brief read complete SFF file with trace selection (single precision
* version).
*
* \ingroup group_cmdlinefiles_single
*
* Read a complete data file with all headers and samples but only for the
* selected traces.
*
......@@ -413,6 +453,8 @@ namespace ts {
/*! \brief read complete SFF file with trace selection (single precision
* version).
*
* \ingroup group_cmdlinefiles_single
*
* Read a complete data file, but take selection from the structure of
* command line arguments.
*
......@@ -435,6 +477,8 @@ namespace ts {
/*! \brief read complete list of SFF files with trace selection (single
* precision version).
*
* \ingroup group_cmdlinefiles_set
*
* Read a complete set of files like defined in the structure of command
* line arguments.
*
......@@ -451,6 +495,7 @@ namespace ts {
const bool& verbose=false,
Ttracelistkey tracekey="t",
const datrw::Eformat& format=datrw::Fsff);
/** @}*/
} // namespace sff
} // namespace ts
......
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