documented (nearly) ever class

2019-07-06 23:32:01 -05:00
parent a9ff2389e6
commit 5e3c2fb7e4
43 changed files with 284 additions and 62 deletions
@@ -29,9 +29,9 @@
 #include "decoder/frame.h"

 /**
- * @brief The Decoder class
+ * @brief A decoder's is the main class for bringing external media into Olive
 *
- * A decoder's is the main class for bringing external media into Olive. Its responsibilities are to serve as
+ * Its responsibilities are to serve as
 * abstraction from codecs/decoders and provide complete frames. These frames can be video or audio data and are
 * provided as Frame objects in shared pointers to alleviate the responsibility of memory handling.
 *
@@ -30,9 +30,7 @@ extern "C" {
 #include "rational.h"

 /**
- * @brief The Frame class
- *
- * Abstraction from AVFrame. Currently a simple AVFrame wrapper.
+ * @brief Abstraction from AVFrame. Currently a simple AVFrame wrapper.
 *
 * This class does not support copying at this time.
 */