Added some documentation

git-svn-id: file:///srv/svn/repos/haiku/trunk/current@648 a95241bf-73f2-0310-859d-f6bbb57e9c96

src/kits/storage/sniffer/Pattern.cpp

@@ -36,8 +36,6 @@ Pattern::GetErr() const {
 		return NULL;
 	else
 		return new(nothrow) Err(*fErrorMessage);
-//	return fErrorMessage ? NULL : new Err(*fErrorMessage);
-//	return new Err("HEY, FIX THIS CRAP!", -1);
 }
 
 status_t
@@ -66,6 +64,10 @@ Pattern::SetTo(const char *string, const char *mask) {
 	}
 }
 
+/*! \brief Looks for a pattern match in the given data stream, starting from
+	each offset withing the given range. Returns true is a match is found,
+	false if not.
+*/
 bool
 Pattern::Sniff(Range range, BPositionIO *data) const {
 	// If our range contains negative values relative to the end of

src/kits/storage/sniffer/PatternList.cpp

@@ -37,6 +37,9 @@ PatternList::GetErr() const {
 	return fRange.GetErr();
 }
 
+/*! \brief Sniffs the given data stream, searching for a match with
+	any of the list's patterns.
+*/
 bool
 PatternList::Sniff(BPositionIO *data) const {
 	if (InitCheck() != B_OK)

src/kits/storage/sniffer/RPattern.cpp

@@ -51,6 +51,7 @@ RPattern::~RPattern() {
 	delete fPattern;
 }
 
+//! Sniffs the given data stream over the object's range for the object's pattern
 bool
 RPattern::Sniff(BPositionIO *data) const {
 	if (!data || InitCheck() != B_OK)

src/kits/storage/sniffer/RPatternList.cpp

@@ -36,6 +36,10 @@ RPatternList::GetErr() const {
 	return NULL;
 }
 
+/*! Sniffs the given data stream, searching for a match
+	with any of the list's patterns. Each pattern is searched
+	over its own specified range.
+*/
 bool
 RPatternList::Sniff(BPositionIO *data) const {
 	if (InitCheck() != B_OK)