Some Doxygen comments.
[libsub.git] / src / stl_text_reader.h
1 /*
2     Copyright (C) 2014 Carl Hetherington <cth@carlh.net>
3
4     This program is free software; you can redistribute it and/or modify
5     it under the terms of the GNU General Public License as published by
6     the Free Software Foundation; either version 2 of the License, or
7     (at your option) any later version.
8
9     This program is distributed in the hope that it will be useful,
10     but WITHOUT ANY WARRANTY; without even the implied warranty of
11     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12     GNU General Public License for more details.
13
14     You should have received a copy of the GNU General Public License
15     along with this program; if not, write to the Free Software
16     Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
17
18 */
19
20 #include "reader.h"
21 #include <boost/optional.hpp>
22
23 namespace sub {
24
25 /** @class STLTextReader
26  *  @brief A class to read textual STL files
27  */
28 class STLTextReader : public Reader
29 {
30 public:
31         STLTextReader (std::istream &);
32
33 private:
34         void set (std::string name, std::string value);
35         void maybe_push ();
36         boost::optional<FrameTime> time (std::string t) const;
37
38         RawSubtitle _subtitle;
39 };
40
41 }