add some cross referencing

This commit is contained in:
Axel Kohlmeyer
2020-09-18 13:45:33 -04:00
parent edbfdde372
commit 9a6dfbc0ee
6 changed files with 72 additions and 15 deletions

View File

@ -30,11 +30,15 @@ using namespace LAMMPS_NS;
* The value of the class member variable *ignore_comments* controls
* whether any text following the pound sign (#) should be ignored (true)
* or not (false). Default: true, i.e. ignore.
\verbatim embed:rst
*See also*
:cpp:class:`TextFileReader`
\endverbatim
*
* \param filename Name of file to be read
* \param filetype Description of file type for error messages
*
* \sa PotentialFileReader */
* \param filetype Description of file type for error messages */
TextFileReader::TextFileReader(const std::string &filename, const std::string &filetype)
: filename(filename), filetype(filetype), ignore_comments(true)