From d2db662a0dd51fffb54cda36a77397b1e5f6578e Mon Sep 17 00:00:00 2001
From: Vesa Oikonen <vesoik@utu.fi>
Date: Tue, 2 Jun 2020 14:46:22 +0300
Subject: [PATCH] updated doc
---
v2/libtpcnifti/analyzeio.c | 22 +++++++++++-----------
v2/libtpcnifti/niftiio.c | 23 +++++++++++------------
2 files changed, 22 insertions(+), 23 deletions(-)
diff --git a/v2/libtpcnifti/analyzeio.c b/v2/libtpcnifti/analyzeio.c
index 9b496a55..b7400950 100644
--- a/v2/libtpcnifti/analyzeio.c
+++ b/v2/libtpcnifti/analyzeio.c
@@ -9,28 +9,27 @@
/*****************************************************************************/
/** Verify if specified file name is an Analyze 7.5 file.
- @sa anaReadHeader, niftiExists
+ @sa anaReadHeader, niftiExists, micropetExists
@return Returns 1 if it is Analyze, 0 if not.
*/
int anaExists(
/** File name, either header file, image file, or base name without extensions. */
const char *filename,
- /** If filename refers to an Analyze file, then header filename will be
+ /** If file name refers to an Analyze file, then header file name will be
written in this char pointer (space needs to allocated by caller);
- If header and image are combined, then this will be the name of combined
- file; enter NULL if not needed. */
+ If header and image are combined, then this will be the name of combined file;
+ enter NULL if not needed. */
char *hdrfile,
- /** If filename refers to an Analyze file, then image filename will be
+ /** If file name refers to an Analyze file, then image file name will be
written in this char pointer (space needs to allocated by caller);
- If header and image are combined, then this will be the name of combined
- file; enter NULL if not needed. */
+ If header and image are combined, then this will be the name of combined file;
+ enter NULL if not needed. */
char *imgfile,
- /** If filename refers to an Analyze file, and if SIF exists, then SIF filename
+ /** If file name refers to an Analyze file, and if SIF exists, then SIF file name
will be written in this char pointer (space needs to allocated by caller);
- NULL if not needed. */
+ enter NULL if not needed. */
char *siffile,
- /** Pointer to Analyze header, which is filled in this function; enter NULL,
- if not needed. */
+ /** Pointer to Analyze header, which is filled in this function; enter NULL, if not needed. */
ANALYZE_DSR *header,
/** Pointer to status data; enter NULL if not needed. */
TPCSTATUS *status
@@ -135,6 +134,7 @@ int anaExists(
/*****************************************************************************/
/** Read Analyze header contents.
+ @sa anaExists, micropetHeaderRead
@return enum tpcerror (TPCERROR_OK when successful).
*/
int anaReadHeader(
diff --git a/v2/libtpcnifti/niftiio.c b/v2/libtpcnifti/niftiio.c
index 5a92dec0..999c4786 100644
--- a/v2/libtpcnifti/niftiio.c
+++ b/v2/libtpcnifti/niftiio.c
@@ -11,28 +11,27 @@
/** Verify if specified file name is a NIfTI file.
@remark Currently only NIfTI-1 is supported.
@todo Support for NIfTI-2.
- @sa niftiReadHeader, anaExists
+ @sa niftiReadHeader, anaExists, micropetExists
@return Returns 0 if it is not NIfTI, otherwise the version of NIfTI.
*/
int niftiExists(
/** File name, either header file, image file, or base name without extensions. */
const char *filename,
- /** If filename refers to a Nifti file, then header filename will be
+ /** If file name refers to a NIfTI file, then header file name will be
written in this char pointer (space needs to allocated by caller);
- If header and image are combined, then this will be the name of combined
- file; enter NULL if not needed. */
+ If header and image are combined, then this will be the name of combined file;
+ enter NULL if not needed. */
char *hdrfile,
- /** If filename refers to a Nifti file, then image filename will be
+ /** If file name refers to a NIfTI file, then image file name will be
written in this char pointer (space needs to allocated by caller);
- If header and image are combined, then this will be the name of combined
- file; enter NULL if not needed. */
+ If header and image are combined, then this will be the name of combined file;
+ enter NULL if not needed. */
char *imgfile,
- /** If filename refers to a Nifti file, and if SIF exists, then SIF filename
+ /** If file name refers to a NIfTI file, and if SIF exists, then SIF file name
will be written in this char pointer (space needs to allocated by caller);
- NULL if not needed. */
+ exter NULL if not needed. */
char *siffile,
- /** Pointer to Nifti header, which is filled in this function; enter NULL,
- if not needed. */
+ /** Pointer to NIfTI header, which is filled in this function; enter NULL, if not needed. */
NIFTI_DSR *header,
/** Pointer to status data; enter NULL if not needed. */
TPCSTATUS *status
@@ -139,7 +138,7 @@ int niftiExists(
/** Read Nifti header contents, including 4-byte extender.
@remark Currently does not read Nifti-1 header extension.
@todo Support for NIfTI-2.
- @sa niftiExists, anaReadHeader
+ @sa niftiExists, anaReadHeader, micropetHeaderRead
@return enum tpcerror (TPCERROR_OK when successful).
*/
int niftiReadHeader(
--
GitLab