Skip to content

Commit f42a3ae

Browse files
committed
Add cargo doc to CI
This was present in the travis configuration that was removed in f3c5f88. It remains useful since it can catch errors in the rustdoc such as in https://travis-ci.org/github/mozilla/mp4parse-rust/jobs/774702058
1 parent f3c5f88 commit f42a3ae

File tree

2 files changed

+10
-4
lines changed

2 files changed

+10
-4
lines changed

.github/workflows/build.yml

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -62,6 +62,13 @@ jobs:
6262
run: rustup run ${{ matrix.rust }} cargo test --all --verbose
6363
if: ${{ !matrix.release }}
6464

65+
- name: Doc (release)
66+
shell: bash
67+
run: rustup run ${{ matrix.rust }} cargo doc --document-private-items
68+
env:
69+
RUSTDOCFLAGS: "-Dwarnings"
70+
if: matrix.release
71+
6572
# cargo-fuzz supports x86-64 Linux and x86-64 macOS, but macOS currently fails, see:
6673
# https://github.com/mozilla/mp4parse-rust/pull/210#issuecomment-597420191
6774
- name: Install cargo-fuzz

mp4parse/src/lib.rs

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -483,7 +483,7 @@ pub struct VPxConfigBox {
483483
pub codec_init: TryVec<u8>,
484484
}
485485

486-
/// See AV1-ISOBMFF § 2.3.3 https://aomediacodec.github.io/av1-isobmff/#av1codecconfigurationbox-syntax
486+
/// See [AV1-ISOBMFF § 2.3.3](https://aomediacodec.github.io/av1-isobmff/#av1codecconfigurationbox-syntax)
487487
#[derive(Debug)]
488488
pub struct AV1ConfigBox {
489489
pub profile: u8,
@@ -502,7 +502,6 @@ pub struct AV1ConfigBox {
502502
}
503503

504504
impl AV1ConfigBox {
505-
/// See https://aomediacodec.github.io/av1-isobmff/#av1codecconfigurationbox-syntax
506505
const CONFIG_OBUS_OFFSET: usize = 4;
507506

508507
pub fn config_obus(&self) -> &[u8] {
@@ -3733,7 +3732,7 @@ fn read_vpcc<T: Read>(src: &mut BMFFBox<T>) -> Result<VPxConfigBox> {
37333732
})
37343733
}
37353734

3736-
/// See AV1-ISOBMFF § 2.3.3 https://aomediacodec.github.io/av1-isobmff/#av1codecconfigurationbox-syntax
3735+
/// See [AV1-ISOBMFF § 2.3.3](https://aomediacodec.github.io/av1-isobmff/#av1codecconfigurationbox-syntax)
37373736
fn read_av1c<T: Read>(src: &mut BMFFBox<T>) -> Result<AV1ConfigBox> {
37383737
// We want to store the raw config as well as a structured (parsed) config, so create a copy of
37393738
// the raw config so we have it later, and then parse the structured data from that.
@@ -4124,7 +4123,7 @@ fn read_esds<T: Read>(src: &mut BMFFBox<T>) -> Result<ES_Descriptor> {
41244123
}
41254124

41264125
/// Parse `FLACSpecificBox`.
4127-
/// See https://github.com/xiph/flac/blob/master/doc/isoflac.txt § 3.3.2
4126+
/// See [Encapsulation of FLAC in ISO Base Media File Format](https://github.com/xiph/flac/blob/master/doc/isoflac.txt) § 3.3.2
41284127
fn read_dfla<T: Read>(src: &mut BMFFBox<T>) -> Result<FLACSpecificBox> {
41294128
let (version, flags) = read_fullbox_extra(src)?;
41304129
if version != 0 {

0 commit comments

Comments
 (0)