From 360d5ba88f8144c2510db40a576de570cc3a2e93 Mon Sep 17 00:00:00 2001
From: Brian Carrier <carrier@sleuthkit.org>
Date: Sat, 2 Feb 2013 15:04:29 -0500
Subject: [PATCH] Fixed doxygen errors
---
bindings/java/doxygen/Doxyfile | 3 ++-
bindings/java/doxygen/footer.html | 7 +++++++
.../src/org/sleuthkit/datamodel/BlackboardAttribute.java | 1 -
bindings/java/src/org/sleuthkit/datamodel/FsContent.java | 6 ++----
.../java/src/org/sleuthkit/datamodel/SleuthkitCase.java | 1 -
bindings/java/src/org/sleuthkit/datamodel/TskData.java | 2 +-
framework/Services/TskImgDB.h | 8 ++++----
framework/docs/footer.html | 2 +-
framework/docs/pipeline.dox | 4 ++--
tsk3/auto/db_sqlite.cpp | 2 +-
tsk3/docs/footer.html | 2 +-
tsk3/fs/fatfs_dent.cpp | 4 ++--
tsk3/fs/fs_block.c | 1 +
tsk3/fs/ntfs_dent.cpp | 2 +-
14 files changed, 25 insertions(+), 20 deletions(-)
create mode 100644 bindings/java/doxygen/footer.html
diff --git a/bindings/java/doxygen/Doxyfile b/bindings/java/doxygen/Doxyfile
index 7c9b44f87..5d3a4760e 100644
--- a/bindings/java/doxygen/Doxyfile
+++ b/bindings/java/doxygen/Doxyfile
@@ -897,7 +897,8 @@ HTML_HEADER =
# each generated HTML page. If it is left blank doxygen will generate a
# standard footer.
-HTML_FOOTER =
+HTML_FOOTER = bindings/java/doxygen/footer.html
+
# The HTML_STYLESHEET tag can be used to specify a user-defined cascading
# style sheet that is used by each HTML page. It can be used to
diff --git a/bindings/java/doxygen/footer.html b/bindings/java/doxygen/footer.html
new file mode 100644
index 000000000..8dfafdcf8
--- /dev/null
+++ b/bindings/java/doxygen/footer.html
@@ -0,0 +1,7 @@
+<hr/>
+<p><i>Copyright © 2011-2013 Brian Carrier. (carrier -at- sleuthkit -dot- org)<br/>
+This work is licensed under a
+<a rel="license" href="http://creativecommons.org/licenses/by-sa/3.0/us/">Creative Commons Attribution-Share Alike 3.0 United States License</a>.
+</i></p>
+</body>
+</html>
diff --git a/bindings/java/src/org/sleuthkit/datamodel/BlackboardAttribute.java b/bindings/java/src/org/sleuthkit/datamodel/BlackboardAttribute.java
index 2153fd8f4..8da370676 100755
--- a/bindings/java/src/org/sleuthkit/datamodel/BlackboardAttribute.java
+++ b/bindings/java/src/org/sleuthkit/datamodel/BlackboardAttribute.java
@@ -348,7 +348,6 @@ public BlackboardAttribute(int attributeTypeID, String moduleName, String contex
*
* @param attributeTypeID type of the attribute
* @param moduleName name of the module that is creating the attribute
- * @param context extra information about the attribute
* @param valueDouble the value
*/
public BlackboardAttribute(int attributeTypeID, String moduleName,
diff --git a/bindings/java/src/org/sleuthkit/datamodel/FsContent.java b/bindings/java/src/org/sleuthkit/datamodel/FsContent.java
index ee40d60f5..c12efebca 100644
--- a/bindings/java/src/org/sleuthkit/datamodel/FsContent.java
+++ b/bindings/java/src/org/sleuthkit/datamodel/FsContent.java
@@ -409,11 +409,9 @@ public int getGid() {
}
/**
- * Convert mode and meta type to a user-displayable string
+ * Get the file's mode as a user-displayable string
*
- * @param mode mode attribute of the file/dir
- * @param metaType meta type attribute of the file/dir
- * @return converted, formatted user-displayable string
+ * @return formatted user-displayable string for mode
*/
public String getModesAsString() {
int mode = TSK_FS_META_MODE_ENUM.toInt(modes);
diff --git a/bindings/java/src/org/sleuthkit/datamodel/SleuthkitCase.java b/bindings/java/src/org/sleuthkit/datamodel/SleuthkitCase.java
index 600ec777d..dbd4554a6 100644
--- a/bindings/java/src/org/sleuthkit/datamodel/SleuthkitCase.java
+++ b/bindings/java/src/org/sleuthkit/datamodel/SleuthkitCase.java
@@ -1003,7 +1003,6 @@ private ArrayList<BlackboardArtifact> getArtifactsHelper(int artifactTypeID, Str
* object id
*
* @param artifactTypeID artifact type id
- * @param artifactTypeName artifact type name
* @param obj_id associated object id
* @return count of matching blackboard artifacts
* @throws TskCoreException exception thrown if a critical error occurs
diff --git a/bindings/java/src/org/sleuthkit/datamodel/TskData.java b/bindings/java/src/org/sleuthkit/datamodel/TskData.java
index 90620799b..278359360 100644
--- a/bindings/java/src/org/sleuthkit/datamodel/TskData.java
+++ b/bindings/java/src/org/sleuthkit/datamodel/TskData.java
@@ -213,7 +213,7 @@ public String toString(){
/**
* Returns all the enum elements that match the flags in metaFlag
- * @param metaFlag
+ * @param metaFlags Flags to convert to Enums.
* @return matching TSK_FS_META_FLAG_ENUM elements
*/
public static Set<TSK_FS_META_FLAG_ENUM> valuesOf(short metaFlags) {
diff --git a/framework/Services/TskImgDB.h b/framework/Services/TskImgDB.h
index 26ec90bc1..3cf151256 100755
--- a/framework/Services/TskImgDB.h
+++ b/framework/Services/TskImgDB.h
@@ -81,7 +81,7 @@ struct TskCarvedFileInfo
std::string hash;
/**
- * A "cfile" name for the carved file of the form: cfile_<vol_id>_<start_sector>_<file_id>.<ext>.
+ * A "cfile" name for the carved file of the form: cfile_[vol_id]_[start_sector]_[file_id].[ext].
*/
std::string cFileName;
};
@@ -238,7 +238,7 @@ class TSK_FRAMEWORK_API TskImgDB
* @param fileName File name
* @param fileSystemAttrType File system attribute type (see #TSK_FS_ATTR_TYPE_ENUM)
* @param fileSystemAttrID File system attribute ID, used to index attributes for files with multiple attributes
- * @param [out] fileId File ID assigned to the file by the image database
+ * @param [out] fileID File ID assigned to the file by the image database
* @param filePath Path to the file in the image, file name omitted
* @returns 0 on success or -1 on error.
*/
@@ -420,8 +420,8 @@ class TSK_FRAMEWORK_API TskImgDB
/**
* Find parent object id of TSK_FS_FILE. Use local cache map, if not found, fall back to SQL
- * @param fs_file file to find parent obj id for
- * @param fsObjId fs id of this file
+ * @param fsObjId Id of file system that this file and parent should be in.
+ * @param meta_addr File system address to find parent of
* @returns parent obj id ( > 0), -1 on error
*/
int64_t findParObjId(const int64_t & fsObjId, TSK_INUM_T meta_addr);
diff --git a/framework/docs/footer.html b/framework/docs/footer.html
index d7b3b8055..8dfafdcf8 100644
--- a/framework/docs/footer.html
+++ b/framework/docs/footer.html
@@ -1,5 +1,5 @@
<hr/>
-<p><i>Copyright © 2011-2012 Brian Carrier. (carrier -at- sleuthkit -dot- org)<br/>
+<p><i>Copyright © 2011-2013 Brian Carrier. (carrier -at- sleuthkit -dot- org)<br/>
This work is licensed under a
<a rel="license" href="http://creativecommons.org/licenses/by-sa/3.0/us/">Creative Commons Attribution-Share Alike 3.0 United States License</a>.
</i></p>
diff --git a/framework/docs/pipeline.dox b/framework/docs/pipeline.dox
index e51cd2cf4..c72a97485 100755
--- a/framework/docs/pipeline.dox
+++ b/framework/docs/pipeline.dox
@@ -78,7 +78,7 @@ This is possible because there is a set of configuration file macros that the fr
There are a number of TskSystemProperties::PredefinedProperty macros.
To substitute the value of a TskSystemProperties::PredefinedProperty into an <tt>arguments</tt> or <tt>output</tt> string, surround the system property name with '#' marks.
-For example, use <tt>#SYSTEM_OUT_DIR#/file1.txt</tt> to refer to a file named <tt>file1.txt</tt> in the system output directory.
+For example, use <tt>\#SYSTEM_OUT_DIR\#/file1.txt</tt> to refer to a file named <tt>file1.txt</tt> in the system output directory.
File analysis modules can also use the TskModule::CURRENT_FILE_MACRO macro. This macro expands to the path of the file the module is currently analyzing.
Note that although this macro is not strictly necessary for plug-in modules because they have access to file metadata through the TskFile objects passed to them by the pipeline, executable modules can only obtain the path to the current file using this macro.
@@ -89,4 +89,4 @@ Note that although this macro is not strictly necessary for plug-in modules beca
The tsk_validatepipeline tool, which comes with the framework, can be used to verify that a pipeline configuration file is well-formed and all of the modules specified in the file can be found.
-*/
\ No newline at end of file
+*/
diff --git a/tsk3/auto/db_sqlite.cpp b/tsk3/auto/db_sqlite.cpp
index 49f3886d9..609cc5e79 100644
--- a/tsk3/auto/db_sqlite.cpp
+++ b/tsk3/auto/db_sqlite.cpp
@@ -1500,7 +1500,7 @@ uint8_t TskDbSqlite::getParentImageId (const int64_t objId, int64_t & imageId) {
/**
* Query tsk_objects and tsk_files given file system id and return the root directory object
* @param fsObjId (int) file system id to query root dir object for
-* @param objInfo (out) TSK_DB_OBJECT root dir entry representation to return
+* @param rootDirObjInfo (out) TSK_DB_OBJECT root dir entry representation to return
* @returns TSK_ERR on error (or if not found), TSK_OK on success
*/
uint8_t TskDbSqlite::getFsRootDirObjectInfo(const int64_t fsObjId, TSK_DB_OBJECT & rootDirObjInfo) {
diff --git a/tsk3/docs/footer.html b/tsk3/docs/footer.html
index e0e699dca..7f7ed272c 100644
--- a/tsk3/docs/footer.html
+++ b/tsk3/docs/footer.html
@@ -1,5 +1,5 @@
<hr/>
-<p><i>Copyright © 2007-2011 Brian Carrier. (carrier -at- sleuthkit -dot- org)<br/>
+<p><i>Copyright © 2007-2013 Brian Carrier. (carrier -at- sleuthkit -dot- org)<br/>
This work is licensed under a
<a rel="license" href="http://creativecommons.org/licenses/by-sa/3.0/us/">Creative Commons Attribution-Share Alike 3.0 United States License</a>.
</i></p>
diff --git a/tsk3/fs/fatfs_dent.cpp b/tsk3/fs/fatfs_dent.cpp
index aa0a4e263..5b532de3f 100644
--- a/tsk3/fs/fatfs_dent.cpp
+++ b/tsk3/fs/fatfs_dent.cpp
@@ -19,7 +19,7 @@
*/
/**
-* \file fatfs_dent.c
+* \file fatfs_dent.cpp
* Contains the internal TSK FAT file name processing code.
*/
@@ -99,7 +99,7 @@ static std::map<TSK_INUM_T, TSK_INUM_T> * getParentMap(FATFS_INFO *fatfs) {
* @param fatfs File system
* @param par_inum Parent folder meta data address.
* @param dir_inum Sub-folder meta data address.
-* @param returns 0
+* @returns 0
*/
uint8_t
fatfs_dir_buf_add(FATFS_INFO * fatfs, TSK_INUM_T par_inum,
diff --git a/tsk3/fs/fs_block.c b/tsk3/fs/fs_block.c
index 9d42accd4..476bcc680 100644
--- a/tsk3/fs/fs_block.c
+++ b/tsk3/fs/fs_block.c
@@ -74,6 +74,7 @@ tsk_fs_block_get(TSK_FS_INFO * a_fs, TSK_FS_BLOCK * a_fs_block,
* @param a_fs The file system to read the block from.
* @param a_fs_block The structure to write the block data into or NULL to have one created.
* @param a_addr The file system address to read.
+ * @param a_flags Flag to assign to the returned TSK_FS_BLOCK (use if you already have it as part of a block_walk-type scenario)
* @return The TSK_FS_BLOCK with the data or NULL on error. (If a_fs_block was not NULL, this will
* be the same structure).
*/
diff --git a/tsk3/fs/ntfs_dent.cpp b/tsk3/fs/ntfs_dent.cpp
index b997e9c9c..48b039a2d 100644
--- a/tsk3/fs/ntfs_dent.cpp
+++ b/tsk3/fs/ntfs_dent.cpp
@@ -21,7 +21,7 @@
#include "tsk_ntfs.h"
/**
- * \file ntfs_dent.c
+ * \file ntfs_dent.cpp
* NTFS file name processing internal functions.
*/
--
GitLab