anna
/
ocarina
1
0
Fork 0
Code Issues 7 Pull Requests Releases Wiki Activity

filter: Add doxygen comments 

Signed-off-by: Anna Schumaker <Anna@OcarinaProject.net>
This commit is contained in:
Anna Schumaker 2014-09-16 08:09:27 -04:00
parent 73264e04ce
commit 0626141f7f
2 changed files with 27 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
core/filter.cpp
View File

@ -1,4 +1,5 @@
/*
/**
* @file
* Copyright 2013 (c) Anna Schumaker.
*/

26
include/core/filter.h
View File

@ -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 &);
};