|
5 | 5 | // copied, modified, or distributed except according to those terms.
|
6 | 6 |
|
7 | 7 | #![deny(missing_debug_implementations)]
|
| 8 | +#![deny(missing_docs)] |
8 | 9 |
|
9 | 10 | //! # cea608-types
|
10 | 11 | //!
|
@@ -62,10 +63,19 @@ impl From<tables::CodeError> for ParserError {
|
62 | 63 | /// A CEA-08 presentation mode
|
63 | 64 | #[derive(Debug, Copy, Clone, PartialEq, Eq)]
|
64 | 65 | pub enum Mode {
|
| 66 | + /// The Pop-On CEA-608 mode. Text is stored in a hidden buffer that is swapped with the |
| 67 | + /// displayed text. |
65 | 68 | PopOn,
|
| 69 | + /// The Paint-On CEA-608 mode. Text is written directly to the display as it arrives. |
66 | 70 | PaintOn,
|
| 71 | + /// The Roll-Up 2 CEA-608 mode. Text is appended to rows and on a CR command, all of the rows |
| 72 | + /// move up one row. This variant contains 2 rows of display. |
67 | 73 | RollUp2,
|
| 74 | + /// The Roll-Up 2 CEA-608 mode. Text is appended to rows and on a CR command, all of the rows |
| 75 | + /// move up one row. This variant contains 3 rows of display. |
68 | 76 | RollUp3,
|
| 77 | + /// The Roll-Up 2 CEA-608 mode. Text is appended to rows and on a CR command, all of the rows |
| 78 | + /// move up one row. This variant contains 4 rows of display. |
69 | 79 | RollUp4,
|
70 | 80 | }
|
71 | 81 |
|
@@ -324,9 +334,13 @@ impl Cea608Writer {
|
324 | 334 | /// A CEA-608 caption identifier unique within a CEA-608 stream
|
325 | 335 | #[derive(Debug, Copy, Clone, PartialEq, Eq)]
|
326 | 336 | pub enum Id {
|
| 337 | + /// The CC1 caption stream placed in field 1 with caption channel 1. |
327 | 338 | CC1,
|
| 339 | + /// The CC2 caption stream placed in field 1 with caption channel 2. |
328 | 340 | CC2,
|
| 341 | + /// The CC1 caption stream placed in field 2 with caption channel 1. |
329 | 342 | CC3,
|
| 343 | + /// The CC4 caption stream placed in field 2 with caption channel 2. |
330 | 344 | CC4,
|
331 | 345 | // TODO: add Text1/2
|
332 | 346 | }
|
|
0 commit comments