From 172b0f663152c0a5ea7602346f071582a9c6e5f7 Mon Sep 17 00:00:00 2001
From: Brian Carrier <carrier@sleuthkit.org>
Date: Thu, 16 Oct 2008 14:23:52 +0000
Subject: [PATCH] Added comments to .h files
---
tsk3/fs/tsk_fs.h | 2 +-
tsk3/img/tsk_img.h | 4 ++--
tsk3/vs/tsk_vs.h | 2 +-
3 files changed, 4 insertions(+), 4 deletions(-)
diff --git a/tsk3/fs/tsk_fs.h b/tsk3/fs/tsk_fs.h
index c966f7d56..31ae61871 100644
--- a/tsk3/fs/tsk_fs.h
+++ b/tsk3/fs/tsk_fs.h
@@ -847,7 +847,7 @@ extern "C" {
uint8_t(*istat) (TSK_FS_INFO * fs, FILE * hFile, TSK_INUM_T inum,
TSK_DADDR_T numblock, int32_t sec_skew);
- TSK_RETVAL_ENUM(*dir_open_meta) (TSK_FS_INFO * fs, TSK_FS_DIR ** a_fs_dir, TSK_INUM_T inode); ///< FS-specific function: Call tsk_fs_dir_open_meta() instead.
+ TSK_RETVAL_ENUM(*dir_open_meta) (TSK_FS_INFO * fs, TSK_FS_DIR ** a_fs_dir, TSK_INUM_T inode); ///< \internal Call tsk_fs_dir_open_meta() instead.
uint8_t(*jopen) (TSK_FS_INFO *, TSK_INUM_T); ///< \internal
diff --git a/tsk3/img/tsk_img.h b/tsk3/img/tsk_img.h
index 07d488b2b..ae76e2bd2 100644
--- a/tsk3/img/tsk_img.h
+++ b/tsk3/img/tsk_img.h
@@ -85,8 +85,8 @@ extern "C" {
int cache_age[TSK_IMG_INFO_CACHE_NUM]; ///< "Age" of corresponding cache entry, higher means more recently used
size_t cache_len[TSK_IMG_INFO_CACHE_NUM]; ///< Length of cache entry used (0 if never used)
- ssize_t(*read) (TSK_IMG_INFO * img, TSK_OFF_T off, char *buf, size_t len); ///< Pointer to file type specific read function
- void (*close) (TSK_IMG_INFO *); ///< Pointer to file type specific close function
+ ssize_t(*read) (TSK_IMG_INFO * img, TSK_OFF_T off, char *buf, size_t len); ///< \internal External progs should call tsk_img_read()
+ void (*close) (TSK_IMG_INFO *); ///< \internal Progs should call tsk_img_close()
void (*imgstat) (TSK_IMG_INFO *, FILE *); ///< Pointer to file type specific function
};
diff --git a/tsk3/vs/tsk_vs.h b/tsk3/vs/tsk_vs.h
index fccb879e5..5ccf550fc 100644
--- a/tsk3/vs/tsk_vs.h
+++ b/tsk3/vs/tsk_vs.h
@@ -71,7 +71,7 @@ extern "C" {
TSK_PNUM_T part_count; ///< number of partitions
- void (*close) (TSK_VS_INFO *);
+ void (*close) (TSK_VS_INFO *); ///< \internal Progs should call tsk_vs_close().
};
--
GitLab