Permalink
Browse files

fix doxygen warnings

  • Loading branch information...
1 parent 543cc20 commit 81e8ca03d77902eaa9ceb140ac05a1f04496aa95 @adam-m adam-m committed Jun 22, 2012
@@ -136,6 +136,7 @@ public String getDisplayName() {
* @param objID the object this artifact is associated with
* @param artifactTypeID the type id of this artifact
* @param artifactTypeName the type name of this artifact
+ * @param displayName the display name of this artifact
*/
protected BlackboardArtifact(SleuthkitCase Case, long artifactID, long objID, int artifactTypeID, String artifactTypeName, String displayName) {
this.Case = Case;
@@ -36,15 +36,16 @@
/**
* Constructor most inputs are from the database
- * @param db java database class
- * @param obj_id
- * @param img_offset
- * @param fs_type
- * @param block_size
- * @param block_count
- * @param root_inum
- * @param first_inum
- * @param last_inum
+ * @param db the case handle
+ * @param obj_id the unique object id
+ * @param name filesystem name
+ * @param img_offset image offset
+ * @param fs_type filesystem type
+ * @param block_size block size in this fs
+ * @param block_count number of blocks in this fs
+ * @param root_inum the root inum
+ * @param first_inum the first inum
+ * @param last_inum the last inum
*/
protected FileSystem(SleuthkitCase db, long obj_id, String name, long img_offset,
long fs_type, long block_size, long block_count, long root_inum,
@@ -67,8 +67,10 @@
/**
* constructor (private) - client uses openCase() and newCase() instead
* @param dbPath path to the database
+ * @param caseHandle handle to the case database API
* @throws SQLException thrown if SQL error occurred
* @throws ClassNotFoundException thrown if database driver could not be loaded
+ * @throws TskCoreException thrown if critical error occurred within TSK case
*/
private SleuthkitCase(String dbPath, SleuthkitJNI.CaseDbHandle caseHandle) throws SQLException, ClassNotFoundException, TskCoreException {
Class.forName("org.sqlite.JDBC");
@@ -577,6 +579,7 @@ public void addBlackboardAttributes(Collection<BlackboardAttribute> attributes)
* add an attribute type with the given name
*
* @param attrTypeString name of the new attribute
+ * @param displayName the (non-unique) display name of the attribute type
* @return the id of the new attribute
* @throws TskCoreException exception thrown if a critical error occurs within tsk core
*/
@@ -592,6 +595,7 @@ public int addAttrType(String attrTypeString, String displayName) throws TskCore
* helper method. add an attribute type with the given name and id
*
* @param attrTypeString type name
+ * @param displayName the (non-unique) display name of the attribute type
* @param typeID type id
* @throws TskCoreException exception thrown if a critical error occurs within tsk core
*/
@@ -831,6 +835,7 @@ public int addArtifactType(String artifactTypeName, String displayName) throws T
* helper method. add an artifact with the given type and id
*
* @param artifactTypeName type name
+ * @param displayName Display (non-unique) name of artifact
* @param typeID type id
* @throws TskCoreException exception thrown if a critical error occurs within tsk core
*/
@@ -929,6 +934,7 @@ private void addArtifactType(String artifactTypeName, String displayName, int ty
* returned blackboard artifact
*
* @param artifactTypeID the type the given artifact should have
+ * @param obj_id the content object id associated with this artifact
* @return a new blackboard artifact
* @throws TskCoreException exception thrown if a critical error occurs within tsk core
*/
@@ -959,6 +965,7 @@ BlackboardArtifact newBlackboardArtifact(int artifactTypeID, long obj_id) throws
* Add a new blackboard artifact with the given type.
*
* @param artifactType the type the given artifact should have
+ * @param obj_id the content object id associated with this artifact
* @return a new blackboard artifact
* @throws TskCoreException exception thrown if a critical error occurs within tsk core
*/
@@ -2082,65 +2089,6 @@ void setMd5Hash(FsContent fsContent, String md5Hash) throws TskCoreException {
SleuthkitCase.dbWriteUnlock();
}
}
-// /**
-// * Update the given hash and known status of the object in the DB denoted by id
-// *
-// * @param id The object's unique ID in the database
-// * @param md5Hash The object's calculated md5 hash
-// * @param fileKnown The object's known status
-// * @throws SQLException
-// */
-// private void updateHashAndKnown(long id, String md5Hash, FileKnown fileKnown) throws SQLException {
-// synchronized (caseLock) {
-// Statement s = con.createStatement();
-// s.executeUpdate("UPDATE tsk_files "
-// + "SET known='" + fileKnown.toLong() + "', md5='" + md5Hash + "' "
-// + "WHERE obj_id=" + id);
-// s.close();
-// }
-// }
-//
-// Useful if we want to queue sql updates for performance reasons
-// /**
-// * Update the given hash and known status of the objects in the DB denoted by id
-// *
-// * @param ids The objects' unique IDs in the database
-// * @param md5Hashes The objects' calculated md5 hashes
-// * @param knowns The objects' known statuses
-// * @throws SQLException
-// */
-// private void updateHashesAndKnowns(List<Long> ids, List<String> md5Hashes, List<Long> knowns) throws SQLException{
-// int idsSize = ids.size();
-// int md5sSize = md5Hashes.size();
-// int knownsSize = knowns.size();
-// if(idsSize == md5sSize && md5sSize == knownsSize && knownsSize == idsSize){
-// StringBuilder query = new StringBuilder("UPDATE tsk_files SET known = CASE obj_id");
-// for(int i = 0; i<idsSize; i++){
-// // " WHEN id THEN known"
-// query.append(" WHEN ").append(ids.get(i))
-// .append(" THEN ").append(knowns.get(i));
-// }
-// query.append(" END, md5 = CASE obj_id");
-// for(int i = 0; i<idsSize; i++){
-// // " WHEN id THEN hash"
-// query.append(" WHEN ").append(ids.get(i))
-// .append(" THEN '").append(md5Hashes.get(i)).append("'");
-// }
-// query.append(" END WHERE id in (");
-// for(int i = 0; i<idsSize; i++){
-// // "1,2,3,4,"
-// query.append(ids.get(i)).append(",");
-// }
-// // remove the last unnecessary comma
-// query.deleteCharAt(query.length()-1);
-// query.append(")");
-// Statement s = con.createStatement();
-// s.executeUpdate(query.toString());
-// s.close();
-// }else{
-// throw new IllegalArgumentException("Lists must be of equal length!");
-// }
-// }
/**
* Look up the given hash in the NSRL database
@@ -2163,39 +2111,7 @@ void setMd5Hash(FsContent fsContent, String md5Hash) throws TskCoreException {
return SleuthkitJNI.knownBadHashLookup(md5Hash, dbHandle);
}
-// Useful if we want to queue sql updates for performance reasons
-// /**
-// * Calculate the given Content objects' md5 hashes, look them up in the
-// * known databases, and then update the case database with both hash and
-// * known status
-// *
-// * @param cont The list of contents whose md5s you want to look up
-// * @return The contents' known statuses from the databases
-// * @throws TskException
-// */
-// public List<Long> lookupFilesMd5(List<? extends Content> cont) throws TskException{
-// List<Long> ids = new ArrayList<Long>();
-// List<String> md5Hashes = new ArrayList<String>();
-// List<Long> knowns = new ArrayList<Long>();
-//
-// try{
-// for(Content c : cont){
-// ids.add(c.getId());
-// String md5Hash = Hash.calculateMd5(c);
-// md5Hashes.add(md5Hash);
-// knowns.add(SleuthkitJNI.lookupHash(md5Hash).toLong());
-// }
-// updateHashesAndKnowns(ids, md5Hashes, knowns);
-// return knowns;
-// } catch (TskException ex) {
-// Logger.getLogger(SleuthkitCase.class.getName()).log(Level.SEVERE,
-// "Error looking up known status", ex);
-// } catch(SQLException ex) {
-// Logger.getLogger(SleuthkitCase.class.getName()).log(Level.SEVERE,
-// "Error updating SQL database", ex);
-// }
-// throw new TskException("Error analyzing files");
-// }
+
/**
* Return the number of objects in the database of a given file type.
*
@@ -161,15 +161,16 @@ int addKnownBadDatabase(String path) throws TskCoreException {
/**
- * Start the process of adding a disk image to the case.
+ * Start the process of adding a disk image to the case
+ *
* @param timezone Timezone that image was from
* @param processUnallocSpace true if to process unallocated space in the image
* @param noFatFsOrphans true if to skip processing of orphans on FAT filesystems
*
* @return Object that can be used to manage the process.
*/
- AddImageProcess initAddImageProcess(String timezone, boolean processUnallocSpace, boolean noFatFsOrhpans) {
- return new AddImageProcess(timezone, processUnallocSpace, noFatFsOrhpans);
+ AddImageProcess initAddImageProcess(String timezone, boolean processUnallocSpace, boolean noFatFsOrphans) {
+ return new AddImageProcess(timezone, processUnallocSpace, noFatFsOrphans);
}
/**
@@ -330,6 +331,7 @@ public synchronized static long openImage(String[] imageFiles) throws TskCoreExc
/**
* Get volume system Handle
+ * @param imgHandle a handle to previously opened image
* @param vsOffset byte offset in the image to the volume system (usually 0)
* @return pointer to a vsHandle structure in the sleuthkit
* @throws TskCoreException exception thrown if critical error occurs within TSK
@@ -556,6 +558,7 @@ public static String getDatabaseName(String path) throws TskCoreException {
/**
* Look up the given hash in the known bad database
* @param hash
+ * @param dbHandle previously opened hash db handle
* @return the status of the hash in the known bad database
* @throws TskCoreException if a critical error occurs within TSK core
*/
@@ -47,7 +47,7 @@ public TskCoreException(String msg){
/**
* Create exception containing the error message and cause exception
* @param msg the message
- * @param wrapped cause exception
+ * @param ex cause exception
*/
public TskCoreException(String msg, Exception ex){
super(msg, ex);
@@ -43,7 +43,7 @@ public TskDataException(String msg) {
/**
* Create exception containing the error message and cause exception
* @param msg the message
- * @param wrapped cause exception
+ * @param ex cause exception
*/
public TskDataException(String msg, Exception ex) {
super(msg, ex);
@@ -36,7 +36,7 @@ public TskException(String msg) {
/**
* Create exception containing the error message and cause exception
* @param msg the message
- * @param wrapped cause exception
+ * @param ex cause exception
*/
public TskException(String msg, Exception ex) {
super(msg, ex);
@@ -32,11 +32,12 @@
/**
* Constructor most inputs are from the database
- * @param db database object
- * @param obj_id
- * @param type
- * @param imgOffset
- * @param blockSize
+ * @param db case database handle
+ * @param obj_id the unique content object id for the volume system
+ * @param name name of the volume system
+ * @param type type of the volume system
+ * @param imgOffset offset of the volume system with respect to image
+ * @param blockSize block size of this volume system
*/
protected VolumeSystem(SleuthkitCase db, long obj_id, String name, long type, long imgOffset, long blockSize) {
super(db, obj_id, name);

0 comments on commit 81e8ca0

Please sign in to comment.