add docs for TextFileReader class to developer guide

This commit is contained in:
Axel Kohlmeyer
2020-08-31 06:57:16 -04:00
parent 39a9974f3d
commit 33f2cbc713
5 changed files with 76 additions and 3 deletions

View File

@ -35,7 +35,8 @@ TokenizerException::TokenizerException(const std::string & msg, const std::strin
* This tokenizer will break down a string into sub-strings (i.e words)
* separated by the given separator characters.
*
* \exception TokenizerException
* \param str string to be processed
* \param separators string with separator characters (default: " \t\r\n\f")
*
* \sa ValueTokenizer TokenizerException */
@ -148,6 +149,9 @@ std::vector<std::string> Tokenizer::as_vector() {
}
/*! Class for reading text with numbers
*
* \param str string to be processed
* \param separators string with separator characters (default: " \t\r\n\f")
*
* \sa Tokenizer InvalidIntegerException InvalidFloatException */