diff options
| author | Carl Hetherington <cth@carlh.net> | 2014-12-01 09:56:13 +0000 |
|---|---|---|
| committer | Carl Hetherington <cth@carlh.net> | 2014-12-01 09:56:13 +0000 |
| commit | f2ebc98bfa8e780935d76108b897015128c6271e (patch) | |
| tree | 58516f7138d560e330e23b93d92beb5ba7b3659f /src | |
| parent | 8cfc86dbfd2bffe3cf053c10b74cee12401437f4 (diff) | |
Some doc improvements.
Diffstat (limited to 'src')
| -rw-r--r-- | src/collect.h | 5 | ||||
| -rw-r--r-- | src/stl_binary_writer.cc | 4 | ||||
| -rw-r--r-- | src/stl_binary_writer.h | 4 | ||||
| -rw-r--r-- | src/time_pair.cc | 4 | ||||
| -rw-r--r-- | src/time_pair.h | 4 | ||||
| -rw-r--r-- | src/xml.h | 4 |
6 files changed, 24 insertions, 1 deletions
diff --git a/src/collect.h b/src/collect.h index 9f3db63..34f81aa 100644 --- a/src/collect.h +++ b/src/collect.h @@ -24,7 +24,10 @@ #include "raw_subtitle.h" namespace sub { - + +/** Collect sub::RawSubtitle objects into sub::Subtitles. + * This method is templated so that any container type can be used for the result. + */ template <class T> T collect (std::list<RawSubtitle> raw) diff --git a/src/stl_binary_writer.cc b/src/stl_binary_writer.cc index 6e8f598..aa9a032 100644 --- a/src/stl_binary_writer.cc +++ b/src/stl_binary_writer.cc @@ -17,6 +17,10 @@ */ +/** @file src/stl_binary_writer.cc + * @brief Writer for STL binary files. + */ + #include "stl_binary_writer.h" #include "subtitle.h" #include "iso6937.h" diff --git a/src/stl_binary_writer.h b/src/stl_binary_writer.h index b4ab960..4986afb 100644 --- a/src/stl_binary_writer.h +++ b/src/stl_binary_writer.h @@ -17,6 +17,10 @@ */ +/** @file src/stl_binary_writer.h + * @brief Writer for STL binary files. + */ + #ifndef LIBSUB_STL_BINARY_WRITER_H #define LIBSUB_STL_BINARY_WRITER_H diff --git a/src/time_pair.cc b/src/time_pair.cc index 9fc7974..35ba3d0 100644 --- a/src/time_pair.cc +++ b/src/time_pair.cc @@ -17,6 +17,10 @@ */ +/** @file src/time_pair.cc + * @brief TimePair class. + */ + #include "time_pair.h" using std::ostream; diff --git a/src/time_pair.h b/src/time_pair.h index d4b2c09..6265480 100644 --- a/src/time_pair.h +++ b/src/time_pair.h @@ -17,6 +17,10 @@ */ +/** @file src/time_pair.h + * @brief TimePair class. + */ + #ifndef LIBSUB_TIME_PAIR_H #define LIBSUB_TIME_PAIR_H @@ -17,6 +17,10 @@ */ +/** @file src/xml.h + * @brief Some useful XML helper functions. + */ + #ifndef LIBSUB_XML_H #define LIBSUB_XML_H |