From 0626141f7f4cbd0556cda6140ce01c5e4ee9151e Mon Sep 17 00:00:00 2001
From: Anna Schumaker <Anna@OcarinaProject.net>
Date: Tue, 16 Sep 2014 08:09:27 -0400
Subject: [PATCH] filter:  Add doxygen comments

Signed-off-by: Anna Schumaker <Anna@OcarinaProject.net>
---
 core/filter.cpp       |  3 ++-
 include/core/filter.h | 26 +++++++++++++++++++++++++-
 2 files changed, 27 insertions(+), 2 deletions(-)

diff --git a/core/filter.cpp b/core/filter.cpp
index 71a82ccb..8efeccf1 100644
--- a/core/filter.cpp
+++ b/core/filter.cpp
@@ -1,4 +1,5 @@
-/*
+/**
+ * @file
  * Copyright 2013 (c) Anna Schumaker.
  */
 
diff --git a/include/core/filter.h b/include/core/filter.h
index 4c3aaaee..8fdc0b47 100644
--- a/include/core/filter.h
+++ b/include/core/filter.h
@@ -1,4 +1,5 @@
-/*
+/**
+ * @file
  * Copyright 2013 (c) Anna Schumaker.
  */
 #ifndef OCARINA_CORE_FILTER_H
@@ -7,10 +8,33 @@
 #include <set>
 #include <string>
 
+/**
+ * Namespace for searching the tag database.
+ */
 namespace filter {
 
+	/**
+	 * Break a string into words and add each word to an index.
+	 *
+	 * @param  text  The text to parse.
+	 * @param  id    An identifier paired with the text.
+	 * @return The lowercase form of the input text.
+	 */
 	std::string add(const std::string &, unsigned int);
+
+	/**
+	 * Search the entire index for identifiers paired with the input text.
+	 *
+	 * @param  text  The text to search for.
+	 * @param  res   The results set will be filled in with the ids found.
+	 */
 	void search(const std::string &, std::set<unsigned int> &);
+
+	/**
+	 * Returns the lowercase version of the input text.
+	 *
+	 * @param  text  The text to be converted into lowercase.
+	 */
 	std::string lowercase(const std::string &);
 
 };