Skip to content
Snippets Groups Projects
Commit b62aa81e authored by Timo Koch's avatar Timo Koch
Browse files

[io][container][doc] Improve Container doc

parent f7393919
No related branches found
No related tags found
1 merge request!1967Feature/data input
......@@ -60,7 +60,8 @@ void writeContainerToFile(const Container& v,
/*!
* \brief Read an input stream into a container
* \param stream A standard input stream
* \tparam Container The container type, requires begin(), end(), push_back() method
* \tparam Container The container type requires begin(), end(), push_back() functions
* and Container::value_type requires operator>>.
*/
template<typename Container>
Container readStreamToContainer(std::istream& stream)
......@@ -74,7 +75,8 @@ Container readStreamToContainer(std::istream& stream)
/*!
* \brief Read a simple text file into a container
* \param filename The filename to write to
* \tparam Container The container type, requires begin(), end(), push_back() method
* \tparam Container The container type requires begin(), end(), push_back() functions
* and Container::value_type requires operator>>.
*
* usage: auto v = readFileToContainer<std::vector<double>>("myvector.txt");
*/
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment