From 94381d08e5b529bf67d6a5603fe9b5ce242b93ea Mon Sep 17 00:00:00 2001
From: Vesa Oikonen <vesoik@utu.fi>
Date: Thu, 25 Nov 2021 11:26:19 +0200
Subject: [PATCH] added Doxygen tags

---
 v2/libtpcimage/imagedcm.c  | 1 +
 v2/libtpcimage/imagenii.c  | 7 ++++++-
 v2/libtpcimage/imagesif.c  | 2 ++
 v2/libtpcnifti/analyzeio.c | 2 ++
 v2/libtpcnifti/niftiio.c   | 5 ++++-
 5 files changed, 15 insertions(+), 2 deletions(-)

diff --git a/v2/libtpcimage/imagedcm.c b/v2/libtpcimage/imagedcm.c
index 5ffa6307..5e6b0d58 100644
--- a/v2/libtpcimage/imagedcm.c
+++ b/v2/libtpcimage/imagedcm.c
@@ -12,6 +12,7 @@
 /*****************************************************************************/
 /** Read single-file DICOM into IMG data structure.
     @remark Only few header fields are read.
+    @todo Add tests.
     @sa imgInit, imgRead, imgWrite, imgFree
     @return enum tpcerror (TPCERROR_OK when successful).
  */
diff --git a/v2/libtpcimage/imagenii.c b/v2/libtpcimage/imagenii.c
index c049b7f9..fc9156a4 100644
--- a/v2/libtpcimage/imagenii.c
+++ b/v2/libtpcimage/imagenii.c
@@ -62,6 +62,7 @@ int niftiCreateFNames(
 
 /*****************************************************************************/
 /** Read NIfTI into IMG data structure.
+    @todo Add tests.
     @sa imgInit, imgRead, imgWrite, imgFree
     @return enum tpcerror (TPCERROR_OK when successful).
  */
@@ -361,6 +362,7 @@ int imgReadNifti(
 
    SIF file is saved to store frame times, if frame times are available.
 
+   @todo Add tests.
    @sa imgInit, imgRead, imgWrite, imgFree
    @return enum tpcerror (TPCERROR_OK when successful).
  */
@@ -546,6 +548,8 @@ int imgWriteNifti(
     IMG_FORMAT_NIFTI_2D, or IMG_FORMAT_NIFTI_2S.
     NIFTI_DSR->n will tell whether NIfTI-1 or NIfTI-2 header was filled.
 
+   @todo Add tests.
+   @sa imgGetNiftiHeader, imgWriteNifti
    @return enum tpcerror (TPCERROR_OK when successful).
  */
 int imgSetNiftiHeader(
@@ -763,7 +767,8 @@ int imgSetNiftiHeader(
 /*****************************************************************************/
 /** Copy header information from NIfTI into IMG.
 
-   @sa imgSetNiftiHeader, niftiExists
+   @todo Add tests.
+   @sa imgSetNiftiHeader, niftiExists, imgReadNifti
    @return enum tpcerror (TPCERROR_OK when successful).
  */
 int imgGetNiftiHeader(
diff --git a/v2/libtpcimage/imagesif.c b/v2/libtpcimage/imagesif.c
index b27c8226..1fec658c 100644
--- a/v2/libtpcimage/imagesif.c
+++ b/v2/libtpcimage/imagesif.c
@@ -11,6 +11,7 @@
 
 /*****************************************************************************/
 /** Set SIF contents based on data in IMG.
+    @todo Add tests.
     @sa imgFromSIF, imgInit, tacInit, imgWrite, tacWrite, tacWriteSIF
     @return enum tpcerror (TPCERROR_OK when successful).
  */ 
@@ -114,6 +115,7 @@ int imgToSIF(
 
 /*****************************************************************************/
 /** Copy information from SIF into IMG.
+    @todo Add tests.
     @sa imgToSIF, imgInit, tacInit, imgWrite, imgRead, tacWriteSIF
     @return enum tpcerror (TPCERROR_OK when successful).
  */ 
diff --git a/v2/libtpcnifti/analyzeio.c b/v2/libtpcnifti/analyzeio.c
index d6e9d58f..699d2ff9 100644
--- a/v2/libtpcnifti/analyzeio.c
+++ b/v2/libtpcnifti/analyzeio.c
@@ -9,6 +9,7 @@
 
 /*****************************************************************************/
 /** Verify if specified file name is an Analyze 7.5 file.
+   @todo Add tests.
    @sa anaReadHeader, niftiExists, micropetExists
    @return Returns 1 if it is Analyze, 0 if not.
  */
@@ -136,6 +137,7 @@ int anaExists(
 
 /*****************************************************************************/
 /** Read Analyze header contents. 
+   @todo Add tests.
    @sa anaExists, micropetHeaderRead
    @return enum tpcerror (TPCERROR_OK when successful).
  */
diff --git a/v2/libtpcnifti/niftiio.c b/v2/libtpcnifti/niftiio.c
index 2289adaf..9460e067 100644
--- a/v2/libtpcnifti/niftiio.c
+++ b/v2/libtpcnifti/niftiio.c
@@ -9,6 +9,7 @@
 
 /*****************************************************************************/
 /** Verify if specified file name is a NIfTI file.
+   @todo Add tests.
    @sa niftiReadHeader, anaExists, micropetExists
    @return Returns 1 if it is NIfTI, and 0 if it is not NIfTI.
     Error code set in TPCSTATUS.
@@ -137,7 +138,8 @@ int niftiExists(
 
 /*****************************************************************************/
 /** Read NIfTI-1 header contents, including 4-byte extender. 
-   @remark Currently does not read NIfTI-1 header extension.
+   @remark Currently does not read NIfTI header extension.
+   @todo Add tests.
    @sa niftiWriteHeader, niftiExists, anaReadHeader, micropetHeaderRead
    @return enum tpcerror (TPCERROR_OK when successful).
  */
@@ -435,6 +437,7 @@ int niftiReadHeader(
 /*****************************************************************************/
 /** Write NIfTI-1 header contents, including 4-byte extender. 
    @remark Currently does not write header extension.
+   @todo Add tests.
    @sa niftiExists, niftiReadHeader
    @return enum tpcerror (TPCERROR_OK when successful).
  */
-- 
GitLab