Fix links and add cargo doc to CI

versatica · Dec 18, 2023 · ba6a302 · ba6a302
1 parent 49c8f24
commit ba6a302
Show file tree

Hide file tree

Showing 4 changed files with 11 additions and 5 deletions.
diff --git a/.github/workflows/mediasoup-rust.yaml b/.github/workflows/mediasoup-rust.yaml
@@ -46,3 +46,10 @@ jobs:
 
       - name: cargo test
         run: cargo test --verbose
+
+      - name: cargo doc
+        run: cargo doc --locked --all --no-deps --lib
+        env:
+          DOCS_RS: '1'
+          RUSTDOCFLAGS: '-D rustdoc::broken-intra-doc-links -D rustdoc::private_intra_doc_links'
+
diff --git a/Cargo.lock b/Cargo.lock
diff --git a/rust/src/data_structures.rs b/rust/src/data_structures.rs
@@ -45,7 +45,7 @@ impl AppData {
     }
 }
 
-/// Listening protocol, IP and port for [`WebRtcServer`] to listen on.
+/// Listening protocol, IP and port for [`WebRtcServer`](crate::webrtc_server::WebRtcServer) to listen on.
 ///
 /// # Notes on usage
 /// If you use "0.0.0.0" or "::" as ip value, then you need to also provide `announced_ip`.

diff --git a/rust/src/router/data_consumer.rs b/rust/src/router/data_consumer.rs
@@ -903,7 +903,7 @@ impl DataConsumer {
     }
 
     /// Callback is called when the associated data producer is resumed.
-    pub fn on_producer_resume<F: Fn() + Send + Sync + 'static>(&self, callback: F) -> HandlerId {
+    pub fn on_data_producer_resume<F: Fn() + Send + Sync + 'static>(&self, callback: F) -> HandlerId {
         self.inner()
             .handlers
             .data_producer_resume