ICODE-ADC/lammps
4
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

add info to docs

Browse Source
This commit is contained in:
Axel Kohlmeyer
2021-04-26 12:15:03 -04:00
parent 2c6fe2d0b5
commit 0eee2d013d
1 changed files with 11 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

11
src/text_file_reader.cpp
View File

@ -54,6 +54,17 @@ TextFileReader::TextFileReader(const std::string &filename, const std::string &f
/** /**
* \overload * \overload
* *
\verbatim embed:rst
This function is useful in combination with :cpp:func:`utils::open_potential`.
.. note::
The FILE pointer is not closed in the destructor, but will be advanced
when reading from it.
\endverbatim
*
* \param fp File descriptor of the already opened file * \param fp File descriptor of the already opened file
* \param filetype Description of file type for error messages */ * \param filetype Description of file type for error messages */