Skip to content

Commit 7900c13

Browse files
committed
Implement missing documentaiton for public symbols
Deny missing docs on public symbols.
1 parent 82bf7a7 commit 7900c13

File tree

2 files changed

+234
-0
lines changed

2 files changed

+234
-0
lines changed

src/lib.rs

+14
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,7 @@
55
// copied, modified, or distributed except according to those terms.
66

77
#![deny(missing_debug_implementations)]
8+
#![deny(missing_docs)]
89

910
//! # cea608-types
1011
//!
@@ -62,10 +63,19 @@ impl From<tables::CodeError> for ParserError {
6263
/// A CEA-08 presentation mode
6364
#[derive(Debug, Copy, Clone, PartialEq, Eq)]
6465
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.
6568
PopOn,
69+
/// The Paint-On CEA-608 mode. Text is written directly to the display as it arrives.
6670
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.
6773
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.
6876
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.
6979
RollUp4,
7080
}
7181

@@ -324,9 +334,13 @@ impl Cea608Writer {
324334
/// A CEA-608 caption identifier unique within a CEA-608 stream
325335
#[derive(Debug, Copy, Clone, PartialEq, Eq)]
326336
pub enum Id {
337+
/// The CC1 caption stream placed in field 1 with caption channel 1.
327338
CC1,
339+
/// The CC2 caption stream placed in field 1 with caption channel 2.
328340
CC2,
341+
/// The CC1 caption stream placed in field 2 with caption channel 1.
329342
CC3,
343+
/// The CC4 caption stream placed in field 2 with caption channel 2.
330344
CC4,
331345
// TODO: add Text1/2
332346
}

0 commit comments

Comments
 (0)